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