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

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