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