restconf/restconf-nb-bierman02/src/main/java/org/opendaylight/netconf/sal/restconf/impl/RestconfImpl.java

   1 /*
   2  * Copyright (c) 2014 - 2016 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.annotations.VisibleForTesting;
  12 import com.google.common.base.CharMatcher;
  13 import com.google.common.base.Optional;
  14 import com.google.common.base.Preconditions;
  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.ImmutableSet;
  20 import com.google.common.collect.Iterables;
  21 import com.google.common.collect.Lists;
  22 import com.google.common.collect.Maps;
  23 import com.google.common.util.concurrent.CheckedFuture;
  24 import com.google.common.util.concurrent.Futures;
  25 import java.net.URI;
  26 import java.text.ParseException;
  27 import java.time.Instant;
  28 import java.time.format.DateTimeFormatter;
  29 import java.time.format.DateTimeFormatterBuilder;
  30 import java.time.format.DateTimeParseException;
  31 import java.time.temporal.ChronoField;
  32 import java.time.temporal.TemporalAccessor;
  33 import java.util.ArrayList;
  34 import java.util.Collection;
  35 import java.util.Collections;
  36 import java.util.HashMap;
  37 import java.util.Iterator;
  38 import java.util.List;
  39 import java.util.Map;
  40 import java.util.Map.Entry;
  41 import java.util.Objects;
  42 import java.util.Set;
  43 import java.util.concurrent.CancellationException;
  44 import java.util.concurrent.ExecutionException;
  45 import javax.ws.rs.core.Context;
  46 import javax.ws.rs.core.Response;
  47 import javax.ws.rs.core.Response.ResponseBuilder;
  48 import javax.ws.rs.core.Response.Status;
  49 import javax.ws.rs.core.UriBuilder;
  50 import javax.ws.rs.core.UriInfo;
  51 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
  52 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  53 import org.opendaylight.controller.md.sal.common.api.data.OptimisticLockFailedException;
  54 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  55 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
  56 import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
  57 import org.opendaylight.controller.md.sal.dom.api.DOMRpcImplementationNotAvailableException;
  58 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
  59 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  60 import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult;
  61 import org.opendaylight.netconf.sal.rest.api.Draft02;
  62 import org.opendaylight.netconf.sal.rest.api.RestconfService;
  63 import org.opendaylight.netconf.sal.streams.listeners.ListenerAdapter;
  64 import org.opendaylight.netconf.sal.streams.listeners.NotificationListenerAdapter;
  65 import org.opendaylight.netconf.sal.streams.listeners.Notificator;
  66 import org.opendaylight.netconf.sal.streams.websockets.WebSocketServer;
  67 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  68 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
  69 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  70 import org.opendaylight.restconf.common.errors.RestconfError.ErrorTag;
  71 import org.opendaylight.restconf.common.errors.RestconfError.ErrorType;
  72 import org.opendaylight.restconf.common.patch.PatchContext;
  73 import org.opendaylight.restconf.common.patch.PatchStatusContext;
  74 import org.opendaylight.restconf.common.validation.RestconfValidationUtils;
  75 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
  76 import org.opendaylight.yang.gen.v1.urn.sal.restconf.event.subscription.rev140708.NotificationOutputTypeGrouping.NotificationOutputType;
  77 import org.opendaylight.yangtools.yang.common.QName;
  78 import org.opendaylight.yangtools.yang.common.QNameModule;
  79 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
  80 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  81 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  82 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  83 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  84 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  85 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
  86 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  87 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  88 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  89 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  90 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  91 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  92 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  93 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  94 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModifiedNodeDoesNotExistException;
  95 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  96 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  97 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  98 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
  99 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
 100 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeAttrBuilder;
 101 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
 102 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeBuilder;
 103 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
 104 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
 105 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
 106 import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
 107 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
 108 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
 109 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
 110 import org.opendaylight.yangtools.yang.model.api.Module;
 111 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
 112 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
 113 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
 114 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
 115 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
 116 import org.opendaylight.yangtools.yang.model.util.SimpleSchemaContext;
 117 import org.slf4j.Logger;
 118 import org.slf4j.LoggerFactory;
 119
 120 public class RestconfImpl implements RestconfService {
 121
 122     private static final RestconfImpl INSTANCE = new RestconfImpl();
 123
 124     /**
 125      * Notifications are served on port 8181.
 126      */
 127     private static final int NOTIFICATION_PORT = 8181;
 128
 129     private static final int CHAR_NOT_FOUND = -1;
 130
 131     private static final String SAL_REMOTE_NAMESPACE = "urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote";
 132
 133     private static final Logger LOG = LoggerFactory.getLogger(RestconfImpl.class);
 134
 135     private static final DataChangeScope DEFAULT_SCOPE = DataChangeScope.BASE;
 136
 137     private static final LogicalDatastoreType DEFAULT_DATASTORE = LogicalDatastoreType.CONFIGURATION;
 138
 139     private static final URI NAMESPACE_EVENT_SUBSCRIPTION_AUGMENT = URI.create("urn:sal:restconf:event:subscription");
 140
 141     private static final String DATASTORE_PARAM_NAME = "datastore";
 142
 143     private static final String SCOPE_PARAM_NAME = "scope";
 144
 145     private static final String OUTPUT_TYPE_PARAM_NAME = "notification-output-type";
 146
 147     private static final String NETCONF_BASE = "urn:ietf:params:xml:ns:netconf:base:1.0";
 148
 149     private static final String NETCONF_BASE_PAYLOAD_NAME = "data";
 150
 151     private static final QName NETCONF_BASE_QNAME = QName.create(QNameModule.create(URI.create(NETCONF_BASE), null),
 152         NETCONF_BASE_PAYLOAD_NAME).intern();
 153
 154     private static final QNameModule SAL_REMOTE_AUGMENT;
 155
 156     static {
 157         try {
 158             SAL_REMOTE_AUGMENT = QNameModule.create(NAMESPACE_EVENT_SUBSCRIPTION_AUGMENT,
 159                 SimpleDateFormatUtil.getRevisionFormat().parse("2014-07-08"));
 160         } catch (final ParseException e) {
 161             throw new ExceptionInInitializerError(e);
 162         }
 163     }
 164
 165     private static final AugmentationIdentifier SAL_REMOTE_AUG_IDENTIFIER =
 166             new AugmentationIdentifier(ImmutableSet.of(
 167                 QName.create(SAL_REMOTE_AUGMENT, "scope"), QName.create(SAL_REMOTE_AUGMENT, "datastore"),
 168                 QName.create(SAL_REMOTE_AUGMENT, "notification-output-type")));
 169
 170     public static final CharSequence DATA_SUBSCR = "data-change-event-subscription";
 171     private static final CharSequence CREATE_DATA_SUBSCR = "create-" + DATA_SUBSCR;
 172
 173     public static final CharSequence NOTIFICATION_STREAM = "notification-stream";
 174     private static final CharSequence CREATE_NOTIFICATION_STREAM = "create-" + NOTIFICATION_STREAM;
 175
 176     private static final DateTimeFormatter FORMATTER = new DateTimeFormatterBuilder()
 177             .appendValue(ChronoField.YEAR, 4).appendLiteral('-')
 178             .appendValue(ChronoField.MONTH_OF_YEAR, 2).appendLiteral('-')
 179             .appendValue(ChronoField.DAY_OF_MONTH, 2).appendLiteral('T')
 180             .appendValue(ChronoField.HOUR_OF_DAY, 2).appendLiteral(':')
 181             .appendValue(ChronoField.MINUTE_OF_HOUR, 2).appendLiteral(':')
 182             .appendValue(ChronoField.SECOND_OF_MINUTE, 2)
 183             .appendFraction(ChronoField.NANO_OF_SECOND, 0, 9, true)
 184             .appendOffset("+HH:MM", "Z").toFormatter();
 185
 186     private BrokerFacade broker;
 187
 188     private ControllerContext controllerContext;
 189
 190     public void setBroker(final BrokerFacade broker) {
 191         this.broker = broker;
 192     }
 193
 194     public void setControllerContext(final ControllerContext controllerContext) {
 195         this.controllerContext = controllerContext;
 196     }
 197
 198     private RestconfImpl() {
 199     }
 200
 201     public static RestconfImpl getInstance() {
 202         return INSTANCE;
 203     }
 204
 205     @Override
 206     public NormalizedNodeContext getModules(final UriInfo uriInfo) {
 207         final Set<Module> allModules = this.controllerContext.getAllModules();
 208         final MapNode allModuleMap = makeModuleMapNode(allModules);
 209
 210         final SchemaContext schemaContext = this.controllerContext.getGlobalSchema();
 211
 212         final Module restconfModule = getRestconfModule();
 213         final DataSchemaNode modulesSchemaNode = this.controllerContext.getRestconfModuleRestConfSchemaNode(
 214                 restconfModule, Draft02.RestConfModule.MODULES_CONTAINER_SCHEMA_NODE);
 215         Preconditions.checkState(modulesSchemaNode instanceof ContainerSchemaNode);
 216
 217         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> moduleContainerBuilder =
 218                 Builders.containerBuilder((ContainerSchemaNode) modulesSchemaNode);
 219         moduleContainerBuilder.withChild(allModuleMap);
 220
 221         return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, modulesSchemaNode, null, schemaContext),
 222                 moduleContainerBuilder.build(), QueryParametersParser.parseWriterParameters(uriInfo));
 223     }
 224
 225     /**
 226      * Valid only for mount point.
 227      */
 228     @Override
 229     public NormalizedNodeContext getModules(final String identifier, final UriInfo uriInfo) {
 230         Preconditions.checkNotNull(identifier);
 231         if (!identifier.contains(ControllerContext.MOUNT)) {
 232             final String errMsg = "URI has bad format. If modules behind mount point should be showed,"
 233                     + " URI has to end with " + ControllerContext.MOUNT;
 234             LOG.debug(errMsg + " for " + identifier);
 235             throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 236         }
 237
 238         final InstanceIdentifierContext<?> mountPointIdentifier =
 239                 this.controllerContext.toMountPointIdentifier(identifier);
 240         final DOMMountPoint mountPoint = mountPointIdentifier.getMountPoint();
 241         final Set<Module> modules = this.controllerContext.getAllModules(mountPoint);
 242         final MapNode mountPointModulesMap = makeModuleMapNode(modules);
 243
 244         final Module restconfModule = getRestconfModule();
 245         final DataSchemaNode modulesSchemaNode = this.controllerContext.getRestconfModuleRestConfSchemaNode(
 246                 restconfModule, Draft02.RestConfModule.MODULES_CONTAINER_SCHEMA_NODE);
 247         Preconditions.checkState(modulesSchemaNode instanceof ContainerSchemaNode);
 248
 249         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> moduleContainerBuilder =
 250                 Builders.containerBuilder((ContainerSchemaNode) modulesSchemaNode);
 251         moduleContainerBuilder.withChild(mountPointModulesMap);
 252
 253         return new NormalizedNodeContext(
 254                 new InstanceIdentifierContext<>(null, modulesSchemaNode, mountPoint,
 255                         this.controllerContext.getGlobalSchema()),
 256                 moduleContainerBuilder.build(), QueryParametersParser.parseWriterParameters(uriInfo));
 257     }
 258
 259     @Override
 260     public NormalizedNodeContext getModule(final String identifier, final UriInfo uriInfo) {
 261         Preconditions.checkNotNull(identifier);
 262         final QName moduleNameAndRevision = getModuleNameAndRevision(identifier);
 263         Module module = null;
 264         DOMMountPoint mountPoint = null;
 265         final SchemaContext schemaContext;
 266         if (identifier.contains(ControllerContext.MOUNT)) {
 267             final InstanceIdentifierContext<?> mountPointIdentifier =
 268                     this.controllerContext.toMountPointIdentifier(identifier);
 269             mountPoint = mountPointIdentifier.getMountPoint();
 270             module = this.controllerContext.findModuleByNameAndRevision(mountPoint, moduleNameAndRevision);
 271             schemaContext = mountPoint.getSchemaContext();
 272         } else {
 273             module = this.controllerContext.findModuleByNameAndRevision(moduleNameAndRevision);
 274             schemaContext = this.controllerContext.getGlobalSchema();
 275         }
 276
 277         if (module == null) {
 278             final String errMsg = "Module with name '" + moduleNameAndRevision.getLocalName() + "' and revision '"
 279                     + moduleNameAndRevision.getRevision() + "' was not found.";
 280             LOG.debug(errMsg);
 281             throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT);
 282         }
 283
 284         final Module restconfModule = getRestconfModule();
 285         final Set<Module> modules = Collections.singleton(module);
 286         final MapNode moduleMap = makeModuleMapNode(modules);
 287
 288         final DataSchemaNode moduleSchemaNode = this.controllerContext
 289                 .getRestconfModuleRestConfSchemaNode(restconfModule, Draft02.RestConfModule.MODULE_LIST_SCHEMA_NODE);
 290         Preconditions.checkState(moduleSchemaNode instanceof ListSchemaNode);
 291
 292         return new NormalizedNodeContext(
 293                 new InstanceIdentifierContext<>(null, moduleSchemaNode, mountPoint, schemaContext), moduleMap,
 294                 QueryParametersParser.parseWriterParameters(uriInfo));
 295     }
 296
 297     @Override
 298     public NormalizedNodeContext getAvailableStreams(final UriInfo uriInfo) {
 299         final SchemaContext schemaContext = this.controllerContext.getGlobalSchema();
 300         final Set<String> availableStreams = Notificator.getStreamNames();
 301         final Module restconfModule = getRestconfModule();
 302         final DataSchemaNode streamSchemaNode = this.controllerContext
 303                 .getRestconfModuleRestConfSchemaNode(restconfModule, Draft02.RestConfModule.STREAM_LIST_SCHEMA_NODE);
 304         Preconditions.checkState(streamSchemaNode instanceof ListSchemaNode);
 305
 306         final CollectionNodeBuilder<MapEntryNode, MapNode> listStreamsBuilder =
 307                 Builders.mapBuilder((ListSchemaNode) streamSchemaNode);
 308
 309         for (final String streamName : availableStreams) {
 310             listStreamsBuilder.withChild(toStreamEntryNode(streamName, streamSchemaNode));
 311         }
 312
 313         final DataSchemaNode streamsContainerSchemaNode = this.controllerContext.getRestconfModuleRestConfSchemaNode(
 314                 restconfModule, Draft02.RestConfModule.STREAMS_CONTAINER_SCHEMA_NODE);
 315         Preconditions.checkState(streamsContainerSchemaNode instanceof ContainerSchemaNode);
 316
 317         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> streamsContainerBuilder =
 318                 Builders.containerBuilder((ContainerSchemaNode) streamsContainerSchemaNode);
 319         streamsContainerBuilder.withChild(listStreamsBuilder.build());
 320
 321         return new NormalizedNodeContext(
 322                 new InstanceIdentifierContext<>(null, streamsContainerSchemaNode, null, schemaContext),
 323                 streamsContainerBuilder.build(), QueryParametersParser.parseWriterParameters(uriInfo));
 324     }
 325
 326     @Override
 327     public NormalizedNodeContext getOperations(final UriInfo uriInfo) {
 328         final Set<Module> allModules = this.controllerContext.getAllModules();
 329         return operationsFromModulesToNormalizedContext(allModules, null);
 330     }
 331
 332     @Override
 333     public NormalizedNodeContext getOperations(final String identifier, final UriInfo uriInfo) {
 334         Set<Module> modules = null;
 335         DOMMountPoint mountPoint = null;
 336         if (identifier.contains(ControllerContext.MOUNT)) {
 337             final InstanceIdentifierContext<?> mountPointIdentifier =
 338                     this.controllerContext.toMountPointIdentifier(identifier);
 339             mountPoint = mountPointIdentifier.getMountPoint();
 340             modules = this.controllerContext.getAllModules(mountPoint);
 341
 342         } else {
 343             final String errMsg =
 344                     "URI has bad format. If operations behind mount point should be showed, URI has to " + "end with ";
 345             LOG.debug(errMsg + ControllerContext.MOUNT + " for " + identifier);
 346             throw new RestconfDocumentedException(errMsg + ControllerContext.MOUNT, ErrorType.PROTOCOL,
 347                     ErrorTag.INVALID_VALUE);
 348         }
 349
 350         return operationsFromModulesToNormalizedContext(modules, mountPoint);
 351     }
 352
 353     /**
 354      * Special case only for GET restconf/operations use (since moment of
 355      * pre-Beryllium Yang parser and Yang model API removal). The method is
 356      * creating fake schema context with fake module and fake data by use own
 357      * implementations of schema nodes and module.
 358      *
 359      * @param modules
 360      *            set of modules for get RPCs from every module
 361      * @param mountPoint
 362      *            mount point, if in use otherwise null
 363      * @return {@link NormalizedNodeContext}
 364      */
 365     private static NormalizedNodeContext operationsFromModulesToNormalizedContext(final Set<Module> modules,
 366             final DOMMountPoint mountPoint) {
 367
 368         final Collection<Module> neededModules = new ArrayList<>(modules.size());
 369         final ArrayList<LeafSchemaNode> fakeRpcSchema = new ArrayList<>();
 370
 371         for (final Module m : modules) {
 372             final Set<RpcDefinition> rpcs = m.getRpcs();
 373             if (!rpcs.isEmpty()) {
 374                 neededModules.add(m);
 375
 376                 fakeRpcSchema.ensureCapacity(fakeRpcSchema.size() + rpcs.size());
 377                 rpcs.forEach(rpc -> fakeRpcSchema.add(new FakeLeafSchemaNode(rpc.getQName())));
 378             }
 379         }
 380
 381         final ContainerSchemaNode fakeCont = new FakeContainerSchemaNode(fakeRpcSchema);
 382         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> containerBuilder =
 383                 Builders.containerBuilder(fakeCont);
 384
 385         for (final LeafSchemaNode leaf : fakeRpcSchema) {
 386             containerBuilder.withChild(Builders.leafBuilder(leaf).build());
 387         }
 388
 389         final Collection<Module> fakeModules = new ArrayList<>(neededModules.size() + 1);
 390         neededModules.forEach(imp -> fakeModules.add(new FakeImportedModule(imp)));
 391         fakeModules.add(new FakeRestconfModule(neededModules, fakeCont));
 392
 393         final SchemaContext fakeSchemaCtx = SimpleSchemaContext.forModules(ImmutableSet.copyOf(fakeModules));
 394         final InstanceIdentifierContext<ContainerSchemaNode> instanceIdentifierContext =
 395                 new InstanceIdentifierContext<>(null, fakeCont, mountPoint, fakeSchemaCtx);
 396         return new NormalizedNodeContext(instanceIdentifierContext, containerBuilder.build());
 397     }
 398
 399     private Module getRestconfModule() {
 400         final Module restconfModule = this.controllerContext.getRestconfModule();
 401         if (restconfModule == null) {
 402             LOG.debug("ietf-restconf module was not found.");
 403             throw new RestconfDocumentedException("ietf-restconf module was not found.", ErrorType.APPLICATION,
 404                     ErrorTag.OPERATION_NOT_SUPPORTED);
 405         }
 406
 407         return restconfModule;
 408     }
 409
 410     private static QName getModuleNameAndRevision(final String identifier) {
 411         final int mountIndex = identifier.indexOf(ControllerContext.MOUNT);
 412         String moduleNameAndRevision = "";
 413         if (mountIndex >= 0) {
 414             moduleNameAndRevision = identifier.substring(mountIndex + ControllerContext.MOUNT.length());
 415         } else {
 416             moduleNameAndRevision = identifier;
 417         }
 418
 419         final Splitter splitter = Splitter.on("/").omitEmptyStrings();
 420         final Iterable<String> split = splitter.split(moduleNameAndRevision);
 421         final List<String> pathArgs = Lists.<String>newArrayList(split);
 422         if (pathArgs.size() < 2) {
 423             LOG.debug("URI has bad format. It should be \'moduleName/yyyy-MM-dd\' " + identifier);
 424             throw new RestconfDocumentedException(
 425                     "URI has bad format. End of URI should be in format \'moduleName/yyyy-MM-dd\'", ErrorType.PROTOCOL,
 426                     ErrorTag.INVALID_VALUE);
 427         }
 428
 429         try {
 430             final String moduleName = pathArgs.get(0);
 431             final String revision = pathArgs.get(1);
 432             return QName.create(null, SimpleDateFormatUtil.getRevisionFormat().parse(revision), moduleName);
 433         } catch (final ParseException e) {
 434             LOG.debug("URI has bad format. It should be \'moduleName/yyyy-MM-dd\' " + identifier);
 435             throw new RestconfDocumentedException("URI has bad format. It should be \'moduleName/yyyy-MM-dd\'",
 436                     ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 437         }
 438     }
 439
 440     @Override
 441     public Object getRoot() {
 442         return null;
 443     }
 444
 445     @Override
 446     public NormalizedNodeContext invokeRpc(final String identifier, final NormalizedNodeContext payload,
 447             final UriInfo uriInfo) {
 448         final SchemaPath type = payload.getInstanceIdentifierContext().getSchemaNode().getPath();
 449         final URI namespace = payload.getInstanceIdentifierContext().getSchemaNode().getQName().getNamespace();
 450         final CheckedFuture<DOMRpcResult, DOMRpcException> response;
 451         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
 452         final SchemaContext schemaContext;
 453
 454         if (mountPoint != null) {
 455             final Optional<DOMRpcService> mountRpcServices = mountPoint.getService(DOMRpcService.class);
 456             if (!mountRpcServices.isPresent()) {
 457                 LOG.debug("Error: Rpc service is missing.");
 458                 throw new RestconfDocumentedException("Rpc service is missing.");
 459             }
 460             schemaContext = mountPoint.getSchemaContext();
 461             response = mountRpcServices.get().invokeRpc(type, payload.getData());
 462         } else {
 463             if (namespace.toString().equals(SAL_REMOTE_NAMESPACE)) {
 464                 if (identifier.contains(CREATE_DATA_SUBSCR)) {
 465                     response = invokeSalRemoteRpcSubscribeRPC(payload);
 466                 } else if (identifier.contains(CREATE_NOTIFICATION_STREAM)) {
 467                     response = invokeSalRemoteRpcNotifiStrRPC(payload);
 468                 } else {
 469                     final String msg = "Not supported operation";
 470                     LOG.warn(msg);
 471                     throw new RestconfDocumentedException(msg, ErrorType.RPC, ErrorTag.OPERATION_NOT_SUPPORTED);
 472                 }
 473             } else {
 474                 response = this.broker.invokeRpc(type, payload.getData());
 475             }
 476             schemaContext = this.controllerContext.getGlobalSchema();
 477         }
 478
 479         final DOMRpcResult result = checkRpcResponse(response);
 480
 481         RpcDefinition resultNodeSchema = null;
 482         final NormalizedNode<?, ?> resultData = result.getResult();
 483         if (result != null && result.getResult() != null) {
 484             resultNodeSchema = (RpcDefinition) payload.getInstanceIdentifierContext().getSchemaNode();
 485         }
 486
 487         return new NormalizedNodeContext(
 488                 new InstanceIdentifierContext<>(null, resultNodeSchema, mountPoint, schemaContext),
 489                 resultData, QueryParametersParser.parseWriterParameters(uriInfo));
 490     }
 491
 492     @Override
 493     public NormalizedNodeContext invokeRpc(final String identifier, final String noPayload, final UriInfo uriInfo) {
 494         if (noPayload != null && !CharMatcher.WHITESPACE.matchesAllOf(noPayload)) {
 495             throw new RestconfDocumentedException("Content must be empty.", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 496         }
 497
 498         String identifierEncoded = null;
 499         DOMMountPoint mountPoint = null;
 500         final SchemaContext schemaContext;
 501         if (identifier.contains(ControllerContext.MOUNT)) {
 502             // mounted RPC call - look up mount instance.
 503             final InstanceIdentifierContext<?> mountPointId = this.controllerContext.toMountPointIdentifier(identifier);
 504             mountPoint = mountPointId.getMountPoint();
 505             schemaContext = mountPoint.getSchemaContext();
 506             final int startOfRemoteRpcName =
 507                     identifier.lastIndexOf(ControllerContext.MOUNT) + ControllerContext.MOUNT.length() + 1;
 508             final String remoteRpcName = identifier.substring(startOfRemoteRpcName);
 509             identifierEncoded = remoteRpcName;
 510
 511         } else if (identifier.indexOf("/") != CHAR_NOT_FOUND) {
 512             final String slashErrorMsg = String.format(
 513                     "Identifier %n%s%ncan\'t contain slash "
 514                             + "character (/).%nIf slash is part of identifier name then use %%2F placeholder.",
 515                     identifier);
 516             LOG.debug(slashErrorMsg);
 517             throw new RestconfDocumentedException(slashErrorMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 518         } else {
 519             identifierEncoded = identifier;
 520             schemaContext = this.controllerContext.getGlobalSchema();
 521         }
 522
 523         final String identifierDecoded = this.controllerContext.urlPathArgDecode(identifierEncoded);
 524
 525         RpcDefinition rpc = null;
 526         if (mountPoint == null) {
 527             rpc = this.controllerContext.getRpcDefinition(identifierDecoded, null);
 528         } else {
 529             rpc = findRpc(mountPoint.getSchemaContext(), identifierDecoded);
 530         }
 531
 532         if (rpc == null) {
 533             LOG.debug("RPC " + identifierDecoded + " does not exist.");
 534             throw new RestconfDocumentedException("RPC does not exist.", ErrorType.RPC, ErrorTag.UNKNOWN_ELEMENT);
 535         }
 536
 537         if (!rpc.getInput().getChildNodes().isEmpty()) {
 538             LOG.debug("RPC " + rpc + " does not need input value.");
 539             // FIXME : find a correct Error from specification
 540             throw new IllegalStateException("RPC " + rpc + " does'n need input value!");
 541         }
 542
 543         final CheckedFuture<DOMRpcResult, DOMRpcException> response;
 544         if (mountPoint != null) {
 545             final Optional<DOMRpcService> mountRpcServices = mountPoint.getService(DOMRpcService.class);
 546             if (!mountRpcServices.isPresent()) {
 547                 throw new RestconfDocumentedException("Rpc service is missing.");
 548             }
 549             response = mountRpcServices.get().invokeRpc(rpc.getPath(), null);
 550         } else {
 551             response = this.broker.invokeRpc(rpc.getPath(), null);
 552         }
 553
 554         final DOMRpcResult result = checkRpcResponse(response);
 555
 556         return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, rpc, mountPoint, schemaContext),
 557                 result.getResult(), QueryParametersParser.parseWriterParameters(uriInfo));
 558     }
 559
 560     private static DOMRpcResult checkRpcResponse(final CheckedFuture<DOMRpcResult, DOMRpcException> response) {
 561         if (response == null) {
 562             return null;
 563         }
 564         try {
 565             final DOMRpcResult retValue = response.get();
 566             if (retValue.getErrors() == null || retValue.getErrors().isEmpty()) {
 567                 return retValue;
 568             }
 569             LOG.debug("RpcError message", retValue.getErrors());
 570             throw new RestconfDocumentedException("RpcError message", null, retValue.getErrors());
 571         } catch (final InterruptedException e) {
 572             final String errMsg = "The operation was interrupted while executing and did not complete.";
 573             LOG.debug("Rpc Interrupt - " + errMsg, e);
 574             throw new RestconfDocumentedException(errMsg, ErrorType.RPC, ErrorTag.PARTIAL_OPERATION);
 575         } catch (final ExecutionException e) {
 576             LOG.debug("Execution RpcError: ", e);
 577             Throwable cause = e.getCause();
 578             if (cause != null) {
 579                 while (cause.getCause() != null) {
 580                     cause = cause.getCause();
 581                 }
 582
 583                 if (cause instanceof IllegalArgumentException) {
 584                     throw new RestconfDocumentedException(cause.getMessage(), ErrorType.PROTOCOL,
 585                             ErrorTag.INVALID_VALUE);
 586                 } else if (cause instanceof DOMRpcImplementationNotAvailableException) {
 587                     throw new RestconfDocumentedException(cause.getMessage(), ErrorType.APPLICATION,
 588                             ErrorTag.OPERATION_NOT_SUPPORTED);
 589                 }
 590                 throw new RestconfDocumentedException("The operation encountered an unexpected error while executing.",
 591                         cause);
 592             } else {
 593                 throw new RestconfDocumentedException("The operation encountered an unexpected error while executing.",
 594                         e);
 595             }
 596         } catch (final CancellationException e) {
 597             final String errMsg = "The operation was cancelled while executing.";
 598             LOG.debug("Cancel RpcExecution: " + errMsg, e);
 599             throw new RestconfDocumentedException(errMsg, ErrorType.RPC, ErrorTag.PARTIAL_OPERATION);
 600         }
 601     }
 602
 603     private static void validateInput(final SchemaNode inputSchema, final NormalizedNodeContext payload) {
 604         if (inputSchema != null && payload.getData() == null) {
 605             // expected a non null payload
 606             throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 607         } else if (inputSchema == null && payload.getData() != null) {
 608             // did not expect any input
 609             throw new RestconfDocumentedException("No input expected.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 610         }
 611     }
 612
 613     private CheckedFuture<DOMRpcResult, DOMRpcException>
 614             invokeSalRemoteRpcSubscribeRPC(final NormalizedNodeContext payload) {
 615         final ContainerNode value = (ContainerNode) payload.getData();
 616         final QName rpcQName = payload.getInstanceIdentifierContext().getSchemaNode().getQName();
 617         final Optional<DataContainerChild<? extends PathArgument, ?>> path = value.getChild(new NodeIdentifier(
 618                 QName.create(payload.getInstanceIdentifierContext().getSchemaNode().getQName(), "path")));
 619         final Object pathValue = path.isPresent() ? path.get().getValue() : null;
 620
 621         if (!(pathValue instanceof YangInstanceIdentifier)) {
 622             final String errMsg = "Instance identifier was not normalized correctly ";
 623             LOG.debug(errMsg + rpcQName);
 624             throw new RestconfDocumentedException(errMsg, ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED);
 625         }
 626
 627         final YangInstanceIdentifier pathIdentifier = (YangInstanceIdentifier) pathValue;
 628         String streamName = (String) CREATE_DATA_SUBSCR;
 629         NotificationOutputType outputType = null;
 630         if (!pathIdentifier.isEmpty()) {
 631             final String fullRestconfIdentifier =
 632                     DATA_SUBSCR + this.controllerContext.toFullRestconfIdentifier(pathIdentifier, null);
 633
 634             LogicalDatastoreType datastore =
 635                     parseEnumTypeParameter(value, LogicalDatastoreType.class, DATASTORE_PARAM_NAME);
 636             datastore = datastore == null ? DEFAULT_DATASTORE : datastore;
 637
 638             DataChangeScope scope = parseEnumTypeParameter(value, DataChangeScope.class, SCOPE_PARAM_NAME);
 639             scope = scope == null ? DEFAULT_SCOPE : scope;
 640
 641             outputType = parseEnumTypeParameter(value, NotificationOutputType.class, OUTPUT_TYPE_PARAM_NAME);
 642             outputType = outputType == null ? NotificationOutputType.XML : outputType;
 643
 644             streamName = Notificator
 645                     .createStreamNameFromUri(fullRestconfIdentifier + "/datastore=" + datastore + "/scope=" + scope);
 646         }
 647
 648         if (Strings.isNullOrEmpty(streamName)) {
 649             final String errMsg = "Path is empty or contains value node which is not Container or List build-in type.";
 650             LOG.debug(errMsg + pathIdentifier);
 651             throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 652         }
 653
 654         final QName outputQname = QName.create(rpcQName, "output");
 655         final QName streamNameQname = QName.create(rpcQName, "stream-name");
 656
 657         final ContainerNode output =
 658                 ImmutableContainerNodeBuilder.create().withNodeIdentifier(new NodeIdentifier(outputQname))
 659                         .withChild(ImmutableNodes.leafNode(streamNameQname, streamName)).build();
 660
 661         if (!Notificator.existListenerFor(streamName)) {
 662             Notificator.createListener(pathIdentifier, streamName, outputType);
 663         }
 664
 665         final DOMRpcResult defaultDOMRpcResult = new DefaultDOMRpcResult(output);
 666
 667         return Futures.immediateCheckedFuture(defaultDOMRpcResult);
 668     }
 669
 670     private static RpcDefinition findRpc(final SchemaContext schemaContext, final String identifierDecoded) {
 671         final String[] splittedIdentifier = identifierDecoded.split(":");
 672         if (splittedIdentifier.length != 2) {
 673             final String errMsg = identifierDecoded + " couldn't be splitted to 2 parts (module:rpc name)";
 674             LOG.debug(errMsg);
 675             throw new RestconfDocumentedException(errMsg, ErrorType.APPLICATION, ErrorTag.INVALID_VALUE);
 676         }
 677         for (final Module module : schemaContext.getModules()) {
 678             if (module.getName().equals(splittedIdentifier[0])) {
 679                 for (final RpcDefinition rpcDefinition : module.getRpcs()) {
 680                     if (rpcDefinition.getQName().getLocalName().equals(splittedIdentifier[1])) {
 681                         return rpcDefinition;
 682                     }
 683                 }
 684             }
 685         }
 686         return null;
 687     }
 688
 689     @Override
 690     public NormalizedNodeContext readConfigurationData(final String identifier, final UriInfo uriInfo) {
 691         boolean withDefaUsed = false;
 692         String withDefa = null;
 693
 694         for (final Entry<String, List<String>> entry : uriInfo.getQueryParameters().entrySet()) {
 695             switch (entry.getKey()) {
 696                 case "with-defaults":
 697                     if (!withDefaUsed) {
 698                         withDefaUsed = true;
 699                         withDefa = entry.getValue().iterator().next();
 700                     } else {
 701                         throw new RestconfDocumentedException("With-defaults parameter can be used only once.");
 702                     }
 703                     break;
 704                 default:
 705                     LOG.info("Unknown key : {}.", entry.getKey());
 706                     break;
 707             }
 708         }
 709         boolean tagged = false;
 710         if (withDefaUsed) {
 711             if (withDefa.equals("report-all-tagged")) {
 712                 tagged = true;
 713                 withDefa = null;
 714             }
 715             if (withDefa.equals("report-all")) {
 716                 withDefa = null;
 717             }
 718         }
 719
 720         final InstanceIdentifierContext<?> iiWithData = this.controllerContext.toInstanceIdentifier(identifier);
 721         final DOMMountPoint mountPoint = iiWithData.getMountPoint();
 722         NormalizedNode<?, ?> data = null;
 723         final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
 724         if (mountPoint != null) {
 725             data = this.broker.readConfigurationData(mountPoint, normalizedII, withDefa);
 726         } else {
 727             data = this.broker.readConfigurationData(normalizedII, withDefa);
 728         }
 729         if (data == null) {
 730             final String errMsg =
 731                     "Request could not be completed because the relevant data model content does not exist ";
 732             LOG.debug(errMsg + identifier);
 733             throw new RestconfDocumentedException(errMsg, ErrorType.APPLICATION, ErrorTag.DATA_MISSING);
 734         }
 735         return new NormalizedNodeContext(iiWithData, data,
 736                 QueryParametersParser.parseWriterParameters(uriInfo, tagged));
 737     }
 738
 739     @Override
 740     public NormalizedNodeContext readOperationalData(final String identifier, final UriInfo uriInfo) {
 741         final InstanceIdentifierContext<?> iiWithData = this.controllerContext.toInstanceIdentifier(identifier);
 742         final DOMMountPoint mountPoint = iiWithData.getMountPoint();
 743         NormalizedNode<?, ?> data = null;
 744         final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
 745         if (mountPoint != null) {
 746             data = this.broker.readOperationalData(mountPoint, normalizedII);
 747         } else {
 748             data = this.broker.readOperationalData(normalizedII);
 749         }
 750         if (data == null) {
 751             final String errMsg =
 752                     "Request could not be completed because the relevant data model content does not exist ";
 753             LOG.debug(errMsg + identifier);
 754             throw new RestconfDocumentedException(errMsg, ErrorType.APPLICATION, ErrorTag.DATA_MISSING);
 755         }
 756         return new NormalizedNodeContext(iiWithData, data, QueryParametersParser.parseWriterParameters(uriInfo));
 757     }
 758
 759     @Override
 760     public Response updateConfigurationData(final String identifier, final NormalizedNodeContext payload,
 761             final UriInfo uriInfo) {
 762         boolean insertUsed = false;
 763         boolean pointUsed = false;
 764         String insert = null;
 765         String point = null;
 766
 767         for (final Entry<String, List<String>> entry : uriInfo.getQueryParameters().entrySet()) {
 768             switch (entry.getKey()) {
 769                 case "insert":
 770                     if (!insertUsed) {
 771                         insertUsed = true;
 772                         insert = entry.getValue().iterator().next();
 773                     } else {
 774                         throw new RestconfDocumentedException("Insert parameter can be used only once.");
 775                     }
 776                     break;
 777                 case "point":
 778                     if (!pointUsed) {
 779                         pointUsed = true;
 780                         point = entry.getValue().iterator().next();
 781                     } else {
 782                         throw new RestconfDocumentedException("Point parameter can be used only once.");
 783                     }
 784                     break;
 785                 default:
 786                     throw new RestconfDocumentedException("Bad parameter for post: " + entry.getKey());
 787             }
 788         }
 789
 790         if (pointUsed && !insertUsed) {
 791             throw new RestconfDocumentedException("Point parameter can't be used without Insert parameter.");
 792         }
 793         if (pointUsed && (insert.equals("first") || insert.equals("last"))) {
 794             throw new RestconfDocumentedException(
 795                     "Point parameter can be used only with 'after' or 'before' values of Insert parameter.");
 796         }
 797
 798         Preconditions.checkNotNull(identifier);
 799
 800         final InstanceIdentifierContext<?> iiWithData = payload.getInstanceIdentifierContext();
 801
 802         validateInput(iiWithData.getSchemaNode(), payload);
 803         validateTopLevelNodeName(payload, iiWithData.getInstanceIdentifier());
 804         validateListKeysEqualityInPayloadAndUri(payload);
 805
 806         final DOMMountPoint mountPoint = iiWithData.getMountPoint();
 807         final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
 808
 809         /*
 810          * There is a small window where another write transaction could be
 811          * updating the same data simultaneously and we get an
 812          * OptimisticLockFailedException. This error is likely transient and The
 813          * WriteTransaction#submit API docs state that a retry will likely
 814          * succeed. So we'll try again if that scenario occurs. If it fails a
 815          * third time then it probably will never succeed so we'll fail in that
 816          * case.
 817          *
 818          * By retrying we're attempting to hide the internal implementation of
 819          * the data store and how it handles concurrent updates from the
 820          * restconf client. The client has instructed us to put the data and we
 821          * should make every effort to do so without pushing optimistic lock
 822          * failures back to the client and forcing them to handle it via retry
 823          * (and having to document the behavior).
 824          */
 825         PutResult result = null;
 826         int tries = 2;
 827         while (true) {
 828             if (mountPoint != null) {
 829
 830                 result = this.broker.commitMountPointDataPut(mountPoint, normalizedII, payload.getData(), insert,
 831                         point);
 832             } else {
 833                 result = this.broker.commitConfigurationDataPut(this.controllerContext.getGlobalSchema(), normalizedII,
 834                         payload.getData(), insert, point);
 835             }
 836
 837             try {
 838                 result.getFutureOfPutData().checkedGet();
 839                 return Response.status(result.getStatus()).build();
 840             } catch (final TransactionCommitFailedException e) {
 841                 if (e instanceof OptimisticLockFailedException) {
 842                     if (--tries <= 0) {
 843                         LOG.debug("Got OptimisticLockFailedException on last try - failing " + identifier);
 844                         throw new RestconfDocumentedException(e.getMessage(), e, e.getErrorList());
 845                     }
 846
 847                     LOG.debug("Got OptimisticLockFailedException - trying again " + identifier);
 848                 } else {
 849                     LOG.debug("Update failed for " + identifier, e);
 850                     throw new RestconfDocumentedException(e.getMessage(), e, e.getErrorList());
 851                 }
 852             }
 853         }
 854     }
 855
 856     private static void validateTopLevelNodeName(final NormalizedNodeContext node,
 857             final YangInstanceIdentifier identifier) {
 858
 859         final String payloadName = node.getData().getNodeType().getLocalName();
 860
 861         // no arguments
 862         if (identifier.isEmpty()) {
 863             // no "data" payload
 864             if (!node.getData().getNodeType().equals(NETCONF_BASE_QNAME)) {
 865                 throw new RestconfDocumentedException("Instance identifier has to contain at least one path argument",
 866                         ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 867             }
 868             // any arguments
 869         } else {
 870             final String identifierName = identifier.getLastPathArgument().getNodeType().getLocalName();
 871             if (!payloadName.equals(identifierName)) {
 872                 throw new RestconfDocumentedException(
 873                         "Payload name (" + payloadName + ") is different from identifier name (" + identifierName + ")",
 874                         ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 875             }
 876         }
 877     }
 878
 879     /**
 880      * Validates whether keys in {@code payload} are equal to values of keys in
 881      * {@code iiWithData} for list schema node.
 882      *
 883      * @throws RestconfDocumentedException
 884      *             if key values or key count in payload and URI isn't equal
 885      *
 886      */
 887     private static void validateListKeysEqualityInPayloadAndUri(final NormalizedNodeContext payload) {
 888         Preconditions.checkArgument(payload != null);
 889         final InstanceIdentifierContext<?> iiWithData = payload.getInstanceIdentifierContext();
 890         final PathArgument lastPathArgument = iiWithData.getInstanceIdentifier().getLastPathArgument();
 891         final SchemaNode schemaNode = iiWithData.getSchemaNode();
 892         final NormalizedNode<?, ?> data = payload.getData();
 893         if (schemaNode instanceof ListSchemaNode) {
 894             final List<QName> keyDefinitions = ((ListSchemaNode) schemaNode).getKeyDefinition();
 895             if (lastPathArgument instanceof NodeIdentifierWithPredicates && data instanceof MapEntryNode) {
 896                 final Map<QName, Object> uriKeyValues =
 897                         ((NodeIdentifierWithPredicates) lastPathArgument).getKeyValues();
 898                 isEqualUriAndPayloadKeyValues(uriKeyValues, (MapEntryNode) data, keyDefinitions);
 899             }
 900         }
 901     }
 902
 903     @VisibleForTesting
 904     public static void isEqualUriAndPayloadKeyValues(final Map<QName, Object> uriKeyValues, final MapEntryNode payload,
 905             final List<QName> keyDefinitions) {
 906
 907         final Map<QName, Object> mutableCopyUriKeyValues = Maps.newHashMap(uriKeyValues);
 908         for (final QName keyDefinition : keyDefinitions) {
 909             final Object uriKeyValue = mutableCopyUriKeyValues.remove(keyDefinition);
 910             // should be caught during parsing URI to InstanceIdentifier
 911             RestconfValidationUtils.checkDocumentedError(uriKeyValue != null, ErrorType.PROTOCOL, ErrorTag.DATA_MISSING,
 912                     "Missing key " + keyDefinition + " in URI.");
 913
 914             final Object dataKeyValue = payload.getIdentifier().getKeyValues().get(keyDefinition);
 915
 916             if (!Objects.deepEquals(uriKeyValue, dataKeyValue)) {
 917                 final String errMsg = "The value '" + uriKeyValue + "' for key '" + keyDefinition.getLocalName()
 918                         + "' specified in the URI doesn't match the value '" + dataKeyValue
 919                         + "' specified in the message body. ";
 920                 throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 921             }
 922         }
 923     }
 924
 925     @Override
 926     public Response createConfigurationData(final String identifier, final NormalizedNodeContext payload,
 927             final UriInfo uriInfo) {
 928         return createConfigurationData(payload, uriInfo);
 929     }
 930
 931     @Override
 932     public Response createConfigurationData(final NormalizedNodeContext payload, final UriInfo uriInfo) {
 933         if (payload == null) {
 934             throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 935         }
 936         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
 937         final InstanceIdentifierContext<?> iiWithData = payload.getInstanceIdentifierContext();
 938         final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
 939
 940         boolean insertUsed = false;
 941         boolean pointUsed = false;
 942         String insert = null;
 943         String point = null;
 944
 945         for (final Entry<String, List<String>> entry : uriInfo.getQueryParameters().entrySet()) {
 946             switch (entry.getKey()) {
 947                 case "insert":
 948                     if (!insertUsed) {
 949                         insertUsed = true;
 950                         insert = entry.getValue().iterator().next();
 951                     } else {
 952                         throw new RestconfDocumentedException("Insert parameter can be used only once.");
 953                     }
 954                     break;
 955                 case "point":
 956                     if (!pointUsed) {
 957                         pointUsed = true;
 958                         point = entry.getValue().iterator().next();
 959                     } else {
 960                         throw new RestconfDocumentedException("Point parameter can be used only once.");
 961                     }
 962                     break;
 963                 default:
 964                     throw new RestconfDocumentedException("Bad parameter for post: " + entry.getKey());
 965             }
 966         }
 967
 968         if (pointUsed && !insertUsed) {
 969             throw new RestconfDocumentedException("Point parameter can't be used without Insert parameter.");
 970         }
 971         if (pointUsed && (insert.equals("first") || insert.equals("last"))) {
 972             throw new RestconfDocumentedException(
 973                     "Point parameter can be used only with 'after' or 'before' values of Insert parameter.");
 974         }
 975
 976         CheckedFuture<Void, TransactionCommitFailedException> future;
 977         if (mountPoint != null) {
 978             future = this.broker.commitConfigurationDataPost(mountPoint, normalizedII, payload.getData(), insert,
 979                     point);
 980         } else {
 981             future = this.broker.commitConfigurationDataPost(this.controllerContext.getGlobalSchema(), normalizedII,
 982                     payload.getData(), insert, point);
 983         }
 984
 985         try {
 986             future.checkedGet();
 987         } catch (final RestconfDocumentedException e) {
 988             throw e;
 989         } catch (final TransactionCommitFailedException e) {
 990             LOG.info("Error creating data " + (uriInfo != null ? uriInfo.getPath() : ""), e);
 991             throw new RestconfDocumentedException(e.getMessage(), e, e.getErrorList());
 992         }
 993
 994         LOG.trace("Successfuly created data.");
 995
 996         final ResponseBuilder responseBuilder = Response.status(Status.NO_CONTENT);
 997         // FIXME: Provide path to result.
 998         final URI location = resolveLocation(uriInfo, "", mountPoint, normalizedII);
 999         if (location != null) {
1000             responseBuilder.location(location);
1001         }
1002         return responseBuilder.build();
1003     }
1004
1005     // FIXME create RestconfIdetifierHelper and move this method there
1006     private static YangInstanceIdentifier checkConsistencyOfNormalizedNodeContext(final NormalizedNodeContext payload) {
1007         Preconditions.checkArgument(payload != null);
1008         Preconditions.checkArgument(payload.getData() != null);
1009         Preconditions.checkArgument(payload.getData().getNodeType() != null);
1010         Preconditions.checkArgument(payload.getInstanceIdentifierContext() != null);
1011         Preconditions.checkArgument(payload.getInstanceIdentifierContext().getInstanceIdentifier() != null);
1012
1013         final QName payloadNodeQname = payload.getData().getNodeType();
1014         final YangInstanceIdentifier yangIdent = payload.getInstanceIdentifierContext().getInstanceIdentifier();
1015         if (payloadNodeQname.compareTo(yangIdent.getLastPathArgument().getNodeType()) > 0) {
1016             return yangIdent;
1017         }
1018         final InstanceIdentifierContext<?> parentContext = payload.getInstanceIdentifierContext();
1019         final SchemaNode parentSchemaNode = parentContext.getSchemaNode();
1020         if (parentSchemaNode instanceof DataNodeContainer) {
1021             final DataNodeContainer cast = (DataNodeContainer) parentSchemaNode;
1022             for (final DataSchemaNode child : cast.getChildNodes()) {
1023                 if (payloadNodeQname.compareTo(child.getQName()) == 0) {
1024                     return YangInstanceIdentifier.builder(yangIdent).node(child.getQName()).build();
1025                 }
1026             }
1027         }
1028         if (parentSchemaNode instanceof RpcDefinition) {
1029             return yangIdent;
1030         }
1031         final String errMsg = "Error parsing input: DataSchemaNode has not children ";
1032         LOG.info(errMsg + yangIdent);
1033         throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
1034     }
1035
1036     @SuppressWarnings("checkstyle:IllegalCatch")
1037     private URI resolveLocation(final UriInfo uriInfo, final String uriBehindBase, final DOMMountPoint mountPoint,
1038             final YangInstanceIdentifier normalizedII) {
1039         if (uriInfo == null) {
1040             // This is null if invoked internally
1041             return null;
1042         }
1043
1044         final UriBuilder uriBuilder = uriInfo.getBaseUriBuilder();
1045         uriBuilder.path("config");
1046         try {
1047             uriBuilder.path(this.controllerContext.toFullRestconfIdentifier(normalizedII, mountPoint));
1048         } catch (final Exception e) {
1049             LOG.info("Location for instance identifier" + normalizedII + "wasn't created", e);
1050             return null;
1051         }
1052         return uriBuilder.build();
1053     }
1054
1055     @Override
1056     public Response deleteConfigurationData(final String identifier) {
1057         final InstanceIdentifierContext<?> iiWithData = this.controllerContext.toInstanceIdentifier(identifier);
1058         final DOMMountPoint mountPoint = iiWithData.getMountPoint();
1059         final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
1060
1061         final CheckedFuture<Void, TransactionCommitFailedException> future;
1062         if (mountPoint != null) {
1063             future = this.broker.commitConfigurationDataDelete(mountPoint, normalizedII);
1064         } else {
1065             future = this.broker.commitConfigurationDataDelete(normalizedII);
1066         }
1067
1068         try {
1069             future.checkedGet();
1070         } catch (final TransactionCommitFailedException e) {
1071             final Optional<Throwable> searchedException = Iterables.tryFind(Throwables.getCausalChain(e),
1072                     Predicates.instanceOf(ModifiedNodeDoesNotExistException.class));
1073             if (searchedException.isPresent()) {
1074                 throw new RestconfDocumentedException("Data specified for delete doesn't exist.", ErrorType.APPLICATION,
1075                         ErrorTag.DATA_MISSING);
1076             }
1077
1078             final String errMsg = "Error while deleting data";
1079             LOG.info(errMsg, e);
1080             throw new RestconfDocumentedException(e.getMessage(), e, e.getErrorList());
1081         }
1082
1083         return Response.status(Status.OK).build();
1084     }
1085
1086     /**
1087      * Subscribes to some path in schema context (stream) to listen on changes
1088      * on this stream.
1089      *
1090      * <p>
1091      * Additional parameters for subscribing to stream are loaded via rpc input
1092      * parameters:
1093      * <ul>
1094      * <li>datastore - default CONFIGURATION (other values of
1095      * {@link LogicalDatastoreType} enum type)</li>
1096      * <li>scope - default BASE (other values of {@link DataChangeScope})</li>
1097      * </ul>
1098      */
1099     @Override
1100     public NormalizedNodeContext subscribeToStream(final String identifier, final UriInfo uriInfo) {
1101         boolean startTimeUsed = false;
1102         boolean stopTimeUsed = false;
1103         Instant start = Instant.now();
1104         Instant stop = null;
1105         boolean filterUsed = false;
1106         String filter = null;
1107         boolean leafNodesOnlyUsed = false;
1108         boolean leafNodesOnly = false;
1109
1110         for (final Entry<String, List<String>> entry : uriInfo.getQueryParameters().entrySet()) {
1111             switch (entry.getKey()) {
1112                 case "start-time":
1113                     if (!startTimeUsed) {
1114                         startTimeUsed = true;
1115                         start = parseDateFromQueryParam(entry);
1116                     } else {
1117                         throw new RestconfDocumentedException("Start-time parameter can be used only once.");
1118                     }
1119                     break;
1120                 case "stop-time":
1121                     if (!stopTimeUsed) {
1122                         stopTimeUsed = true;
1123                         stop = parseDateFromQueryParam(entry);
1124                     } else {
1125                         throw new RestconfDocumentedException("Stop-time parameter can be used only once.");
1126                     }
1127                     break;
1128                 case "filter":
1129                     if (!filterUsed) {
1130                         filterUsed = true;
1131                         filter = entry.getValue().iterator().next();
1132                     } else {
1133                         throw new RestconfDocumentedException("Filter parameter can be used only once.");
1134                     }
1135                     break;
1136                 case "odl-leaf-nodes-only":
1137                     if (!leafNodesOnlyUsed) {
1138                         leafNodesOnlyUsed = true;
1139                         leafNodesOnly = Boolean.parseBoolean(entry.getValue().iterator().next());
1140                     } else {
1141                         throw new RestconfDocumentedException("Odl-leaf-nodes-only parameter can be used only once.");
1142                     }
1143                     break;
1144                 default:
1145                     throw new RestconfDocumentedException("Bad parameter used with notifications: " + entry.getKey());
1146             }
1147         }
1148         if (!startTimeUsed && stopTimeUsed) {
1149             throw new RestconfDocumentedException("Stop-time parameter has to be used with start-time parameter.");
1150         }
1151         URI response = null;
1152         if (identifier.contains(DATA_SUBSCR)) {
1153             response = dataSubs(identifier, uriInfo, start, stop, filter, leafNodesOnly);
1154         } else if (identifier.contains(NOTIFICATION_STREAM)) {
1155             response = notifStream(identifier, uriInfo, start, stop, filter);
1156         }
1157
1158         if (response != null) {
1159             // prepare node with value of location
1160             final InstanceIdentifierContext<?> iid = prepareIIDSubsStreamOutput();
1161             final NormalizedNodeAttrBuilder<NodeIdentifier, Object, LeafNode<Object>> builder =
1162                     ImmutableLeafNodeBuilder.create().withValue(response.toString());
1163             builder.withNodeIdentifier(
1164                     NodeIdentifier.create(QName.create("subscribe:to:notification", "2016-10-28", "location")));
1165
1166             // prepare new header with location
1167             final Map<String, Object> headers = new HashMap<>();
1168             headers.put("Location", response);
1169
1170             return new NormalizedNodeContext(iid, builder.build(), headers);
1171         }
1172
1173         final String msg = "Bad type of notification of sal-remote";
1174         LOG.warn(msg);
1175         throw new RestconfDocumentedException(msg);
1176     }
1177
1178     private static Instant parseDateFromQueryParam(final Entry<String, List<String>> entry) {
1179         final DateAndTime event = new DateAndTime(entry.getValue().iterator().next());
1180         final String value = event.getValue();
1181         final TemporalAccessor p;
1182         try {
1183             p = FORMATTER.parse(value);
1184         } catch (final DateTimeParseException e) {
1185             throw new RestconfDocumentedException("Cannot parse of value in date: " + value, e);
1186         }
1187         return Instant.from(p);
1188     }
1189
1190     /**
1191      * Prepare instance identifier.
1192      *
1193      * @return {@link InstanceIdentifierContext} of location leaf for
1194      *         notification
1195      */
1196     private static InstanceIdentifierContext<?> prepareIIDSubsStreamOutput() {
1197         final QName qnameBase = QName.create("subscribe:to:notification", "2016-10-28", "notifi");
1198         final SchemaContext schemaCtx = ControllerContext.getInstance().getGlobalSchema();
1199         final DataSchemaNode location = ((ContainerSchemaNode) schemaCtx
1200                 .findModuleByNamespaceAndRevision(qnameBase.getNamespace(), qnameBase.getRevision())
1201                 .getDataChildByName(qnameBase)).getDataChildByName(QName.create(qnameBase, "location"));
1202         final List<PathArgument> path = new ArrayList<>();
1203         path.add(NodeIdentifier.create(qnameBase));
1204         path.add(NodeIdentifier.create(QName.create(qnameBase, "location")));
1205
1206         return new InstanceIdentifierContext<SchemaNode>(YangInstanceIdentifier.create(path), location, null,
1207                 schemaCtx);
1208     }
1209
1210     /**
1211      * Register notification listener by stream name.
1212      *
1213      * @param identifier
1214      *            stream name
1215      * @param uriInfo
1216      *            uriInfo
1217      * @param stop
1218      *            stop-time of getting notification
1219      * @param start
1220      *            start-time of getting notification
1221      * @param filter
1222      *            indicate which subset of all possible events are of interest
1223      * @return {@link URI} of location
1224      */
1225     private URI notifStream(final String identifier, final UriInfo uriInfo, final Instant start,
1226             final Instant stop, final String filter) {
1227         final String streamName = Notificator.createStreamNameFromUri(identifier);
1228         if (Strings.isNullOrEmpty(streamName)) {
1229             throw new RestconfDocumentedException("Stream name is empty.", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
1230         }
1231         final List<NotificationListenerAdapter> listeners = Notificator.getNotificationListenerFor(streamName);
1232         if (listeners == null || listeners.isEmpty()) {
1233             throw new RestconfDocumentedException("Stream was not found.", ErrorType.PROTOCOL,
1234                     ErrorTag.UNKNOWN_ELEMENT);
1235         }
1236
1237         for (final NotificationListenerAdapter listener : listeners) {
1238             this.broker.registerToListenNotification(listener);
1239             listener.setQueryParams(start,
1240                     java.util.Optional.ofNullable(stop), java.util.Optional.ofNullable(filter), false);
1241         }
1242
1243         final UriBuilder uriBuilder = uriInfo.getAbsolutePathBuilder();
1244
1245         final WebSocketServer webSocketServerInstance = WebSocketServer.getInstance(NOTIFICATION_PORT);
1246         final int notificationPort = webSocketServerInstance.getPort();
1247
1248         final UriBuilder uriToWebsocketServerBuilder = uriBuilder.port(notificationPort).scheme("ws");
1249
1250         return uriToWebsocketServerBuilder.replacePath(streamName).build();
1251     }
1252
1253     /**
1254      * Register data change listener by stream name.
1255      *
1256      * @param identifier
1257      *            stream name
1258      * @param uriInfo
1259      *            uri info
1260      * @param stop
1261      *            start-time of getting notification
1262      * @param start
1263      *            stop-time of getting notification
1264      * @param filter
1265      *            indicate which subset of all possible events are of interest
1266      * @return {@link URI} of location
1267      */
1268     private URI dataSubs(final String identifier, final UriInfo uriInfo, final Instant start, final Instant stop,
1269             final String filter, final boolean leafNodesOnly) {
1270         final String streamName = Notificator.createStreamNameFromUri(identifier);
1271         if (Strings.isNullOrEmpty(streamName)) {
1272             throw new RestconfDocumentedException("Stream name is empty.", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
1273         }
1274
1275         final ListenerAdapter listener = Notificator.getListenerFor(streamName);
1276         if (listener == null) {
1277             throw new RestconfDocumentedException("Stream was not found.", ErrorType.PROTOCOL,
1278                     ErrorTag.UNKNOWN_ELEMENT);
1279         }
1280         listener.setQueryParams(start, java.util.Optional.ofNullable(stop),
1281                 java.util.Optional.ofNullable(filter), leafNodesOnly);
1282
1283         final Map<String, String> paramToValues = resolveValuesFromUri(identifier);
1284         final LogicalDatastoreType datastore =
1285                 parserURIEnumParameter(LogicalDatastoreType.class, paramToValues.get(DATASTORE_PARAM_NAME));
1286         if (datastore == null) {
1287             throw new RestconfDocumentedException("Stream name doesn't contains datastore value (pattern /datastore=)",
1288                     ErrorType.APPLICATION, ErrorTag.MISSING_ATTRIBUTE);
1289         }
1290         final DataChangeScope scope =
1291                 parserURIEnumParameter(DataChangeScope.class, paramToValues.get(SCOPE_PARAM_NAME));
1292         if (scope == null) {
1293             throw new RestconfDocumentedException("Stream name doesn't contains datastore value (pattern /scope=)",
1294                     ErrorType.APPLICATION, ErrorTag.MISSING_ATTRIBUTE);
1295         }
1296
1297         this.broker.registerToListenDataChanges(datastore, scope, listener);
1298
1299         final UriBuilder uriBuilder = uriInfo.getAbsolutePathBuilder();
1300
1301         final WebSocketServer webSocketServerInstance = WebSocketServer.getInstance(NOTIFICATION_PORT);
1302         final int notificationPort = webSocketServerInstance.getPort();
1303
1304         final UriBuilder uriToWebsocketServerBuilder = uriBuilder.port(notificationPort).scheme("ws");
1305
1306         return uriToWebsocketServerBuilder.replacePath(streamName).build();
1307     }
1308
1309     @SuppressWarnings("checkstyle:IllegalCatch")
1310     @Override
1311     public PatchStatusContext patchConfigurationData(final String identifier, final PatchContext context,
1312                                                      final UriInfo uriInfo) {
1313         if (context == null) {
1314             throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
1315         }
1316
1317         try {
1318             return this.broker.patchConfigurationDataWithinTransaction(context);
1319         } catch (final Exception e) {
1320             LOG.debug("Patch transaction failed", e);
1321             throw new RestconfDocumentedException(e.getMessage());
1322         }
1323     }
1324
1325     @SuppressWarnings("checkstyle:IllegalCatch")
1326     @Override
1327     public PatchStatusContext patchConfigurationData(final PatchContext context, @Context final UriInfo uriInfo) {
1328         if (context == null) {
1329             throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
1330         }
1331
1332         try {
1333             return this.broker.patchConfigurationDataWithinTransaction(context);
1334         } catch (final Exception e) {
1335             LOG.debug("Patch transaction failed", e);
1336             throw new RestconfDocumentedException(e.getMessage());
1337         }
1338     }
1339
1340     /**
1341      * Load parameter for subscribing to stream from input composite node.
1342      *
1343      * @param value
1344      *            contains value
1345      * @return enum object if its string value is equal to {@code paramName}. In
1346      *         other cases null.
1347      */
1348     private static <T> T parseEnumTypeParameter(final ContainerNode value, final Class<T> classDescriptor,
1349             final String paramName) {
1350         final Optional<DataContainerChild<? extends PathArgument, ?>> augNode =
1351                 value.getChild(SAL_REMOTE_AUG_IDENTIFIER);
1352         if (!augNode.isPresent() && !(augNode instanceof AugmentationNode)) {
1353             return null;
1354         }
1355         final Optional<DataContainerChild<? extends PathArgument, ?>> enumNode = ((AugmentationNode) augNode.get())
1356                 .getChild(new NodeIdentifier(QName.create(SAL_REMOTE_AUGMENT, paramName)));
1357         if (!enumNode.isPresent()) {
1358             return null;
1359         }
1360         final Object rawValue = enumNode.get().getValue();
1361         if (!(rawValue instanceof String)) {
1362             return null;
1363         }
1364
1365         return resolveAsEnum(classDescriptor, (String) rawValue);
1366     }
1367
1368     /**
1369      * Checks whether {@code value} is one of the string representation of
1370      * enumeration {@code classDescriptor}.
1371      *
1372      * @return enum object if string value of {@code classDescriptor}
1373      *         enumeration is equal to {@code value}. Other cases null.
1374      */
1375     private static <T> T parserURIEnumParameter(final Class<T> classDescriptor, final String value) {
1376         if (Strings.isNullOrEmpty(value)) {
1377             return null;
1378         }
1379         return resolveAsEnum(classDescriptor, value);
1380     }
1381
1382     private static <T> T resolveAsEnum(final Class<T> classDescriptor, final String value) {
1383         final T[] enumConstants = classDescriptor.getEnumConstants();
1384         if (enumConstants != null) {
1385             for (final T enm : classDescriptor.getEnumConstants()) {
1386                 if (((Enum<?>) enm).name().equals(value)) {
1387                     return enm;
1388                 }
1389             }
1390         }
1391         return null;
1392     }
1393
1394     private static Map<String, String> resolveValuesFromUri(final String uri) {
1395         final Map<String, String> result = new HashMap<>();
1396         final String[] tokens = uri.split("/");
1397         for (int i = 1; i < tokens.length; i++) {
1398             final String[] parameterTokens = tokens[i].split("=");
1399             if (parameterTokens.length == 2) {
1400                 result.put(parameterTokens[0], parameterTokens[1]);
1401             }
1402         }
1403         return result;
1404     }
1405
1406     private MapNode makeModuleMapNode(final Set<Module> modules) {
1407         Preconditions.checkNotNull(modules);
1408         final Module restconfModule = getRestconfModule();
1409         final DataSchemaNode moduleSchemaNode = this.controllerContext
1410                 .getRestconfModuleRestConfSchemaNode(restconfModule, Draft02.RestConfModule.MODULE_LIST_SCHEMA_NODE);
1411         Preconditions.checkState(moduleSchemaNode instanceof ListSchemaNode);
1412
1413         final CollectionNodeBuilder<MapEntryNode, MapNode> listModuleBuilder =
1414                 Builders.mapBuilder((ListSchemaNode) moduleSchemaNode);
1415
1416         for (final Module module : modules) {
1417             listModuleBuilder.withChild(toModuleEntryNode(module, moduleSchemaNode));
1418         }
1419         return listModuleBuilder.build();
1420     }
1421
1422     protected MapEntryNode toModuleEntryNode(final Module module, final DataSchemaNode moduleSchemaNode) {
1423         Preconditions.checkArgument(moduleSchemaNode instanceof ListSchemaNode,
1424                 "moduleSchemaNode has to be of type ListSchemaNode");
1425         final ListSchemaNode listModuleSchemaNode = (ListSchemaNode) moduleSchemaNode;
1426         final DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> moduleNodeValues =
1427                 Builders.mapEntryBuilder(listModuleSchemaNode);
1428
1429         List<DataSchemaNode> instanceDataChildrenByName =
1430                 ControllerContext.findInstanceDataChildrenByName(listModuleSchemaNode, "name");
1431         final DataSchemaNode nameSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1432         Preconditions.checkState(nameSchemaNode instanceof LeafSchemaNode);
1433         moduleNodeValues
1434                 .withChild(Builders.leafBuilder((LeafSchemaNode) nameSchemaNode).withValue(module.getName()).build());
1435
1436         instanceDataChildrenByName =
1437                 ControllerContext.findInstanceDataChildrenByName(listModuleSchemaNode, "revision");
1438         final DataSchemaNode revisionSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1439         Preconditions.checkState(revisionSchemaNode instanceof LeafSchemaNode);
1440         final String revision = module.getQNameModule().getFormattedRevision();
1441         moduleNodeValues
1442                 .withChild(Builders.leafBuilder((LeafSchemaNode) revisionSchemaNode).withValue(revision).build());
1443
1444         instanceDataChildrenByName =
1445                 ControllerContext.findInstanceDataChildrenByName(listModuleSchemaNode, "namespace");
1446         final DataSchemaNode namespaceSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1447         Preconditions.checkState(namespaceSchemaNode instanceof LeafSchemaNode);
1448         moduleNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) namespaceSchemaNode)
1449                 .withValue(module.getNamespace().toString()).build());
1450
1451         instanceDataChildrenByName =
1452                 ControllerContext.findInstanceDataChildrenByName(listModuleSchemaNode, "feature");
1453         final DataSchemaNode featureSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1454         Preconditions.checkState(featureSchemaNode instanceof LeafListSchemaNode);
1455         final ListNodeBuilder<Object, LeafSetEntryNode<Object>> featuresBuilder =
1456                 Builders.leafSetBuilder((LeafListSchemaNode) featureSchemaNode);
1457         for (final FeatureDefinition feature : module.getFeatures()) {
1458             featuresBuilder.withChild(Builders.leafSetEntryBuilder((LeafListSchemaNode) featureSchemaNode)
1459                     .withValue(feature.getQName().getLocalName()).build());
1460         }
1461         moduleNodeValues.withChild(featuresBuilder.build());
1462
1463         return moduleNodeValues.build();
1464     }
1465
1466     protected MapEntryNode toStreamEntryNode(final String streamName, final DataSchemaNode streamSchemaNode) {
1467         Preconditions.checkArgument(streamSchemaNode instanceof ListSchemaNode,
1468                 "streamSchemaNode has to be of type ListSchemaNode");
1469         final ListSchemaNode listStreamSchemaNode = (ListSchemaNode) streamSchemaNode;
1470         final DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> streamNodeValues =
1471                 Builders.mapEntryBuilder(listStreamSchemaNode);
1472
1473         List<DataSchemaNode> instanceDataChildrenByName =
1474                 ControllerContext.findInstanceDataChildrenByName(listStreamSchemaNode, "name");
1475         final DataSchemaNode nameSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1476         Preconditions.checkState(nameSchemaNode instanceof LeafSchemaNode);
1477         streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) nameSchemaNode).withValue(streamName).build());
1478
1479         instanceDataChildrenByName =
1480                 ControllerContext.findInstanceDataChildrenByName(listStreamSchemaNode, "description");
1481         final DataSchemaNode descriptionSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1482         Preconditions.checkState(descriptionSchemaNode instanceof LeafSchemaNode);
1483         streamNodeValues.withChild(
1484                 Builders.leafBuilder((LeafSchemaNode) nameSchemaNode).withValue("DESCRIPTION_PLACEHOLDER").build());
1485
1486         instanceDataChildrenByName =
1487                 ControllerContext.findInstanceDataChildrenByName(listStreamSchemaNode, "replay-support");
1488         final DataSchemaNode replaySupportSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1489         Preconditions.checkState(replaySupportSchemaNode instanceof LeafSchemaNode);
1490         streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) replaySupportSchemaNode)
1491                 .withValue(Boolean.valueOf(true)).build());
1492
1493         instanceDataChildrenByName =
1494                 ControllerContext.findInstanceDataChildrenByName(listStreamSchemaNode, "replay-log-creation-time");
1495         final DataSchemaNode replayLogCreationTimeSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1496         Preconditions.checkState(replayLogCreationTimeSchemaNode instanceof LeafSchemaNode);
1497         streamNodeValues.withChild(
1498                 Builders.leafBuilder((LeafSchemaNode) replayLogCreationTimeSchemaNode).withValue("").build());
1499
1500         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(listStreamSchemaNode, "events");
1501         final DataSchemaNode eventsSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1502         Preconditions.checkState(eventsSchemaNode instanceof LeafSchemaNode);
1503         streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) eventsSchemaNode).build());
1504
1505         return streamNodeValues.build();
1506     }
1507
1508     /**
1509      * Prepare stream for notification.
1510      *
1511      * @param payload
1512      *            contains list of qnames of notifications
1513      * @return - checked future object
1514      */
1515     private static CheckedFuture<DOMRpcResult, DOMRpcException> invokeSalRemoteRpcNotifiStrRPC(
1516             final NormalizedNodeContext payload) {
1517         final ContainerNode data = (ContainerNode) payload.getData();
1518         LeafSetNode leafSet = null;
1519         String outputType = "XML";
1520         for (final DataContainerChild<? extends PathArgument, ?> dataChild : data.getValue()) {
1521             if (dataChild instanceof LeafSetNode) {
1522                 leafSet = (LeafSetNode) dataChild;
1523             } else if (dataChild instanceof AugmentationNode) {
1524                 outputType = (String) ((AugmentationNode) dataChild).getValue().iterator().next().getValue();
1525             }
1526         }
1527
1528         final Collection<LeafSetEntryNode> entryNodes = leafSet.getValue();
1529         final List<SchemaPath> paths = new ArrayList<>();
1530         String streamName = CREATE_NOTIFICATION_STREAM + "/";
1531
1532         final Iterator<LeafSetEntryNode> iterator = entryNodes.iterator();
1533         while (iterator.hasNext()) {
1534             final QName valueQName = QName.create((String) iterator.next().getValue());
1535             final Module module =
1536                     ControllerContext.getInstance().findModuleByNamespace(valueQName.getModule().getNamespace());
1537             Preconditions.checkNotNull(module,
1538                     "Module for namespace " + valueQName.getModule().getNamespace() + " does not exist");
1539             NotificationDefinition notifiDef = null;
1540             for (final NotificationDefinition notification : module.getNotifications()) {
1541                 if (notification.getQName().equals(valueQName)) {
1542                     notifiDef = notification;
1543                     break;
1544                 }
1545             }
1546             final String moduleName = module.getName();
1547             Preconditions.checkNotNull(notifiDef,
1548                     "Notification " + valueQName + "doesn't exist in module " + moduleName);
1549             paths.add(notifiDef.getPath());
1550             streamName = streamName + moduleName + ":" + valueQName.getLocalName();
1551             if (iterator.hasNext()) {
1552                 streamName = streamName + ",";
1553             }
1554         }
1555
1556         final QName rpcQName = payload.getInstanceIdentifierContext().getSchemaNode().getQName();
1557         final QName outputQname = QName.create(rpcQName, "output");
1558         final QName streamNameQname = QName.create(rpcQName, "notification-stream-identifier");
1559
1560         final ContainerNode output =
1561                 ImmutableContainerNodeBuilder.create().withNodeIdentifier(new NodeIdentifier(outputQname))
1562                         .withChild(ImmutableNodes.leafNode(streamNameQname, streamName)).build();
1563
1564         if (!Notificator.existNotificationListenerFor(streamName)) {
1565             Notificator.createNotificationListener(paths, streamName, outputType);
1566         }
1567
1568         final DOMRpcResult defaultDOMRpcResult = new DefaultDOMRpcResult(output);
1569
1570         return Futures.immediateCheckedFuture(defaultDOMRpcResult);
1571     }
1572 }