opendaylight/restconf/sal-rest-connector/src/main/java/org/opendaylight/netconf/sal/restconf/impl/RestconfImpl.java

   1 /**
   2  * Copyright (c) 2014, 2015 Brocade Communication Systems, Inc., Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.netconf.sal.restconf.impl;
  10
  11 import com.google.common.base.CharMatcher;
  12 import com.google.common.base.Optional;
  13 import com.google.common.base.Preconditions;
  14 import com.google.common.base.Predicate;
  15 import com.google.common.base.Predicates;
  16 import com.google.common.base.Splitter;
  17 import com.google.common.base.Strings;
  18 import com.google.common.base.Throwables;
  19 import com.google.common.collect.Iterables;
  20 import com.google.common.collect.Lists;
  21 import com.google.common.collect.Maps;
  22 import com.google.common.collect.Sets;
  23 import com.google.common.util.concurrent.CheckedFuture;
  24 import com.google.common.util.concurrent.Futures;
  25 import java.math.BigInteger;
  26 import java.net.URI;
  27 import java.net.URISyntaxException;
  28 import java.text.ParseException;
  29 import java.text.SimpleDateFormat;
  30 import java.util.ArrayList;
  31 import java.util.Collections;
  32 import java.util.Date;
  33 import java.util.HashMap;
  34 import java.util.List;
  35 import java.util.Map;
  36 import java.util.Set;
  37 import java.util.concurrent.CancellationException;
  38 import java.util.concurrent.ExecutionException;
  39 import javax.ws.rs.core.Response;
  40 import javax.ws.rs.core.Response.ResponseBuilder;
  41 import javax.ws.rs.core.Response.Status;
  42 import javax.ws.rs.core.UriBuilder;
  43 import javax.ws.rs.core.UriInfo;
  44 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
  45 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  46 import org.opendaylight.controller.md.sal.common.api.data.OptimisticLockFailedException;
  47 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  48 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
  49 import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
  50 import org.opendaylight.controller.md.sal.dom.api.DOMRpcImplementationNotAvailableException;
  51 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
  52 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  53 import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult;
  54 import org.opendaylight.netconf.md.sal.rest.common.RestconfValidationUtils;
  55 import org.opendaylight.netconf.sal.rest.api.Draft02;
  56 import org.opendaylight.netconf.sal.rest.api.RestconfService;
  57 import org.opendaylight.netconf.sal.restconf.impl.RestconfError.ErrorTag;
  58 import org.opendaylight.netconf.sal.restconf.impl.RestconfError.ErrorType;
  59 import org.opendaylight.netconf.sal.streams.listeners.ListenerAdapter;
  60 import org.opendaylight.netconf.sal.streams.listeners.Notificator;
  61 import org.opendaylight.netconf.sal.streams.websockets.WebSocketServer;
  62 import org.opendaylight.yangtools.yang.common.QName;
  63 import org.opendaylight.yangtools.yang.common.QNameModule;
  64 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  65 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  66 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  67 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  68 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
  69 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  70 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  71 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  72 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  73 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  74 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  75 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  76 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModifiedNodeDoesNotExistException;
  77 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  78 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  79 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  80 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
  81 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
  82 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  83 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  84 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  85 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  86 import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
  87 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  88 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  89 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  90 import org.opendaylight.yangtools.yang.model.api.Module;
  91 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  92 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  93 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  94 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  95 import org.opendaylight.yangtools.yang.model.util.EmptyType;
  96 import org.opendaylight.yangtools.yang.parser.builder.api.GroupingBuilder;
  97 import org.opendaylight.yangtools.yang.parser.builder.impl.ContainerSchemaNodeBuilder;
  98 import org.opendaylight.yangtools.yang.parser.builder.impl.LeafSchemaNodeBuilder;
  99 import org.opendaylight.yangtools.yang.parser.builder.impl.ModuleBuilder;
 100 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.EffectiveSchemaContext;
 101 import org.slf4j.Logger;
 102 import org.slf4j.LoggerFactory;
 103
 104 public class RestconfImpl implements RestconfService {
 105
 106     private static final RestconfImpl INSTANCE = new RestconfImpl();
 107
 108     private static final int NOTIFICATION_PORT = 8181;
 109
 110     private static final int CHAR_NOT_FOUND = -1;
 111
 112     private static final SimpleDateFormat REVISION_FORMAT = new SimpleDateFormat("yyyy-MM-dd");
 113
 114     private static final String SAL_REMOTE_NAMESPACE = "urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote";
 115
 116     private static final String SAL_REMOTE_RPC_SUBSRCIBE = "create-data-change-event-subscription";
 117
 118     private BrokerFacade broker;
 119
 120     private ControllerContext controllerContext;
 121
 122     private static final Logger LOG = LoggerFactory.getLogger(RestconfImpl.class);
 123
 124     private static final DataChangeScope DEFAULT_SCOPE = DataChangeScope.BASE;
 125
 126     private static final LogicalDatastoreType DEFAULT_DATASTORE = LogicalDatastoreType.CONFIGURATION;
 127
 128     private static final URI NAMESPACE_EVENT_SUBSCRIPTION_AUGMENT = URI.create("urn:sal:restconf:event:subscription");
 129
 130     private static final String DATASTORE_PARAM_NAME = "datastore";
 131
 132     private static final String SCOPE_PARAM_NAME = "scope";
 133
 134     private static final String NETCONF_BASE = "urn:ietf:params:xml:ns:netconf:base:1.0";
 135
 136     private static final String NETCONF_BASE_PAYLOAD_NAME = "data";
 137
 138     private static final QName NETCONF_BASE_QNAME;
 139
 140     private static final QNameModule SAL_REMOTE_AUGMENT;
 141
 142     private static final YangInstanceIdentifier.AugmentationIdentifier SAL_REMOTE_AUG_IDENTIFIER;
 143
 144     static {
 145         try {
 146             final Date eventSubscriptionAugRevision = new SimpleDateFormat("yyyy-MM-dd").parse("2014-07-08");
 147             NETCONF_BASE_QNAME = QName.create(QNameModule.create(new URI(NETCONF_BASE), null), NETCONF_BASE_PAYLOAD_NAME );
 148             SAL_REMOTE_AUGMENT = QNameModule.create(NAMESPACE_EVENT_SUBSCRIPTION_AUGMENT,
 149                     eventSubscriptionAugRevision);
 150             SAL_REMOTE_AUG_IDENTIFIER = new YangInstanceIdentifier.AugmentationIdentifier(Sets.newHashSet(QName.create(SAL_REMOTE_AUGMENT, "scope"),
 151                     QName.create(SAL_REMOTE_AUGMENT, "datastore")));
 152         } catch (final ParseException e) {
 153             final String errMsg = "It wasn't possible to convert revision date of sal-remote-augment to date";
 154             LOG.debug(errMsg);
 155             throw new RestconfDocumentedException(errMsg, ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED);
 156         } catch (final URISyntaxException e) {
 157             final String errMsg = "It wasn't possible to create instance of URI class with "+NETCONF_BASE+" URI";
 158             throw new RestconfDocumentedException(errMsg, ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED);
 159         }
 160     }
 161
 162     public void setBroker(final BrokerFacade broker) {
 163         this.broker = broker;
 164     }
 165
 166     public void setControllerContext(final ControllerContext controllerContext) {
 167         this.controllerContext = controllerContext;
 168     }
 169
 170     private RestconfImpl() {
 171     }
 172
 173     public static RestconfImpl getInstance() {
 174         return INSTANCE;
 175     }
 176
 177     @Override
 178     public NormalizedNodeContext getModules(final UriInfo uriInfo) {
 179         final Set<Module> allModules = controllerContext.getAllModules();
 180         final MapNode allModuleMap = makeModuleMapNode(allModules);
 181
 182         final SchemaContext schemaContext = controllerContext.getGlobalSchema();
 183
 184         final Module restconfModule = getRestconfModule();
 185         final DataSchemaNode modulesSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(
 186                 restconfModule, Draft02.RestConfModule.MODULES_CONTAINER_SCHEMA_NODE);
 187         Preconditions.checkState(modulesSchemaNode instanceof ContainerSchemaNode);
 188
 189         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> moduleContainerBuilder =
 190                 Builders.containerBuilder((ContainerSchemaNode) modulesSchemaNode);
 191         moduleContainerBuilder.withChild(allModuleMap);
 192
 193         return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, modulesSchemaNode,
 194                 null, schemaContext), moduleContainerBuilder.build(),
 195                 QueryParametersParser.parseWriterParameters(uriInfo));
 196     }
 197
 198     /**
 199      * Valid only for mount point
 200      */
 201     @Override
 202     public NormalizedNodeContext getModules(final String identifier, final UriInfo uriInfo) {
 203         Preconditions.checkNotNull(identifier);
 204         if ( ! identifier.contains(ControllerContext.MOUNT)) {
 205             final String errMsg = "URI has bad format. If modules behind mount point should be showed,"
 206                     + " URI has to end with " + ControllerContext.MOUNT;
 207             LOG.debug(errMsg + " for " + identifier);
 208             throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 209         }
 210
 211         final InstanceIdentifierContext<?> mountPointIdentifier = controllerContext.toMountPointIdentifier(identifier);
 212         final DOMMountPoint mountPoint = mountPointIdentifier.getMountPoint();
 213         final Set<Module> modules = controllerContext.getAllModules(mountPoint);
 214         final MapNode mountPointModulesMap = makeModuleMapNode(modules);
 215
 216         final Module restconfModule = getRestconfModule();
 217         final DataSchemaNode modulesSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(
 218                 restconfModule, Draft02.RestConfModule.MODULES_CONTAINER_SCHEMA_NODE);
 219         Preconditions.checkState(modulesSchemaNode instanceof ContainerSchemaNode);
 220
 221         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> moduleContainerBuilder =
 222                 Builders.containerBuilder((ContainerSchemaNode) modulesSchemaNode);
 223         moduleContainerBuilder.withChild(mountPointModulesMap);
 224
 225         return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, modulesSchemaNode,
 226                 mountPoint, controllerContext.getGlobalSchema()), moduleContainerBuilder.build(),
 227                 QueryParametersParser.parseWriterParameters(uriInfo));
 228     }
 229
 230     @Override
 231     public NormalizedNodeContext getModule(final String identifier, final UriInfo uriInfo) {
 232         Preconditions.checkNotNull(identifier);
 233         final QName moduleNameAndRevision = getModuleNameAndRevision(identifier);
 234         Module module = null;
 235         DOMMountPoint mountPoint = null;
 236         final SchemaContext schemaContext;
 237         if (identifier.contains(ControllerContext.MOUNT)) {
 238             final InstanceIdentifierContext<?> mountPointIdentifier = controllerContext.toMountPointIdentifier(identifier);
 239             mountPoint = mountPointIdentifier.getMountPoint();
 240             module = controllerContext.findModuleByNameAndRevision(mountPoint, moduleNameAndRevision);
 241             schemaContext = mountPoint.getSchemaContext();
 242         } else {
 243             module = controllerContext.findModuleByNameAndRevision(moduleNameAndRevision);
 244             schemaContext = controllerContext.getGlobalSchema();
 245         }
 246
 247         if (module == null) {
 248             final String errMsg = "Module with name '" + moduleNameAndRevision.getLocalName()
 249                     + "' and revision '" + moduleNameAndRevision.getRevision() + "' was not found.";
 250             LOG.debug(errMsg);
 251             throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT);
 252         }
 253
 254         final Module restconfModule = getRestconfModule();
 255         final Set<Module> modules = Collections.singleton(module);
 256         final MapNode moduleMap = makeModuleMapNode(modules);
 257
 258         final DataSchemaNode moduleSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(
 259                 restconfModule, Draft02.RestConfModule.MODULE_LIST_SCHEMA_NODE);
 260         Preconditions.checkState(moduleSchemaNode instanceof ListSchemaNode);
 261
 262         return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, moduleSchemaNode, mountPoint,
 263                 schemaContext), moduleMap, QueryParametersParser.parseWriterParameters(uriInfo));
 264     }
 265
 266     @Override
 267     public NormalizedNodeContext getAvailableStreams(final UriInfo uriInfo) {
 268         final SchemaContext schemaContext = controllerContext.getGlobalSchema();
 269         final Set<String> availableStreams = Notificator.getStreamNames();
 270         final Module restconfModule = getRestconfModule();
 271         final DataSchemaNode streamSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(restconfModule,
 272                 Draft02.RestConfModule.STREAM_LIST_SCHEMA_NODE);
 273         Preconditions.checkState(streamSchemaNode instanceof ListSchemaNode);
 274
 275         final CollectionNodeBuilder<MapEntryNode, MapNode> listStreamsBuilder = Builders
 276                 .mapBuilder((ListSchemaNode) streamSchemaNode);
 277
 278         for (final String streamName : availableStreams) {
 279             listStreamsBuilder.withChild(toStreamEntryNode(streamName, streamSchemaNode));
 280         }
 281
 282         final DataSchemaNode streamsContainerSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(
 283                 restconfModule, Draft02.RestConfModule.STREAMS_CONTAINER_SCHEMA_NODE);
 284         Preconditions.checkState(streamsContainerSchemaNode instanceof ContainerSchemaNode);
 285
 286         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> streamsContainerBuilder =
 287                 Builders.containerBuilder((ContainerSchemaNode) streamsContainerSchemaNode);
 288         streamsContainerBuilder.withChild(listStreamsBuilder.build());
 289
 290
 291         return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, streamsContainerSchemaNode, null,
 292                 schemaContext), streamsContainerBuilder.build(), QueryParametersParser.parseWriterParameters(uriInfo));
 293     }
 294
 295     @Override
 296     public NormalizedNodeContext getOperations(final UriInfo uriInfo) {
 297         final Set<Module> allModules = controllerContext.getAllModules();
 298         return operationsFromModulesToNormalizedContext(allModules, null);
 299     }
 300
 301     @Override
 302     public NormalizedNodeContext getOperations(final String identifier, final UriInfo uriInfo) {
 303         Set<Module> modules = null;
 304         DOMMountPoint mountPoint = null;
 305         if (identifier.contains(ControllerContext.MOUNT)) {
 306             final InstanceIdentifierContext<?> mountPointIdentifier = controllerContext.toMountPointIdentifier(identifier);
 307             mountPoint = mountPointIdentifier.getMountPoint();
 308             modules = controllerContext.getAllModules(mountPoint);
 309
 310         } else {
 311             final String errMsg = "URI has bad format. If operations behind mount point should be showed, URI has to end with ";
 312             LOG.debug(errMsg + ControllerContext.MOUNT + " for " + identifier);
 313             throw new RestconfDocumentedException(errMsg + ControllerContext.MOUNT, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 314         }
 315
 316         return operationsFromModulesToNormalizedContext(modules, mountPoint);
 317     }
 318
 319     private static final Predicate<GroupingBuilder> GROUPING_FILTER = new Predicate<GroupingBuilder>() {
 320         @Override
 321         public boolean apply(final GroupingBuilder g) {
 322             return Draft02.RestConfModule.RESTCONF_GROUPING_SCHEMA_NODE.equals(g.getQName().getLocalName());
 323         }
 324     };
 325
 326     private NormalizedNodeContext operationsFromModulesToNormalizedContext(final Set<Module> modules,
 327             final DOMMountPoint mountPoint) {
 328
 329         final Module restconfModule = getRestconfModule();
 330         final ModuleBuilder restConfModuleBuilder = new ModuleBuilder(restconfModule);
 331         final Set<GroupingBuilder> gropingBuilders = restConfModuleBuilder.getGroupingBuilders();
 332         final Iterable<GroupingBuilder> filteredGroups = Iterables.filter(gropingBuilders, GROUPING_FILTER);
 333         final GroupingBuilder restconfGroupingBuilder = Iterables.getFirst(filteredGroups, null);
 334         final ContainerSchemaNodeBuilder restContainerSchemaNodeBuilder = (ContainerSchemaNodeBuilder) restconfGroupingBuilder
 335                 .getDataChildByName(Draft02.RestConfModule.RESTCONF_CONTAINER_SCHEMA_NODE);
 336         final ContainerSchemaNodeBuilder containerSchemaNodeBuilder = (ContainerSchemaNodeBuilder) restContainerSchemaNodeBuilder
 337                 .getDataChildByName(Draft02.RestConfModule.OPERATIONS_CONTAINER_SCHEMA_NODE);
 338
 339         final ContainerSchemaNodeBuilder fakeOperationsSchemaNodeBuilder = containerSchemaNodeBuilder;
 340         final SchemaPath fakeSchemaPath = fakeOperationsSchemaNodeBuilder.getPath().createChild(QName.create("dummy"));
 341
 342         final List<LeafNode<Object>> operationsAsData = new ArrayList<>();
 343
 344         for (final Module module : modules) {
 345             final Set<RpcDefinition> rpcs = module.getRpcs();
 346             for (final RpcDefinition rpc : rpcs) {
 347                 final QName rpcQName = rpc.getQName();
 348                 final String name = module.getName();
 349
 350                 final QName qName = QName.create(restconfModule.getQNameModule(), rpcQName.getLocalName());
 351                 final LeafSchemaNodeBuilder leafSchemaNodeBuilder = new LeafSchemaNodeBuilder(name, 0, qName, fakeSchemaPath);
 352                 final LeafSchemaNodeBuilder fakeRpcSchemaNodeBuilder = leafSchemaNodeBuilder;
 353                 fakeRpcSchemaNodeBuilder.setAugmenting(true);
 354
 355                 final EmptyType instance = EmptyType.getInstance();
 356                 fakeRpcSchemaNodeBuilder.setType(instance);
 357                 final LeafSchemaNode fakeRpcSchemaNode = fakeRpcSchemaNodeBuilder.build();
 358                 fakeOperationsSchemaNodeBuilder.addChildNode(fakeRpcSchemaNode);
 359
 360                 final LeafNode<Object> leaf = Builders.leafBuilder(fakeRpcSchemaNode).build();
 361                 operationsAsData.add(leaf);
 362             }
 363         }
 364
 365         final ContainerSchemaNode operContainerSchemaNode = fakeOperationsSchemaNodeBuilder.build();
 366         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> operContainerNode = Builders.containerBuilder(operContainerSchemaNode);
 367
 368         for (final LeafNode<Object> oper : operationsAsData) {
 369             operContainerNode.withChild(oper);
 370         }
 371
 372         final Set<Module> fakeRpcModules = Collections.singleton(restConfModuleBuilder.build());
 373         final SchemaContext fakeSchemaCx = EffectiveSchemaContext.resolveSchemaContext(fakeRpcModules);
 374         final InstanceIdentifierContext<?> fakeIICx = new InstanceIdentifierContext<>(null, operContainerSchemaNode, mountPoint, fakeSchemaCx);
 375
 376         return new NormalizedNodeContext(fakeIICx, operContainerNode.build());
 377     }
 378
 379     private Module getRestconfModule() {
 380         final Module restconfModule = controllerContext.getRestconfModule();
 381         if (restconfModule == null) {
 382             LOG.debug("ietf-restconf module was not found.");
 383             throw new RestconfDocumentedException("ietf-restconf module was not found.", ErrorType.APPLICATION,
 384                     ErrorTag.OPERATION_NOT_SUPPORTED);
 385         }
 386
 387         return restconfModule;
 388     }
 389
 390     private static QName getModuleNameAndRevision(final String identifier) {
 391         final int mountIndex = identifier.indexOf(ControllerContext.MOUNT);
 392         String moduleNameAndRevision = "";
 393         if (mountIndex >= 0) {
 394             moduleNameAndRevision = identifier.substring(mountIndex + ControllerContext.MOUNT.length());
 395         } else {
 396             moduleNameAndRevision = identifier;
 397         }
 398
 399         final Splitter splitter = Splitter.on("/").omitEmptyStrings();
 400         final Iterable<String> split = splitter.split(moduleNameAndRevision);
 401         final List<String> pathArgs = Lists.<String> newArrayList(split);
 402         if (pathArgs.size() < 2) {
 403             LOG.debug("URI has bad format. It should be \'moduleName/yyyy-MM-dd\' " + identifier);
 404             throw new RestconfDocumentedException(
 405                     "URI has bad format. End of URI should be in format \'moduleName/yyyy-MM-dd\'", ErrorType.PROTOCOL,
 406                     ErrorTag.INVALID_VALUE);
 407         }
 408
 409         try {
 410             final String moduleName = pathArgs.get(0);
 411             final String revision = pathArgs.get(1);
 412             final Date moduleRevision = REVISION_FORMAT.parse(revision);
 413             return QName.create(null, moduleRevision, moduleName);
 414         } catch (final ParseException e) {
 415             LOG.debug("URI has bad format. It should be \'moduleName/yyyy-MM-dd\' " + identifier);
 416             throw new RestconfDocumentedException("URI has bad format. It should be \'moduleName/yyyy-MM-dd\'",
 417                     ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 418         }
 419     }
 420
 421     @Override
 422     public Object getRoot() {
 423         return null;
 424     }
 425
 426     @Override
 427     public NormalizedNodeContext invokeRpc(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
 428         final SchemaPath type = payload.getInstanceIdentifierContext().getSchemaNode().getPath();
 429         final URI namespace = payload.getInstanceIdentifierContext().getSchemaNode().getQName().getNamespace();
 430         final CheckedFuture<DOMRpcResult, DOMRpcException> response;
 431         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
 432         final SchemaContext schemaContext;
 433         if (mountPoint != null) {
 434             final Optional<DOMRpcService> mountRpcServices = mountPoint.getService(DOMRpcService.class);
 435             if ( ! mountRpcServices.isPresent()) {
 436                 LOG.debug("Error: Rpc service is missing.");
 437                 throw new RestconfDocumentedException("Rpc service is missing.");
 438             }
 439             schemaContext = mountPoint.getSchemaContext();
 440             response = mountRpcServices.get().invokeRpc(type, payload.getData());
 441         } else {
 442             if (namespace.toString().equals(SAL_REMOTE_NAMESPACE)) {
 443                 response = invokeSalRemoteRpcSubscribeRPC(payload);
 444             } else {
 445                 response = broker.invokeRpc(type, payload.getData());
 446             }
 447             schemaContext = controllerContext.getGlobalSchema();
 448         }
 449
 450         final DOMRpcResult result = checkRpcResponse(response);
 451
 452         RpcDefinition resultNodeSchema = null;
 453         final NormalizedNode<?, ?> resultData = result.getResult();
 454         if (result != null && result.getResult() != null) {
 455             resultNodeSchema = (RpcDefinition) payload.getInstanceIdentifierContext().getSchemaNode();
 456         }
 457
 458         return new NormalizedNodeContext(new InstanceIdentifierContext<RpcDefinition>(null,
 459                 resultNodeSchema, mountPoint, schemaContext), resultData,
 460                 QueryParametersParser.parseWriterParameters(uriInfo));
 461     }
 462
 463     private static DOMRpcResult checkRpcResponse(final CheckedFuture<DOMRpcResult, DOMRpcException> response) {
 464         if (response == null) {
 465             return null;
 466         }
 467         try {
 468             final DOMRpcResult retValue = response.get();
 469             if (retValue.getErrors() == null || retValue.getErrors().isEmpty()) {
 470                 return retValue;
 471             }
 472             LOG.debug("RpcError message", retValue.getErrors());
 473             throw new RestconfDocumentedException("RpcError message", null, retValue.getErrors());
 474         } catch (final InterruptedException e) {
 475             final String errMsg = "The operation was interrupted while executing and did not complete.";
 476             LOG.debug("Rpc Interrupt - " + errMsg, e);
 477             throw new RestconfDocumentedException(errMsg, ErrorType.RPC, ErrorTag.PARTIAL_OPERATION);
 478         } catch (final ExecutionException e) {
 479             LOG.debug("Execution RpcError: ", e);
 480             Throwable cause = e.getCause();
 481             if (cause != null) {
 482                 while (cause.getCause() != null) {
 483                     cause = cause.getCause();
 484                 }
 485
 486                 if (cause instanceof IllegalArgumentException) {
 487                     throw new RestconfDocumentedException(cause.getMessage(), ErrorType.PROTOCOL,
 488                             ErrorTag.INVALID_VALUE);
 489                 } else if (cause instanceof DOMRpcImplementationNotAvailableException) {
 490                     throw new RestconfDocumentedException(cause.getMessage(), ErrorType.APPLICATION, ErrorTag.OPERATION_NOT_SUPPORTED);
 491                 }
 492                 throw new RestconfDocumentedException("The operation encountered an unexpected error while executing.",cause);
 493             } else {
 494                 throw new RestconfDocumentedException("The operation encountered an unexpected error while executing.",e);
 495             }
 496         } catch (final CancellationException e) {
 497             final String errMsg = "The operation was cancelled while executing.";
 498             LOG.debug("Cancel RpcExecution: " + errMsg, e);
 499             throw new RestconfDocumentedException(errMsg, ErrorType.RPC, ErrorTag.PARTIAL_OPERATION);
 500         }
 501     }
 502
 503     private static void validateInput(final SchemaNode inputSchema, final NormalizedNodeContext payload) {
 504         if (inputSchema != null && payload.getData() == null) {
 505             // expected a non null payload
 506             throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 507         } else if (inputSchema == null && payload.getData() != null) {
 508             // did not expect any input
 509             throw new RestconfDocumentedException("No input expected.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 510         }
 511         // else
 512         // {
 513         // TODO: Validate "mandatory" and "config" values here??? Or should those be
 514         // those be
 515         // validate in a more central location inside MD-SAL core.
 516         // }
 517     }
 518
 519     private CheckedFuture<DOMRpcResult, DOMRpcException> invokeSalRemoteRpcSubscribeRPC(final NormalizedNodeContext payload) {
 520         final ContainerNode value = (ContainerNode) payload.getData();
 521         final QName rpcQName = payload.getInstanceIdentifierContext().getSchemaNode().getQName();
 522         final Optional<DataContainerChild<? extends PathArgument, ?>> path = value.getChild(new NodeIdentifier(
 523                 QName.create(payload.getInstanceIdentifierContext().getSchemaNode().getQName(), "path")));
 524         final Object pathValue = path.isPresent() ? path.get().getValue() : null;
 525
 526         if (!(pathValue instanceof YangInstanceIdentifier)) {
 527             final String errMsg = "Instance identifier was not normalized correctly ";
 528             LOG.debug(errMsg + rpcQName);
 529             throw new RestconfDocumentedException(errMsg, ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED);
 530         }
 531
 532         final YangInstanceIdentifier pathIdentifier = ((YangInstanceIdentifier) pathValue);
 533         String streamName = null;
 534         if (!pathIdentifier.isEmpty()) {
 535             final String fullRestconfIdentifier = controllerContext.toFullRestconfIdentifier(pathIdentifier, null);
 536
 537             LogicalDatastoreType datastore = parseEnumTypeParameter(value, LogicalDatastoreType.class, DATASTORE_PARAM_NAME);
 538             datastore = datastore == null ? DEFAULT_DATASTORE : datastore;
 539
 540             DataChangeScope scope = parseEnumTypeParameter(value, DataChangeScope.class, SCOPE_PARAM_NAME);
 541             scope = scope == null ? DEFAULT_SCOPE : scope;
 542
 543             streamName = Notificator.createStreamNameFromUri(fullRestconfIdentifier + "/datastore=" + datastore
 544                     + "/scope=" + scope);
 545         }
 546
 547         if (Strings.isNullOrEmpty(streamName)) {
 548             final String errMsg = "Path is empty or contains value node which is not Container or List build-in type.";
 549             LOG.debug(errMsg + pathIdentifier);
 550             throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 551         }
 552
 553         final QName outputQname = QName.create(rpcQName, "output");
 554         final QName streamNameQname = QName.create(rpcQName, "stream-name");
 555
 556         final ContainerNode output = ImmutableContainerNodeBuilder.create().withNodeIdentifier(new NodeIdentifier(outputQname))
 557                 .withChild(ImmutableNodes.leafNode(streamNameQname, streamName)).build();
 558
 559         if (!Notificator.existListenerFor(streamName)) {
 560             Notificator.createListener(pathIdentifier, streamName);
 561         }
 562
 563         final DOMRpcResult defaultDOMRpcResult = new DefaultDOMRpcResult(output);
 564
 565         return Futures.immediateCheckedFuture(defaultDOMRpcResult);
 566     }
 567
 568     @Override
 569     public NormalizedNodeContext invokeRpc(final String identifier, final String noPayload, final UriInfo uriInfo) {
 570         if (noPayload != null && !CharMatcher.WHITESPACE.matchesAllOf(noPayload)) {
 571             throw new RestconfDocumentedException("Content must be empty.", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 572         }
 573
 574         String identifierEncoded = null;
 575         DOMMountPoint mountPoint = null;
 576         final SchemaContext schemaContext;
 577         if (identifier.contains(ControllerContext.MOUNT)) {
 578             // mounted RPC call - look up mount instance.
 579             final InstanceIdentifierContext<?> mountPointId = controllerContext.toMountPointIdentifier(identifier);
 580             mountPoint = mountPointId.getMountPoint();
 581             schemaContext = mountPoint.getSchemaContext();
 582             final int startOfRemoteRpcName = identifier.lastIndexOf(ControllerContext.MOUNT)
 583                     + ControllerContext.MOUNT.length() + 1;
 584             final String remoteRpcName = identifier.substring(startOfRemoteRpcName);
 585             identifierEncoded = remoteRpcName;
 586
 587         } else if (identifier.indexOf("/") != CHAR_NOT_FOUND) {
 588             final String slashErrorMsg = String.format("Identifier %n%s%ncan\'t contain slash "
 589                     + "character (/).%nIf slash is part of identifier name then use %%2F placeholder.", identifier);
 590             LOG.debug(slashErrorMsg);
 591             throw new RestconfDocumentedException(slashErrorMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 592         } else {
 593             identifierEncoded = identifier;
 594             schemaContext = controllerContext.getGlobalSchema();
 595         }
 596
 597         final String identifierDecoded = controllerContext.urlPathArgDecode(identifierEncoded);
 598
 599         RpcDefinition rpc = null;
 600         if (mountPoint == null) {
 601             rpc = controllerContext.getRpcDefinition(identifierDecoded, null);
 602         } else {
 603             rpc = findRpc(mountPoint.getSchemaContext(), identifierDecoded);
 604         }
 605
 606         if (rpc == null) {
 607             LOG.debug("RPC " + identifierDecoded + " does not exist.");
 608             throw new RestconfDocumentedException("RPC does not exist.", ErrorType.RPC, ErrorTag.UNKNOWN_ELEMENT);
 609         }
 610
 611         if (rpc.getInput() != null) {
 612             LOG.debug("RPC " + rpc + " does not need input value.");
 613             // FIXME : find a correct Error from specification
 614             throw new IllegalStateException("RPC " + rpc + " does'n need input value!");
 615         }
 616
 617         final CheckedFuture<DOMRpcResult, DOMRpcException> response;
 618         if (mountPoint != null) {
 619             final Optional<DOMRpcService> mountRpcServices = mountPoint.getService(DOMRpcService.class);
 620             if ( ! mountRpcServices.isPresent()) {
 621                 throw new RestconfDocumentedException("Rpc service is missing.");
 622             }
 623             response = mountRpcServices.get().invokeRpc(rpc.getPath(), null);
 624         } else {
 625             response = broker.invokeRpc(rpc.getPath(), null);
 626         }
 627
 628         final DOMRpcResult result = checkRpcResponse(response);
 629
 630         return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, rpc, mountPoint, schemaContext),
 631                 result.getResult(), QueryParametersParser.parseWriterParameters(uriInfo));
 632     }
 633
 634     private static RpcDefinition findRpc(final SchemaContext schemaContext, final String identifierDecoded) {
 635         final String[] splittedIdentifier = identifierDecoded.split(":");
 636         if (splittedIdentifier.length != 2) {
 637             final String errMsg = identifierDecoded + " couldn't be splitted to 2 parts (module:rpc name)";
 638             LOG.debug(errMsg);
 639             throw new RestconfDocumentedException(errMsg, ErrorType.APPLICATION, ErrorTag.INVALID_VALUE);
 640         }
 641         for (final Module module : schemaContext.getModules()) {
 642             if (module.getName().equals(splittedIdentifier[0])) {
 643                 for (final RpcDefinition rpcDefinition : module.getRpcs()) {
 644                     if (rpcDefinition.getQName().getLocalName().equals(splittedIdentifier[1])) {
 645                         return rpcDefinition;
 646                     }
 647                 }
 648             }
 649         }
 650         return null;
 651     }
 652
 653     @Override
 654     public NormalizedNodeContext readConfigurationData(final String identifier, final UriInfo uriInfo) {
 655         final InstanceIdentifierContext<?> iiWithData = controllerContext.toInstanceIdentifier(identifier);
 656         final DOMMountPoint mountPoint = iiWithData.getMountPoint();
 657         NormalizedNode<?, ?> data = null;
 658         final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
 659         if (mountPoint != null) {
 660             data = broker.readConfigurationData(mountPoint, normalizedII);
 661         } else {
 662             data = broker.readConfigurationData(normalizedII);
 663         }
 664         if(data == null) {
 665             final String errMsg = "Request could not be completed because the relevant data model content does not exist ";
 666             LOG.debug(errMsg + identifier);
 667             throw new RestconfDocumentedException(errMsg, ErrorType.APPLICATION, ErrorTag.DATA_MISSING);
 668         }
 669         return new NormalizedNodeContext(iiWithData, data, QueryParametersParser.parseWriterParameters(uriInfo));
 670     }
 671
 672     @Override
 673     public NormalizedNodeContext readOperationalData(final String identifier, final UriInfo uriInfo) {
 674         final InstanceIdentifierContext<?> iiWithData = controllerContext.toInstanceIdentifier(identifier);
 675         final DOMMountPoint mountPoint = iiWithData.getMountPoint();
 676         NormalizedNode<?, ?> data = null;
 677         final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
 678         if (mountPoint != null) {
 679             data = broker.readOperationalData(mountPoint, normalizedII);
 680         } else {
 681             data = broker.readOperationalData(normalizedII);
 682         }
 683         if(data == null) {
 684             final String errMsg = "Request could not be completed because the relevant data model content does not exist ";
 685             LOG.debug(errMsg + identifier);
 686             throw new RestconfDocumentedException(errMsg , ErrorType.APPLICATION, ErrorTag.DATA_MISSING);
 687         }
 688         return new NormalizedNodeContext(iiWithData, data, QueryParametersParser.parseWriterParameters(uriInfo));
 689     }
 690
 691     @Override
 692     public Response updateConfigurationData(final String identifier, final NormalizedNodeContext payload) {
 693         Preconditions.checkNotNull(identifier);
 694         final InstanceIdentifierContext<?> iiWithData = payload.getInstanceIdentifierContext();
 695
 696         validateInput(iiWithData.getSchemaNode(), payload);
 697         validateTopLevelNodeName(payload, iiWithData.getInstanceIdentifier());
 698         validateListKeysEqualityInPayloadAndUri(payload);
 699
 700         final DOMMountPoint mountPoint = iiWithData.getMountPoint();
 701         final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
 702
 703         /*
 704          * There is a small window where another write transaction could be updating the same data
 705          * simultaneously and we get an OptimisticLockFailedException. This error is likely
 706          * transient and The WriteTransaction#submit API docs state that a retry will likely
 707          * succeed. So we'll try again if that scenario occurs. If it fails a third time then it
 708          * probably will never succeed so we'll fail in that case.
 709          *
 710          * By retrying we're attempting to hide the internal implementation of the data store and
 711          * how it handles concurrent updates from the restconf client. The client has instructed us
 712          * to put the data and we should make every effort to do so without pushing optimistic lock
 713          * failures back to the client and forcing them to handle it via retry (and having to
 714          * document the behavior).
 715          */
 716         int tries = 2;
 717         while(true) {
 718             try {
 719                 if (mountPoint != null) {
 720                     broker.commitConfigurationDataPut(mountPoint, normalizedII, payload.getData()).checkedGet();
 721                 } else {
 722                     broker.commitConfigurationDataPut(controllerContext.getGlobalSchema(), normalizedII, payload.getData()).checkedGet();
 723                 }
 724
 725                 break;
 726             } catch (final TransactionCommitFailedException e) {
 727                 if(e instanceof OptimisticLockFailedException) {
 728                     if(--tries <= 0) {
 729                         LOG.debug("Got OptimisticLockFailedException on last try - failing " + identifier);
 730                         throw new RestconfDocumentedException(e.getMessage(), e, e.getErrorList());
 731                     }
 732
 733                     LOG.debug("Got OptimisticLockFailedException - trying again " + identifier);
 734                 } else {
 735                     LOG.debug("Update ConfigDataStore fail " + identifier, e);
 736                     throw new RestconfDocumentedException(e.getMessage(), e, e.getErrorList());
 737                 }
 738             } catch (Exception e) {
 739                 final String errMsg = "Error updating data ";
 740                 LOG.debug(errMsg + identifier, e);
 741                 throw new RestconfDocumentedException(errMsg, e);
 742             }
 743         }
 744
 745         return Response.status(Status.OK).build();
 746     }
 747
 748     private static void validateTopLevelNodeName(final NormalizedNodeContext node,
 749             final YangInstanceIdentifier identifier) {
 750
 751         final String payloadName = node.getData().getNodeType().getLocalName();
 752
 753         //no arguments
 754         if (identifier.isEmpty()) {
 755             //no "data" payload
 756             if (!node.getData().getNodeType().equals(NETCONF_BASE_QNAME)) {
 757                 throw new RestconfDocumentedException("Instance identifier has to contain at least one path argument",
 758                         ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 759             }
 760         //any arguments
 761         } else {
 762             final String identifierName = identifier.getLastPathArgument().getNodeType().getLocalName();
 763             if (!payloadName.equals(identifierName)) {
 764                 throw new RestconfDocumentedException("Payload name (" + payloadName
 765                         + ") is different from identifier name (" + identifierName + ")", ErrorType.PROTOCOL,
 766                         ErrorTag.MALFORMED_MESSAGE);
 767             }
 768         }
 769     }
 770
 771     /**
 772      * Validates whether keys in {@code payload} are equal to values of keys in {@code iiWithData} for list schema node
 773      *
 774      * @throws RestconfDocumentedException
 775      *             if key values or key count in payload and URI isn't equal
 776      *
 777      */
 778     private static void validateListKeysEqualityInPayloadAndUri(final NormalizedNodeContext payload) {
 779         Preconditions.checkArgument(payload != null);
 780         final InstanceIdentifierContext<?> iiWithData = payload.getInstanceIdentifierContext();
 781         final PathArgument lastPathArgument = iiWithData.getInstanceIdentifier().getLastPathArgument();
 782         final SchemaNode schemaNode = iiWithData.getSchemaNode();
 783         final NormalizedNode<?, ?> data = payload.getData();
 784         if (schemaNode instanceof ListSchemaNode) {
 785             final List<QName> keyDefinitions = ((ListSchemaNode) schemaNode).getKeyDefinition();
 786             if (lastPathArgument instanceof NodeIdentifierWithPredicates && data instanceof MapEntryNode) {
 787                 final Map<QName, Object> uriKeyValues = ((NodeIdentifierWithPredicates) lastPathArgument).getKeyValues();
 788                 isEqualUriAndPayloadKeyValues(uriKeyValues, (MapEntryNode) data, keyDefinitions);
 789             }
 790         }
 791     }
 792
 793     private static void isEqualUriAndPayloadKeyValues(final Map<QName, Object> uriKeyValues,
 794             final MapEntryNode payload, final List<QName> keyDefinitions) {
 795
 796         final Map<QName, Object> mutableCopyUriKeyValues = Maps.newHashMap(uriKeyValues);
 797         for (final QName keyDefinition : keyDefinitions) {
 798             final Object uriKeyValue = mutableCopyUriKeyValues.remove(keyDefinition);
 799             // should be caught during parsing URI to InstanceIdentifier
 800             RestconfValidationUtils.checkDocumentedError(uriKeyValue != null, ErrorType.PROTOCOL, ErrorTag.DATA_MISSING,
 801                     "Missing key " + keyDefinition + " in URI.");
 802
 803             final Object dataKeyValue = payload.getIdentifier().getKeyValues().get(keyDefinition);
 804
 805             if ( ! uriKeyValue.equals(dataKeyValue)) {
 806                 final String errMsg = "The value '" + uriKeyValue + "' for key '" + keyDefinition.getLocalName() +
 807                         "' specified in the URI doesn't match the value '" + dataKeyValue + "' specified in the message body. ";
 808                 throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 809             }
 810         }
 811     }
 812
 813     @Override
 814     public Response createConfigurationData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
 815        return createConfigurationData(payload, uriInfo);
 816     }
 817
 818     // FIXME create RestconfIdetifierHelper and move this method there
 819     private static YangInstanceIdentifier checkConsistencyOfNormalizedNodeContext(final NormalizedNodeContext payload) {
 820         Preconditions.checkArgument(payload != null);
 821         Preconditions.checkArgument(payload.getData() != null);
 822         Preconditions.checkArgument(payload.getData().getNodeType() != null);
 823         Preconditions.checkArgument(payload.getInstanceIdentifierContext() != null);
 824         Preconditions.checkArgument(payload.getInstanceIdentifierContext().getInstanceIdentifier() != null);
 825
 826         final QName payloadNodeQname = payload.getData().getNodeType();
 827         final YangInstanceIdentifier yangIdent = payload.getInstanceIdentifierContext().getInstanceIdentifier();
 828         if (payloadNodeQname.compareTo(yangIdent.getLastPathArgument().getNodeType()) > 0) {
 829             return yangIdent;
 830         }
 831         final InstanceIdentifierContext<?> parentContext = payload.getInstanceIdentifierContext();
 832         final SchemaNode parentSchemaNode = parentContext.getSchemaNode();
 833         if(parentSchemaNode instanceof DataNodeContainer) {
 834             final DataNodeContainer cast = (DataNodeContainer) parentSchemaNode;
 835             for (final DataSchemaNode child : cast.getChildNodes()) {
 836                 if (payloadNodeQname.compareTo(child.getQName()) == 0) {
 837                     return YangInstanceIdentifier.builder(yangIdent).node(child.getQName()).build();
 838                 }
 839             }
 840         }
 841         if (parentSchemaNode instanceof RpcDefinition) {
 842             return yangIdent;
 843         }
 844         final String errMsg = "Error parsing input: DataSchemaNode has not children ";
 845         LOG.info(errMsg + yangIdent);
 846         throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 847     }
 848
 849     @Override
 850     public Response createConfigurationData(final NormalizedNodeContext payload, final UriInfo uriInfo) {
 851         if (payload == null) {
 852             throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 853         }
 854
 855         // FIXME: move this to parsing stage (we can have augmentation nodes here which do not have namespace)
 856 //        final URI payloadNS = payload.getData().getNodeType().getNamespace();
 857 //        if (payloadNS == null) {
 858 //            throw new RestconfDocumentedException(
 859 //                    "Data has bad format. Root element node must have namespace (XML format) or module name(JSON format)",
 860 //                    ErrorType.PROTOCOL, ErrorTag.UNKNOWN_NAMESPACE);
 861 //        }
 862
 863         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
 864         final InstanceIdentifierContext<?> iiWithData = payload.getInstanceIdentifierContext();
 865         final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
 866         try {
 867             if (mountPoint != null) {
 868                 broker.commitConfigurationDataPost(mountPoint, normalizedII, payload.getData()).checkedGet();
 869             } else {
 870                 broker.commitConfigurationDataPost(controllerContext.getGlobalSchema(), normalizedII, payload.getData()).checkedGet();
 871             }
 872         } catch(final RestconfDocumentedException e) {
 873             throw e;
 874         } catch (final Exception e) {
 875             final String errMsg = "Error creating data ";
 876             LOG.info(errMsg + (uriInfo != null ? uriInfo.getPath() : ""), e);
 877             throw new RestconfDocumentedException(errMsg, e);
 878         }
 879
 880         final ResponseBuilder responseBuilder = Response.status(Status.NO_CONTENT);
 881         // FIXME: Provide path to result.
 882         final URI location = resolveLocation(uriInfo, "", mountPoint, normalizedII);
 883         if (location != null) {
 884             responseBuilder.location(location);
 885         }
 886         return responseBuilder.build();
 887     }
 888
 889     private URI resolveLocation(final UriInfo uriInfo, final String uriBehindBase, final DOMMountPoint mountPoint, final YangInstanceIdentifier normalizedII) {
 890         if(uriInfo == null) {
 891             // This is null if invoked internally
 892             return null;
 893         }
 894
 895         final UriBuilder uriBuilder = uriInfo.getBaseUriBuilder();
 896         uriBuilder.path("config");
 897         try {
 898             uriBuilder.path(controllerContext.toFullRestconfIdentifier(normalizedII, mountPoint));
 899         } catch (final Exception e) {
 900             LOG.info("Location for instance identifier" + normalizedII + "wasn't created", e);
 901             return null;
 902         }
 903         return uriBuilder.build();
 904     }
 905
 906     @Override
 907     public Response deleteConfigurationData(final String identifier) {
 908         final InstanceIdentifierContext<?> iiWithData = controllerContext.toInstanceIdentifier(identifier);
 909         final DOMMountPoint mountPoint = iiWithData.getMountPoint();
 910         final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
 911
 912         try {
 913             if (mountPoint != null) {
 914                 broker.commitConfigurationDataDelete(mountPoint, normalizedII);
 915             } else {
 916                 broker.commitConfigurationDataDelete(normalizedII).get();
 917             }
 918         } catch (final Exception e) {
 919             final Optional<Throwable> searchedException = Iterables.tryFind(Throwables.getCausalChain(e),
 920                     Predicates.instanceOf(ModifiedNodeDoesNotExistException.class));
 921             if (searchedException.isPresent()) {
 922                 throw new RestconfDocumentedException("Data specified for deleting doesn't exist.", ErrorType.APPLICATION, ErrorTag.DATA_MISSING);
 923             }
 924             final String errMsg = "Error while deleting data";
 925             LOG.info(errMsg, e);
 926             throw new RestconfDocumentedException(errMsg, e);
 927         }
 928         return Response.status(Status.OK).build();
 929     }
 930
 931     /**
 932      * Subscribes to some path in schema context (stream) to listen on changes on this stream.
 933      *
 934      * Additional parameters for subscribing to stream are loaded via rpc input parameters:
 935      * <ul>
 936      * <li>datastore - default CONFIGURATION (other values of {@link LogicalDatastoreType} enum type)</li>
 937      * <li>scope - default BASE (other values of {@link DataChangeScope})</li>
 938      * </ul>
 939      */
 940     @Override
 941     public Response subscribeToStream(final String identifier, final UriInfo uriInfo) {
 942         final String streamName = Notificator.createStreamNameFromUri(identifier);
 943         if (Strings.isNullOrEmpty(streamName)) {
 944             throw new RestconfDocumentedException("Stream name is empty.", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 945         }
 946
 947         final ListenerAdapter listener = Notificator.getListenerFor(streamName);
 948         if (listener == null) {
 949             throw new RestconfDocumentedException("Stream was not found.", ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT);
 950         }
 951
 952         final Map<String, String> paramToValues = resolveValuesFromUri(identifier);
 953         final LogicalDatastoreType datastore = parserURIEnumParameter(LogicalDatastoreType.class,
 954                 paramToValues.get(DATASTORE_PARAM_NAME));
 955         if (datastore == null) {
 956             throw new RestconfDocumentedException("Stream name doesn't contains datastore value (pattern /datastore=)",
 957                     ErrorType.APPLICATION, ErrorTag.MISSING_ATTRIBUTE);
 958         }
 959         final DataChangeScope scope = parserURIEnumParameter(DataChangeScope.class, paramToValues.get(SCOPE_PARAM_NAME));
 960         if (scope == null) {
 961             throw new RestconfDocumentedException("Stream name doesn't contains datastore value (pattern /scope=)",
 962                     ErrorType.APPLICATION, ErrorTag.MISSING_ATTRIBUTE);
 963         }
 964
 965         broker.registerToListenDataChanges(datastore, scope, listener);
 966
 967         final UriBuilder uriBuilder = uriInfo.getAbsolutePathBuilder();
 968         int notificationPort = NOTIFICATION_PORT;
 969         try {
 970             final WebSocketServer webSocketServerInstance = WebSocketServer.getInstance();
 971             notificationPort = webSocketServerInstance.getPort();
 972         } catch (final NullPointerException e) {
 973             WebSocketServer.createInstance(NOTIFICATION_PORT);
 974         }
 975         final UriBuilder uriToWebsocketServerBuilder = uriBuilder.port(notificationPort).scheme("ws");
 976         final URI uriToWebsocketServer = uriToWebsocketServerBuilder.replacePath(streamName).build();
 977
 978         return Response.status(Status.OK).location(uriToWebsocketServer).build();
 979     }
 980
 981     /**
 982      * Load parameter for subscribing to stream from input composite node
 983      *
 984      * @param compNode
 985      *            contains value
 986      * @return enum object if its string value is equal to {@code paramName}. In other cases null.
 987      */
 988     private static <T> T parseEnumTypeParameter(final ContainerNode value, final Class<T> classDescriptor,
 989             final String paramName) {
 990         final Optional<DataContainerChild<? extends PathArgument, ?>> augNode = value.getChild(SAL_REMOTE_AUG_IDENTIFIER);
 991         if (!augNode.isPresent() && !(augNode instanceof AugmentationNode)) {
 992             return null;
 993         }
 994         final Optional<DataContainerChild<? extends PathArgument, ?>> enumNode =
 995                 ((AugmentationNode) augNode.get()).getChild(new NodeIdentifier(QName.create(SAL_REMOTE_AUGMENT, paramName)));
 996         if (!enumNode.isPresent()) {
 997             return null;
 998         }
 999         final Object rawValue = enumNode.get().getValue();
1000         if (!(rawValue instanceof String)) {
1001             return null;
1002         }
1003
1004         return resolveAsEnum(classDescriptor, (String) rawValue);
1005     }
1006
1007     /**
1008      * Checks whether {@code value} is one of the string representation of enumeration {@code classDescriptor}
1009      *
1010      * @return enum object if string value of {@code classDescriptor} enumeration is equal to {@code value}. Other cases
1011      *         null.
1012      */
1013     private static <T> T parserURIEnumParameter(final Class<T> classDescriptor, final String value) {
1014         if (Strings.isNullOrEmpty(value)) {
1015             return null;
1016         }
1017         return resolveAsEnum(classDescriptor, value);
1018     }
1019
1020     private static <T> T resolveAsEnum(final Class<T> classDescriptor, final String value) {
1021         final T[] enumConstants = classDescriptor.getEnumConstants();
1022         if (enumConstants != null) {
1023             for (final T enm : classDescriptor.getEnumConstants()) {
1024                 if (((Enum<?>) enm).name().equals(value)) {
1025                     return enm;
1026                 }
1027             }
1028         }
1029         return null;
1030     }
1031
1032     private static Map<String, String> resolveValuesFromUri(final String uri) {
1033         final Map<String, String> result = new HashMap<>();
1034         final String[] tokens = uri.split("/");
1035         for (int i = 1; i < tokens.length; i++) {
1036             final String[] parameterTokens = tokens[i].split("=");
1037             if (parameterTokens.length == 2) {
1038                 result.put(parameterTokens[0], parameterTokens[1]);
1039             }
1040         }
1041         return result;
1042     }
1043
1044     public BigInteger getOperationalReceived() {
1045         // TODO Auto-generated method stub
1046         return null;
1047     }
1048
1049     private MapNode makeModuleMapNode(final Set<Module> modules) {
1050         Preconditions.checkNotNull(modules);
1051         final Module restconfModule = getRestconfModule();
1052         final DataSchemaNode moduleSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(
1053                 restconfModule, Draft02.RestConfModule.MODULE_LIST_SCHEMA_NODE);
1054         Preconditions.checkState(moduleSchemaNode instanceof ListSchemaNode);
1055
1056         final CollectionNodeBuilder<MapEntryNode, MapNode> listModuleBuilder = Builders
1057                 .mapBuilder((ListSchemaNode) moduleSchemaNode);
1058
1059         for (final Module module : modules) {
1060             listModuleBuilder.withChild(toModuleEntryNode(module, moduleSchemaNode));
1061         }
1062         return listModuleBuilder.build();
1063     }
1064
1065     protected MapEntryNode toModuleEntryNode(final Module module, final DataSchemaNode moduleSchemaNode) {
1066         Preconditions.checkArgument(moduleSchemaNode instanceof ListSchemaNode,
1067                 "moduleSchemaNode has to be of type ListSchemaNode");
1068         final ListSchemaNode listModuleSchemaNode = (ListSchemaNode) moduleSchemaNode;
1069         final DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> moduleNodeValues = Builders
1070                 .mapEntryBuilder(listModuleSchemaNode);
1071
1072         List<DataSchemaNode> instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1073                 (listModuleSchemaNode), "name");
1074         final DataSchemaNode nameSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1075         Preconditions.checkState(nameSchemaNode instanceof LeafSchemaNode);
1076         moduleNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) nameSchemaNode).withValue(module.getName())
1077                 .build());
1078
1079         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1080                 (listModuleSchemaNode), "revision");
1081         final DataSchemaNode revisionSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1082         Preconditions.checkState(revisionSchemaNode instanceof LeafSchemaNode);
1083         final String revision = REVISION_FORMAT.format(module.getRevision());
1084         moduleNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) revisionSchemaNode).withValue(revision)
1085                 .build());
1086
1087         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1088                 (listModuleSchemaNode), "namespace");
1089         final DataSchemaNode namespaceSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1090         Preconditions.checkState(namespaceSchemaNode instanceof LeafSchemaNode);
1091         moduleNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) namespaceSchemaNode)
1092                 .withValue(module.getNamespace().toString()).build());
1093
1094         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1095                 (listModuleSchemaNode), "feature");
1096         final DataSchemaNode featureSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1097         Preconditions.checkState(featureSchemaNode instanceof LeafListSchemaNode);
1098         final ListNodeBuilder<Object, LeafSetEntryNode<Object>> featuresBuilder = Builders
1099                 .leafSetBuilder((LeafListSchemaNode) featureSchemaNode);
1100         for (final FeatureDefinition feature : module.getFeatures()) {
1101             featuresBuilder.withChild(Builders.leafSetEntryBuilder(((LeafListSchemaNode) featureSchemaNode))
1102                     .withValue(feature.getQName().getLocalName()).build());
1103         }
1104         moduleNodeValues.withChild(featuresBuilder.build());
1105
1106         return moduleNodeValues.build();
1107     }
1108
1109     protected MapEntryNode toStreamEntryNode(final String streamName, final DataSchemaNode streamSchemaNode) {
1110         Preconditions.checkArgument(streamSchemaNode instanceof ListSchemaNode,
1111                 "streamSchemaNode has to be of type ListSchemaNode");
1112         final ListSchemaNode listStreamSchemaNode = (ListSchemaNode) streamSchemaNode;
1113         final DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> streamNodeValues = Builders
1114                 .mapEntryBuilder(listStreamSchemaNode);
1115
1116         List<DataSchemaNode> instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1117                 (listStreamSchemaNode), "name");
1118         final DataSchemaNode nameSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1119         Preconditions.checkState(nameSchemaNode instanceof LeafSchemaNode);
1120         streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) nameSchemaNode).withValue(streamName)
1121                 .build());
1122
1123         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1124                 (listStreamSchemaNode), "description");
1125         final DataSchemaNode descriptionSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1126         Preconditions.checkState(descriptionSchemaNode instanceof LeafSchemaNode);
1127         streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) nameSchemaNode)
1128                 .withValue("DESCRIPTION_PLACEHOLDER").build());
1129
1130         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1131                 (listStreamSchemaNode), "replay-support");
1132         final DataSchemaNode replaySupportSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1133         Preconditions.checkState(replaySupportSchemaNode instanceof LeafSchemaNode);
1134         streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) replaySupportSchemaNode)
1135                 .withValue(Boolean.valueOf(true)).build());
1136
1137         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1138                 (listStreamSchemaNode), "replay-log-creation-time");
1139         final DataSchemaNode replayLogCreationTimeSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1140         Preconditions.checkState(replayLogCreationTimeSchemaNode instanceof LeafSchemaNode);
1141         streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) replayLogCreationTimeSchemaNode)
1142                 .withValue("").build());
1143
1144         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1145                 (listStreamSchemaNode), "events");
1146         final DataSchemaNode eventsSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1147         Preconditions.checkState(eventsSchemaNode instanceof LeafSchemaNode);
1148         streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) eventsSchemaNode)
1149                 .withValue("").build());
1150
1151         return streamNodeValues.build();
1152     }
1153 }