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.DOMRpcResult;
  51 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  52 import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult;
  53 import org.opendaylight.netconf.md.sal.rest.common.RestconfValidationUtils;
  54 import org.opendaylight.netconf.sal.rest.api.Draft02;
  55 import org.opendaylight.netconf.sal.rest.api.RestconfService;
  56 import org.opendaylight.netconf.sal.restconf.impl.RestconfError.ErrorTag;
  57 import org.opendaylight.netconf.sal.restconf.impl.RestconfError.ErrorType;
  58 import org.opendaylight.netconf.sal.streams.listeners.ListenerAdapter;
  59 import org.opendaylight.netconf.sal.streams.listeners.Notificator;
  60 import org.opendaylight.netconf.sal.streams.websockets.WebSocketServer;
  61 import org.opendaylight.yangtools.yang.common.QName;
  62 import org.opendaylight.yangtools.yang.common.QNameModule;
  63 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  64 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  65 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  66 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  67 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
  68 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  69 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  70 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  71 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  72 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  73 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  74 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  75 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModifiedNodeDoesNotExistException;
  76 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  77 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  78 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  79 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
  80 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
  81 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  82 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  83 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  84 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  85 import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
  86 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  87 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  88 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  89 import org.opendaylight.yangtools.yang.model.api.Module;
  90 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  91 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  92 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  93 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  94 import org.opendaylight.yangtools.yang.model.util.EmptyType;
  95 import org.opendaylight.yangtools.yang.parser.builder.api.GroupingBuilder;
  96 import org.opendaylight.yangtools.yang.parser.builder.impl.ContainerSchemaNodeBuilder;
  97 import org.opendaylight.yangtools.yang.parser.builder.impl.LeafSchemaNodeBuilder;
  98 import org.opendaylight.yangtools.yang.parser.builder.impl.ModuleBuilder;
  99 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
 100 import org.slf4j.Logger;
 101 import org.slf4j.LoggerFactory;
 102
 103 public class RestconfImpl implements RestconfService {
 104
 105     private static final RestconfImpl INSTANCE = new RestconfImpl();
 106
 107     private static final int NOTIFICATION_PORT = 8181;
 108
 109     private static final int CHAR_NOT_FOUND = -1;
 110
 111     private static final String MOUNT_POINT_MODULE_NAME = "ietf-netconf";
 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
 375         final YangParserImpl yangParser = new YangParserImpl();
 376         final SchemaContext fakeSchemaCx = yangParser.resolveSchemaContext(fakeRpcModules);
 377
 378         final InstanceIdentifierContext<?> fakeIICx = new InstanceIdentifierContext<>(null, operContainerSchemaNode, mountPoint, fakeSchemaCx);
 379
 380         return new NormalizedNodeContext(fakeIICx, operContainerNode.build());
 381     }
 382
 383     private Module getRestconfModule() {
 384         final Module restconfModule = controllerContext.getRestconfModule();
 385         if (restconfModule == null) {
 386             LOG.debug("ietf-restconf module was not found.");
 387             throw new RestconfDocumentedException("ietf-restconf module was not found.", ErrorType.APPLICATION,
 388                     ErrorTag.OPERATION_NOT_SUPPORTED);
 389         }
 390
 391         return restconfModule;
 392     }
 393
 394     private static QName getModuleNameAndRevision(final String identifier) {
 395         final int mountIndex = identifier.indexOf(ControllerContext.MOUNT);
 396         String moduleNameAndRevision = "";
 397         if (mountIndex >= 0) {
 398             moduleNameAndRevision = identifier.substring(mountIndex + ControllerContext.MOUNT.length());
 399         } else {
 400             moduleNameAndRevision = identifier;
 401         }
 402
 403         final Splitter splitter = Splitter.on("/").omitEmptyStrings();
 404         final Iterable<String> split = splitter.split(moduleNameAndRevision);
 405         final List<String> pathArgs = Lists.<String> newArrayList(split);
 406         if (pathArgs.size() < 2) {
 407             LOG.debug("URI has bad format. It should be \'moduleName/yyyy-MM-dd\' " + identifier);
 408             throw new RestconfDocumentedException(
 409                     "URI has bad format. End of URI should be in format \'moduleName/yyyy-MM-dd\'", ErrorType.PROTOCOL,
 410                     ErrorTag.INVALID_VALUE);
 411         }
 412
 413         try {
 414             final String moduleName = pathArgs.get(0);
 415             final String revision = pathArgs.get(1);
 416             final Date moduleRevision = REVISION_FORMAT.parse(revision);
 417             return QName.create(null, moduleRevision, moduleName);
 418         } catch (final ParseException e) {
 419             LOG.debug("URI has bad format. It should be \'moduleName/yyyy-MM-dd\' " + identifier);
 420             throw new RestconfDocumentedException("URI has bad format. It should be \'moduleName/yyyy-MM-dd\'",
 421                     ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 422         }
 423     }
 424
 425     @Override
 426     public Object getRoot() {
 427         return null;
 428     }
 429
 430     @Override
 431     public NormalizedNodeContext invokeRpc(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
 432         final SchemaPath type = payload.getInstanceIdentifierContext().getSchemaNode().getPath();
 433         final URI namespace = payload.getInstanceIdentifierContext().getSchemaNode().getQName().getNamespace();
 434         final CheckedFuture<DOMRpcResult, DOMRpcException> response;
 435         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
 436         final SchemaContext schemaContext;
 437         if (identifier.contains(MOUNT_POINT_MODULE_NAME) && mountPoint != null) {
 438             final Optional<DOMRpcService> mountRpcServices = mountPoint.getService(DOMRpcService.class);
 439             if ( ! mountRpcServices.isPresent()) {
 440                 LOG.debug("Error: Rpc service is missing.");
 441                 throw new RestconfDocumentedException("Rpc service is missing.");
 442             }
 443             schemaContext = mountPoint.getSchemaContext();
 444             response = mountRpcServices.get().invokeRpc(type, payload.getData());
 445         } else {
 446             if (namespace.toString().equals(SAL_REMOTE_NAMESPACE)) {
 447                 response = invokeSalRemoteRpcSubscribeRPC(payload);
 448             } else {
 449                 response = broker.invokeRpc(type, payload.getData());
 450             }
 451             schemaContext = controllerContext.getGlobalSchema();
 452         }
 453
 454         final DOMRpcResult result = checkRpcResponse(response);
 455
 456         RpcDefinition resultNodeSchema = null;
 457         final NormalizedNode<?, ?> resultData = result.getResult();
 458         if (result != null && result.getResult() != null) {
 459             resultNodeSchema = (RpcDefinition) payload.getInstanceIdentifierContext().getSchemaNode();
 460         }
 461
 462         return new NormalizedNodeContext(new InstanceIdentifierContext<RpcDefinition>(null,
 463                 resultNodeSchema, mountPoint, schemaContext), resultData,
 464                 QueryParametersParser.parseWriterParameters(uriInfo));
 465     }
 466
 467     private static DOMRpcResult checkRpcResponse(final CheckedFuture<DOMRpcResult, DOMRpcException> response) {
 468         if (response == null) {
 469             return null;
 470         }
 471         try {
 472             final DOMRpcResult retValue = response.get();
 473             if (retValue.getErrors() == null || retValue.getErrors().isEmpty()) {
 474                 return retValue;
 475             }
 476             LOG.debug("RpcError message", retValue.getErrors());
 477             throw new RestconfDocumentedException("RpcError message", null, retValue.getErrors());
 478         } catch (final InterruptedException e) {
 479             final String errMsg = "The operation was interrupted while executing and did not complete.";
 480             LOG.debug("Rpc Interrupt - " + errMsg, e);
 481             throw new RestconfDocumentedException(errMsg, ErrorType.RPC, ErrorTag.PARTIAL_OPERATION);
 482         } catch (final ExecutionException e) {
 483             LOG.debug("Execution RpcError: ", e);
 484             Throwable cause = e.getCause();
 485             if (cause != null) {
 486                 while (cause.getCause() != null) {
 487                     cause = cause.getCause();
 488                 }
 489
 490                 if (cause instanceof IllegalArgumentException) {
 491                     throw new RestconfDocumentedException(cause.getMessage(), ErrorType.PROTOCOL,
 492                             ErrorTag.INVALID_VALUE);
 493                 }
 494                 throw new RestconfDocumentedException("The operation encountered an unexpected error while executing.",cause);
 495             } else {
 496                 throw new RestconfDocumentedException("The operation encountered an unexpected error while executing.",e);
 497             }
 498         } catch (final CancellationException e) {
 499             final String errMsg = "The operation was cancelled while executing.";
 500             LOG.debug("Cancel RpcExecution: " + errMsg, e);
 501             throw new RestconfDocumentedException(errMsg, ErrorType.RPC, ErrorTag.PARTIAL_OPERATION);
 502         }
 503     }
 504
 505     private static void validateInput(final SchemaNode inputSchema, final NormalizedNodeContext payload) {
 506         if (inputSchema != null && payload.getData() == null) {
 507             // expected a non null payload
 508             throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 509         } else if (inputSchema == null && payload.getData() != null) {
 510             // did not expect any input
 511             throw new RestconfDocumentedException("No input expected.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 512         }
 513         // else
 514         // {
 515         // TODO: Validate "mandatory" and "config" values here??? Or should those be
 516         // those be
 517         // validate in a more central location inside MD-SAL core.
 518         // }
 519     }
 520
 521     private CheckedFuture<DOMRpcResult, DOMRpcException> invokeSalRemoteRpcSubscribeRPC(final NormalizedNodeContext payload) {
 522         final ContainerNode value = (ContainerNode) payload.getData();
 523         final QName rpcQName = payload.getInstanceIdentifierContext().getSchemaNode().getQName();
 524         final Optional<DataContainerChild<? extends PathArgument, ?>> path = value.getChild(new NodeIdentifier(
 525                 QName.create(payload.getInstanceIdentifierContext().getSchemaNode().getQName(), "path")));
 526         final Object pathValue = path.isPresent() ? path.get().getValue() : null;
 527
 528         if (!(pathValue instanceof YangInstanceIdentifier)) {
 529             final String errMsg = "Instance identifier was not normalized correctly ";
 530             LOG.debug(errMsg + rpcQName);
 531             throw new RestconfDocumentedException(errMsg, ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED);
 532         }
 533
 534         final YangInstanceIdentifier pathIdentifier = ((YangInstanceIdentifier) pathValue);
 535         String streamName = null;
 536         if (!pathIdentifier.isEmpty()) {
 537             final String fullRestconfIdentifier = controllerContext.toFullRestconfIdentifier(pathIdentifier, null);
 538
 539             LogicalDatastoreType datastore = parseEnumTypeParameter(value, LogicalDatastoreType.class, DATASTORE_PARAM_NAME);
 540             datastore = datastore == null ? DEFAULT_DATASTORE : datastore;
 541
 542             DataChangeScope scope = parseEnumTypeParameter(value, DataChangeScope.class, SCOPE_PARAM_NAME);
 543             scope = scope == null ? DEFAULT_SCOPE : scope;
 544
 545             streamName = Notificator.createStreamNameFromUri(fullRestconfIdentifier + "/datastore=" + datastore
 546                     + "/scope=" + scope);
 547         }
 548
 549         if (Strings.isNullOrEmpty(streamName)) {
 550             final String errMsg = "Path is empty or contains value node which is not Container or List build-in type.";
 551             LOG.debug(errMsg + pathIdentifier);
 552             throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 553         }
 554
 555         final QName outputQname = QName.create(rpcQName, "output");
 556         final QName streamNameQname = QName.create(rpcQName, "stream-name");
 557
 558         final ContainerNode output = ImmutableContainerNodeBuilder.create().withNodeIdentifier(new NodeIdentifier(outputQname))
 559                 .withChild(ImmutableNodes.leafNode(streamNameQname, streamName)).build();
 560
 561         if (!Notificator.existListenerFor(streamName)) {
 562             Notificator.createListener(pathIdentifier, streamName);
 563         }
 564
 565         final DOMRpcResult defaultDOMRpcResult = new DefaultDOMRpcResult(output);
 566
 567         return Futures.immediateCheckedFuture(defaultDOMRpcResult);
 568     }
 569
 570     @Override
 571     public NormalizedNodeContext invokeRpc(final String identifier, final String noPayload, final UriInfo uriInfo) {
 572         if (noPayload != null && !CharMatcher.WHITESPACE.matchesAllOf(noPayload)) {
 573             throw new RestconfDocumentedException("Content must be empty.", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 574         }
 575
 576         String identifierEncoded = null;
 577         DOMMountPoint mountPoint = null;
 578         final SchemaContext schemaContext;
 579         if (identifier.contains(ControllerContext.MOUNT)) {
 580             // mounted RPC call - look up mount instance.
 581             final InstanceIdentifierContext<?> mountPointId = controllerContext.toMountPointIdentifier(identifier);
 582             mountPoint = mountPointId.getMountPoint();
 583             schemaContext = mountPoint.getSchemaContext();
 584             final int startOfRemoteRpcName = identifier.lastIndexOf(ControllerContext.MOUNT)
 585                     + ControllerContext.MOUNT.length() + 1;
 586             final String remoteRpcName = identifier.substring(startOfRemoteRpcName);
 587             identifierEncoded = remoteRpcName;
 588
 589         } else if (identifier.indexOf("/") != CHAR_NOT_FOUND) {
 590             final String slashErrorMsg = String.format("Identifier %n%s%ncan\'t contain slash "
 591                     + "character (/).%nIf slash is part of identifier name then use %%2F placeholder.", identifier);
 592             LOG.debug(slashErrorMsg);
 593             throw new RestconfDocumentedException(slashErrorMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 594         } else {
 595             identifierEncoded = identifier;
 596             schemaContext = controllerContext.getGlobalSchema();
 597         }
 598
 599         final String identifierDecoded = controllerContext.urlPathArgDecode(identifierEncoded);
 600
 601         RpcDefinition rpc = null;
 602         if (mountPoint == null) {
 603             rpc = controllerContext.getRpcDefinition(identifierDecoded);
 604         } else {
 605             rpc = findRpc(mountPoint.getSchemaContext(), identifierDecoded);
 606         }
 607
 608         if (rpc == null) {
 609             LOG.debug("RPC " + identifierDecoded + " does not exist.");
 610             throw new RestconfDocumentedException("RPC does not exist.", ErrorType.RPC, ErrorTag.UNKNOWN_ELEMENT);
 611         }
 612
 613         if (rpc.getInput() != null) {
 614             LOG.debug("RPC " + rpc + " does not need input value.");
 615             // FIXME : find a correct Error from specification
 616             throw new IllegalStateException("RPC " + rpc + " does'n need input value!");
 617         }
 618
 619         final CheckedFuture<DOMRpcResult, DOMRpcException> response;
 620         if (mountPoint != null) {
 621             final Optional<DOMRpcService> mountRpcServices = mountPoint.getService(DOMRpcService.class);
 622             if ( ! mountRpcServices.isPresent()) {
 623                 throw new RestconfDocumentedException("Rpc service is missing.");
 624             }
 625             response = mountRpcServices.get().invokeRpc(rpc.getPath(), null);
 626         } else {
 627             response = broker.invokeRpc(rpc.getPath(), null);
 628         }
 629
 630         final DOMRpcResult result = checkRpcResponse(response);
 631
 632         return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, rpc, mountPoint, schemaContext),
 633                 result.getResult(), QueryParametersParser.parseWriterParameters(uriInfo));
 634     }
 635
 636     private static RpcDefinition findRpc(final SchemaContext schemaContext, final String identifierDecoded) {
 637         final String[] splittedIdentifier = identifierDecoded.split(":");
 638         if (splittedIdentifier.length != 2) {
 639             final String errMsg = identifierDecoded + " couldn't be splitted to 2 parts (module:rpc name)";
 640             LOG.debug(errMsg);
 641             throw new RestconfDocumentedException(errMsg, ErrorType.APPLICATION, ErrorTag.INVALID_VALUE);
 642         }
 643         for (final Module module : schemaContext.getModules()) {
 644             if (module.getName().equals(splittedIdentifier[0])) {
 645                 for (final RpcDefinition rpcDefinition : module.getRpcs()) {
 646                     if (rpcDefinition.getQName().getLocalName().equals(splittedIdentifier[1])) {
 647                         return rpcDefinition;
 648                     }
 649                 }
 650             }
 651         }
 652         return null;
 653     }
 654
 655     @Override
 656     public NormalizedNodeContext readConfigurationData(final String identifier, final UriInfo uriInfo) {
 657         final InstanceIdentifierContext<?> iiWithData = controllerContext.toInstanceIdentifier(identifier);
 658         final DOMMountPoint mountPoint = iiWithData.getMountPoint();
 659         NormalizedNode<?, ?> data = null;
 660         final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
 661         if (mountPoint != null) {
 662             data = broker.readConfigurationData(mountPoint, normalizedII);
 663         } else {
 664             data = broker.readConfigurationData(normalizedII);
 665         }
 666         if(data == null) {
 667             final String errMsg = "Request could not be completed because the relevant data model content does not exist ";
 668             LOG.debug(errMsg + identifier);
 669             throw new RestconfDocumentedException(errMsg, ErrorType.APPLICATION, ErrorTag.DATA_MISSING);
 670         }
 671         return new NormalizedNodeContext(iiWithData, data, QueryParametersParser.parseWriterParameters(uriInfo));
 672     }
 673
 674     @Override
 675     public NormalizedNodeContext readOperationalData(final String identifier, final UriInfo uriInfo) {
 676         final InstanceIdentifierContext<?> iiWithData = controllerContext.toInstanceIdentifier(identifier);
 677         final DOMMountPoint mountPoint = iiWithData.getMountPoint();
 678         NormalizedNode<?, ?> data = null;
 679         final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
 680         if (mountPoint != null) {
 681             data = broker.readOperationalData(mountPoint, normalizedII);
 682         } else {
 683             data = broker.readOperationalData(normalizedII);
 684         }
 685         if(data == null) {
 686             final String errMsg = "Request could not be completed because the relevant data model content does not exist ";
 687             LOG.debug(errMsg + identifier);
 688             throw new RestconfDocumentedException(errMsg , ErrorType.APPLICATION, ErrorTag.DATA_MISSING);
 689         }
 690         return new NormalizedNodeContext(iiWithData, data, QueryParametersParser.parseWriterParameters(uriInfo));
 691     }
 692
 693     @Override
 694     public Response updateConfigurationData(final String identifier, final NormalizedNodeContext payload) {
 695         Preconditions.checkNotNull(identifier);
 696         final InstanceIdentifierContext<?> iiWithData = payload.getInstanceIdentifierContext();
 697
 698         validateInput(iiWithData.getSchemaNode(), payload);
 699         validateTopLevelNodeName(payload, iiWithData.getInstanceIdentifier());
 700         validateListKeysEqualityInPayloadAndUri(payload);
 701
 702         final DOMMountPoint mountPoint = iiWithData.getMountPoint();
 703         final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
 704
 705         /*
 706          * There is a small window where another write transaction could be updating the same data
 707          * simultaneously and we get an OptimisticLockFailedException. This error is likely
 708          * transient and The WriteTransaction#submit API docs state that a retry will likely
 709          * succeed. So we'll try again if that scenario occurs. If it fails a third time then it
 710          * probably will never succeed so we'll fail in that case.
 711          *
 712          * By retrying we're attempting to hide the internal implementation of the data store and
 713          * how it handles concurrent updates from the restconf client. The client has instructed us
 714          * to put the data and we should make every effort to do so without pushing optimistic lock
 715          * failures back to the client and forcing them to handle it via retry (and having to
 716          * document the behavior).
 717          */
 718         int tries = 2;
 719         while(true) {
 720             try {
 721                 if (mountPoint != null) {
 722                     broker.commitConfigurationDataPut(mountPoint, normalizedII, payload.getData()).checkedGet();
 723                 } else {
 724                     broker.commitConfigurationDataPut(controllerContext.getGlobalSchema(), normalizedII, payload.getData()).checkedGet();
 725                 }
 726
 727                 break;
 728             } catch (final TransactionCommitFailedException e) {
 729                 if(e instanceof OptimisticLockFailedException) {
 730                     if(--tries <= 0) {
 731                         LOG.debug("Got OptimisticLockFailedException on last try - failing " + identifier);
 732                         throw new RestconfDocumentedException(e.getMessage(), e, e.getErrorList());
 733                     }
 734
 735                     LOG.debug("Got OptimisticLockFailedException - trying again " + identifier);
 736                 } else {
 737                     LOG.debug("Update ConfigDataStore fail " + identifier, e);
 738                     throw new RestconfDocumentedException(e.getMessage(), e, e.getErrorList());
 739                 }
 740             } catch (Exception e) {
 741                 final String errMsg = "Error updating data ";
 742                 LOG.debug(errMsg + identifier, e);
 743                 throw new RestconfDocumentedException(errMsg, e);
 744             }
 745         }
 746
 747         return Response.status(Status.OK).build();
 748     }
 749
 750     private static void validateTopLevelNodeName(final NormalizedNodeContext node,
 751             final YangInstanceIdentifier identifier) {
 752
 753         final String payloadName = node.getData().getNodeType().getLocalName();
 754
 755         //no arguments
 756         if (identifier.isEmpty()) {
 757             //no "data" payload
 758             if (!node.getData().getNodeType().equals(NETCONF_BASE_QNAME)) {
 759                 throw new RestconfDocumentedException("Instance identifier has to contain at least one path argument",
 760                         ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 761             }
 762         //any arguments
 763         } else {
 764             final String identifierName = identifier.getLastPathArgument().getNodeType().getLocalName();
 765             if (!payloadName.equals(identifierName)) {
 766                 throw new RestconfDocumentedException("Payload name (" + payloadName
 767                         + ") is different from identifier name (" + identifierName + ")", ErrorType.PROTOCOL,
 768                         ErrorTag.MALFORMED_MESSAGE);
 769             }
 770         }
 771     }
 772
 773     /**
 774      * Validates whether keys in {@code payload} are equal to values of keys in {@code iiWithData} for list schema node
 775      *
 776      * @throws RestconfDocumentedException
 777      *             if key values or key count in payload and URI isn't equal
 778      *
 779      */
 780     private static void validateListKeysEqualityInPayloadAndUri(final NormalizedNodeContext payload) {
 781         Preconditions.checkArgument(payload != null);
 782         final InstanceIdentifierContext<?> iiWithData = payload.getInstanceIdentifierContext();
 783         final PathArgument lastPathArgument = iiWithData.getInstanceIdentifier().getLastPathArgument();
 784         final SchemaNode schemaNode = iiWithData.getSchemaNode();
 785         final NormalizedNode<?, ?> data = payload.getData();
 786         if (schemaNode instanceof ListSchemaNode) {
 787             final List<QName> keyDefinitions = ((ListSchemaNode) schemaNode).getKeyDefinition();
 788             if (lastPathArgument instanceof NodeIdentifierWithPredicates && data instanceof MapEntryNode) {
 789                 final Map<QName, Object> uriKeyValues = ((NodeIdentifierWithPredicates) lastPathArgument).getKeyValues();
 790                 isEqualUriAndPayloadKeyValues(uriKeyValues, (MapEntryNode) data, keyDefinitions);
 791             }
 792         }
 793     }
 794
 795     private static void isEqualUriAndPayloadKeyValues(final Map<QName, Object> uriKeyValues,
 796             final MapEntryNode payload, final List<QName> keyDefinitions) {
 797
 798         final Map<QName, Object> mutableCopyUriKeyValues = Maps.newHashMap(uriKeyValues);
 799         for (final QName keyDefinition : keyDefinitions) {
 800             final Object uriKeyValue = mutableCopyUriKeyValues.remove(keyDefinition);
 801             // should be caught during parsing URI to InstanceIdentifier
 802             RestconfValidationUtils.checkDocumentedError(uriKeyValue != null, ErrorType.PROTOCOL, ErrorTag.DATA_MISSING,
 803                     "Missing key " + keyDefinition + " in URI.");
 804
 805             final Object dataKeyValue = payload.getIdentifier().getKeyValues().get(keyDefinition);
 806
 807             if ( ! uriKeyValue.equals(dataKeyValue)) {
 808                 final String errMsg = "The value '" + uriKeyValue + "' for key '" + keyDefinition.getLocalName() +
 809                         "' specified in the URI doesn't match the value '" + dataKeyValue + "' specified in the message body. ";
 810                 throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 811             }
 812         }
 813     }
 814
 815     @Override
 816     public Response createConfigurationData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
 817        return createConfigurationData(payload, uriInfo);
 818     }
 819
 820     // FIXME create RestconfIdetifierHelper and move this method there
 821     private static YangInstanceIdentifier checkConsistencyOfNormalizedNodeContext(final NormalizedNodeContext payload) {
 822         Preconditions.checkArgument(payload != null);
 823         Preconditions.checkArgument(payload.getData() != null);
 824         Preconditions.checkArgument(payload.getData().getNodeType() != null);
 825         Preconditions.checkArgument(payload.getInstanceIdentifierContext() != null);
 826         Preconditions.checkArgument(payload.getInstanceIdentifierContext().getInstanceIdentifier() != null);
 827
 828         final QName payloadNodeQname = payload.getData().getNodeType();
 829         final YangInstanceIdentifier yangIdent = payload.getInstanceIdentifierContext().getInstanceIdentifier();
 830         if (payloadNodeQname.compareTo(yangIdent.getLastPathArgument().getNodeType()) > 0) {
 831             return yangIdent;
 832         }
 833         final InstanceIdentifierContext<?> parentContext = payload.getInstanceIdentifierContext();
 834         final SchemaNode parentSchemaNode = parentContext.getSchemaNode();
 835         if(parentSchemaNode instanceof DataNodeContainer) {
 836             final DataNodeContainer cast = (DataNodeContainer) parentSchemaNode;
 837             for (final DataSchemaNode child : cast.getChildNodes()) {
 838                 if (payloadNodeQname.compareTo(child.getQName()) == 0) {
 839                     return YangInstanceIdentifier.builder(yangIdent).node(child.getQName()).build();
 840                 }
 841             }
 842         }
 843         if (parentSchemaNode instanceof RpcDefinition) {
 844             return yangIdent;
 845         }
 846         final String errMsg = "Error parsing input: DataSchemaNode has not children ";
 847         LOG.info(errMsg + yangIdent);
 848         throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 849     }
 850
 851     @Override
 852     public Response createConfigurationData(final NormalizedNodeContext payload, final UriInfo uriInfo) {
 853         if (payload == null) {
 854             throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 855         }
 856
 857         // FIXME: move this to parsing stage (we can have augmentation nodes here which do not have namespace)
 858 //        final URI payloadNS = payload.getData().getNodeType().getNamespace();
 859 //        if (payloadNS == null) {
 860 //            throw new RestconfDocumentedException(
 861 //                    "Data has bad format. Root element node must have namespace (XML format) or module name(JSON format)",
 862 //                    ErrorType.PROTOCOL, ErrorTag.UNKNOWN_NAMESPACE);
 863 //        }
 864
 865         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
 866         final InstanceIdentifierContext<?> iiWithData = payload.getInstanceIdentifierContext();
 867         final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
 868         try {
 869             if (mountPoint != null) {
 870                 broker.commitConfigurationDataPost(mountPoint, normalizedII, payload.getData()).checkedGet();
 871             } else {
 872                 broker.commitConfigurationDataPost(controllerContext.getGlobalSchema(), normalizedII, payload.getData()).checkedGet();
 873             }
 874         } catch(final RestconfDocumentedException e) {
 875             throw e;
 876         } catch (final Exception e) {
 877             final String errMsg = "Error creating data ";
 878             LOG.info(errMsg + (uriInfo != null ? uriInfo.getPath() : ""), e);
 879             throw new RestconfDocumentedException(errMsg, e);
 880         }
 881
 882         final ResponseBuilder responseBuilder = Response.status(Status.NO_CONTENT);
 883         // FIXME: Provide path to result.
 884         final URI location = resolveLocation(uriInfo, "", mountPoint, normalizedII);
 885         if (location != null) {
 886             responseBuilder.location(location);
 887         }
 888         return responseBuilder.build();
 889     }
 890
 891     private URI resolveLocation(final UriInfo uriInfo, final String uriBehindBase, final DOMMountPoint mountPoint, final YangInstanceIdentifier normalizedII) {
 892         if(uriInfo == null) {
 893             // This is null if invoked internally
 894             return null;
 895         }
 896
 897         final UriBuilder uriBuilder = uriInfo.getBaseUriBuilder();
 898         uriBuilder.path("config");
 899         try {
 900             uriBuilder.path(controllerContext.toFullRestconfIdentifier(normalizedII, mountPoint));
 901         } catch (final Exception e) {
 902             LOG.info("Location for instance identifier" + normalizedII + "wasn't created", e);
 903             return null;
 904         }
 905         return uriBuilder.build();
 906     }
 907
 908     @Override
 909     public Response deleteConfigurationData(final String identifier) {
 910         final InstanceIdentifierContext<?> iiWithData = controllerContext.toInstanceIdentifier(identifier);
 911         final DOMMountPoint mountPoint = iiWithData.getMountPoint();
 912         final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
 913
 914         try {
 915             if (mountPoint != null) {
 916                 broker.commitConfigurationDataDelete(mountPoint, normalizedII);
 917             } else {
 918                 broker.commitConfigurationDataDelete(normalizedII).get();
 919             }
 920         } catch (final Exception e) {
 921             final Optional<Throwable> searchedException = Iterables.tryFind(Throwables.getCausalChain(e),
 922                     Predicates.instanceOf(ModifiedNodeDoesNotExistException.class));
 923             if (searchedException.isPresent()) {
 924                 throw new RestconfDocumentedException("Data specified for deleting doesn't exist.", ErrorType.APPLICATION, ErrorTag.DATA_MISSING);
 925             }
 926             final String errMsg = "Error while deleting data";
 927             LOG.info(errMsg, e);
 928             throw new RestconfDocumentedException(errMsg, e);
 929         }
 930         return Response.status(Status.OK).build();
 931     }
 932
 933     /**
 934      * Subscribes to some path in schema context (stream) to listen on changes on this stream.
 935      *
 936      * Additional parameters for subscribing to stream are loaded via rpc input parameters:
 937      * <ul>
 938      * <li>datastore</li> - default CONFIGURATION (other values of {@link LogicalDatastoreType} enum type)
 939      * <li>scope</li> - default BASE (other values of {@link DataChangeScope})
 940      * </ul>
 941      */
 942     @Override
 943     public Response subscribeToStream(final String identifier, final UriInfo uriInfo) {
 944         final String streamName = Notificator.createStreamNameFromUri(identifier);
 945         if (Strings.isNullOrEmpty(streamName)) {
 946             throw new RestconfDocumentedException("Stream name is empty.", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 947         }
 948
 949         final ListenerAdapter listener = Notificator.getListenerFor(streamName);
 950         if (listener == null) {
 951             throw new RestconfDocumentedException("Stream was not found.", ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT);
 952         }
 953
 954         final Map<String, String> paramToValues = resolveValuesFromUri(identifier);
 955         final LogicalDatastoreType datastore = parserURIEnumParameter(LogicalDatastoreType.class,
 956                 paramToValues.get(DATASTORE_PARAM_NAME));
 957         if (datastore == null) {
 958             throw new RestconfDocumentedException("Stream name doesn't contains datastore value (pattern /datastore=)",
 959                     ErrorType.APPLICATION, ErrorTag.MISSING_ATTRIBUTE);
 960         }
 961         final DataChangeScope scope = parserURIEnumParameter(DataChangeScope.class, paramToValues.get(SCOPE_PARAM_NAME));
 962         if (scope == null) {
 963             throw new RestconfDocumentedException("Stream name doesn't contains datastore value (pattern /scope=)",
 964                     ErrorType.APPLICATION, ErrorTag.MISSING_ATTRIBUTE);
 965         }
 966
 967         broker.registerToListenDataChanges(datastore, scope, listener);
 968
 969         final UriBuilder uriBuilder = uriInfo.getAbsolutePathBuilder();
 970         int notificationPort = NOTIFICATION_PORT;
 971         try {
 972             final WebSocketServer webSocketServerInstance = WebSocketServer.getInstance();
 973             notificationPort = webSocketServerInstance.getPort();
 974         } catch (final NullPointerException e) {
 975             WebSocketServer.createInstance(NOTIFICATION_PORT);
 976         }
 977         final UriBuilder uriToWebsocketServerBuilder = uriBuilder.port(notificationPort).scheme("ws");
 978         final URI uriToWebsocketServer = uriToWebsocketServerBuilder.replacePath(streamName).build();
 979
 980         return Response.status(Status.OK).location(uriToWebsocketServer).build();
 981     }
 982
 983     /**
 984      * Load parameter for subscribing to stream from input composite node
 985      *
 986      * @param compNode
 987      *            contains value
 988      * @return enum object if its string value is equal to {@code paramName}. In other cases null.
 989      */
 990     private static <T> T parseEnumTypeParameter(final ContainerNode value, final Class<T> classDescriptor,
 991             final String paramName) {
 992         final Optional<DataContainerChild<? extends PathArgument, ?>> augNode = value.getChild(SAL_REMOTE_AUG_IDENTIFIER);
 993         if (!augNode.isPresent() && !(augNode instanceof AugmentationNode)) {
 994             return null;
 995         }
 996         final Optional<DataContainerChild<? extends PathArgument, ?>> enumNode =
 997                 ((AugmentationNode) augNode.get()).getChild(new NodeIdentifier(QName.create(SAL_REMOTE_AUGMENT, paramName)));
 998         if (!enumNode.isPresent()) {
 999             return null;
1000         }
1001         final Object rawValue = enumNode.get().getValue();
1002         if (!(rawValue instanceof String)) {
1003             return null;
1004         }
1005
1006         return resolveAsEnum(classDescriptor, (String) rawValue);
1007     }
1008
1009     /**
1010      * Checks whether {@code value} is one of the string representation of enumeration {@code classDescriptor}
1011      *
1012      * @return enum object if string value of {@code classDescriptor} enumeration is equal to {@code value}. Other cases
1013      *         null.
1014      */
1015     private static <T> T parserURIEnumParameter(final Class<T> classDescriptor, final String value) {
1016         if (Strings.isNullOrEmpty(value)) {
1017             return null;
1018         }
1019         return resolveAsEnum(classDescriptor, value);
1020     }
1021
1022     private static <T> T resolveAsEnum(final Class<T> classDescriptor, final String value) {
1023         final T[] enumConstants = classDescriptor.getEnumConstants();
1024         if (enumConstants != null) {
1025             for (final T enm : classDescriptor.getEnumConstants()) {
1026                 if (((Enum<?>) enm).name().equals(value)) {
1027                     return enm;
1028                 }
1029             }
1030         }
1031         return null;
1032     }
1033
1034     private static Map<String, String> resolveValuesFromUri(final String uri) {
1035         final Map<String, String> result = new HashMap<>();
1036         final String[] tokens = uri.split("/");
1037         for (int i = 1; i < tokens.length; i++) {
1038             final String[] parameterTokens = tokens[i].split("=");
1039             if (parameterTokens.length == 2) {
1040                 result.put(parameterTokens[0], parameterTokens[1]);
1041             }
1042         }
1043         return result;
1044     }
1045
1046     public BigInteger getOperationalReceived() {
1047         // TODO Auto-generated method stub
1048         return null;
1049     }
1050
1051     private MapNode makeModuleMapNode(final Set<Module> modules) {
1052         Preconditions.checkNotNull(modules);
1053         final Module restconfModule = getRestconfModule();
1054         final DataSchemaNode moduleSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(
1055                 restconfModule, Draft02.RestConfModule.MODULE_LIST_SCHEMA_NODE);
1056         Preconditions.checkState(moduleSchemaNode instanceof ListSchemaNode);
1057
1058         final CollectionNodeBuilder<MapEntryNode, MapNode> listModuleBuilder = Builders
1059                 .mapBuilder((ListSchemaNode) moduleSchemaNode);
1060
1061         for (final Module module : modules) {
1062             listModuleBuilder.withChild(toModuleEntryNode(module, moduleSchemaNode));
1063         }
1064         return listModuleBuilder.build();
1065     }
1066
1067     protected MapEntryNode toModuleEntryNode(final Module module, final DataSchemaNode moduleSchemaNode) {
1068         Preconditions.checkArgument(moduleSchemaNode instanceof ListSchemaNode,
1069                 "moduleSchemaNode has to be of type ListSchemaNode");
1070         final ListSchemaNode listModuleSchemaNode = (ListSchemaNode) moduleSchemaNode;
1071         final DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> moduleNodeValues = Builders
1072                 .mapEntryBuilder(listModuleSchemaNode);
1073
1074         List<DataSchemaNode> instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1075                 (listModuleSchemaNode), "name");
1076         final DataSchemaNode nameSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1077         Preconditions.checkState(nameSchemaNode instanceof LeafSchemaNode);
1078         moduleNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) nameSchemaNode).withValue(module.getName())
1079                 .build());
1080
1081         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1082                 (listModuleSchemaNode), "revision");
1083         final DataSchemaNode revisionSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1084         Preconditions.checkState(revisionSchemaNode instanceof LeafSchemaNode);
1085         final String revision = REVISION_FORMAT.format(module.getRevision());
1086         moduleNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) revisionSchemaNode).withValue(revision)
1087                 .build());
1088
1089         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1090                 (listModuleSchemaNode), "namespace");
1091         final DataSchemaNode namespaceSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1092         Preconditions.checkState(namespaceSchemaNode instanceof LeafSchemaNode);
1093         moduleNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) namespaceSchemaNode)
1094                 .withValue(module.getNamespace().toString()).build());
1095
1096         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1097                 (listModuleSchemaNode), "feature");
1098         final DataSchemaNode featureSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1099         Preconditions.checkState(featureSchemaNode instanceof LeafListSchemaNode);
1100         final ListNodeBuilder<Object, LeafSetEntryNode<Object>> featuresBuilder = Builders
1101                 .leafSetBuilder((LeafListSchemaNode) featureSchemaNode);
1102         for (final FeatureDefinition feature : module.getFeatures()) {
1103             featuresBuilder.withChild(Builders.leafSetEntryBuilder(((LeafListSchemaNode) featureSchemaNode))
1104                     .withValue(feature.getQName().getLocalName()).build());
1105         }
1106         moduleNodeValues.withChild(featuresBuilder.build());
1107
1108         return moduleNodeValues.build();
1109     }
1110
1111     protected MapEntryNode toStreamEntryNode(final String streamName, final DataSchemaNode streamSchemaNode) {
1112         Preconditions.checkArgument(streamSchemaNode instanceof ListSchemaNode,
1113                 "streamSchemaNode has to be of type ListSchemaNode");
1114         final ListSchemaNode listStreamSchemaNode = (ListSchemaNode) streamSchemaNode;
1115         final DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> streamNodeValues = Builders
1116                 .mapEntryBuilder(listStreamSchemaNode);
1117
1118         List<DataSchemaNode> instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1119                 (listStreamSchemaNode), "name");
1120         final DataSchemaNode nameSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1121         Preconditions.checkState(nameSchemaNode instanceof LeafSchemaNode);
1122         streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) nameSchemaNode).withValue(streamName)
1123                 .build());
1124
1125         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1126                 (listStreamSchemaNode), "description");
1127         final DataSchemaNode descriptionSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1128         Preconditions.checkState(descriptionSchemaNode instanceof LeafSchemaNode);
1129         streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) nameSchemaNode)
1130                 .withValue("DESCRIPTION_PLACEHOLDER").build());
1131
1132         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1133                 (listStreamSchemaNode), "replay-support");
1134         final DataSchemaNode replaySupportSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1135         Preconditions.checkState(replaySupportSchemaNode instanceof LeafSchemaNode);
1136         streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) replaySupportSchemaNode)
1137                 .withValue(Boolean.valueOf(true)).build());
1138
1139         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1140                 (listStreamSchemaNode), "replay-log-creation-time");
1141         final DataSchemaNode replayLogCreationTimeSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1142         Preconditions.checkState(replayLogCreationTimeSchemaNode instanceof LeafSchemaNode);
1143         streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) replayLogCreationTimeSchemaNode)
1144                 .withValue("").build());
1145
1146         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1147                 (listStreamSchemaNode), "events");
1148         final DataSchemaNode eventsSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1149         Preconditions.checkState(eventsSchemaNode instanceof LeafSchemaNode);
1150         streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) eventsSchemaNode)
1151                 .withValue("").build());
1152
1153         return streamNodeValues.build();
1154     }
1155 }