X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-rest-connector%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Frestconf%2Fimpl%2FRestconfImpl.java;h=33795889a122536c14f9e6c61f368b8b7c949ece;hb=f3db96e1a7b1e416bcbd75c06cbca2fba8a152eb;hp=4e807b4e230906e68f77dd16d6055a9245a97aaf;hpb=9448ce70206789ae175ee47b4b3a8872a93b7695;p=controller.git diff --git a/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/restconf/impl/RestconfImpl.java b/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/restconf/impl/RestconfImpl.java index 4e807b4e23..33795889a1 100644 --- a/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/restconf/impl/RestconfImpl.java +++ b/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/restconf/impl/RestconfImpl.java @@ -8,58 +8,73 @@ */ package org.opendaylight.controller.sal.restconf.impl; -import com.google.common.base.Objects; +import com.google.common.base.Optional; import com.google.common.base.Preconditions; +import com.google.common.base.Predicates; import com.google.common.base.Splitter; import com.google.common.base.Strings; -import com.google.common.collect.ImmutableList; +import com.google.common.base.Throwables; import com.google.common.collect.Iterables; import com.google.common.collect.Lists; +import com.google.common.collect.Sets; +import com.google.common.util.concurrent.CheckedFuture; +import com.google.common.util.concurrent.Futures; +import java.math.BigInteger; import java.net.URI; +import java.net.URISyntaxException; import java.text.ParseException; import java.text.SimpleDateFormat; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collection; import java.util.Collections; import java.util.Date; import java.util.HashMap; +import java.util.Iterator; import java.util.List; import java.util.Map; import java.util.Set; -import java.util.concurrent.Future; +import java.util.concurrent.CancellationException; +import java.util.concurrent.ExecutionException; import javax.ws.rs.core.Response; +import javax.ws.rs.core.Response.ResponseBuilder; import javax.ws.rs.core.Response.Status; import javax.ws.rs.core.UriBuilder; import javax.ws.rs.core.UriInfo; import org.apache.commons.lang3.StringUtils; -import org.opendaylight.controller.md.sal.common.api.TransactionStatus; -import org.opendaylight.controller.sal.core.api.mount.MountInstance; +import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope; +import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType; +import org.opendaylight.controller.md.sal.common.api.data.OptimisticLockFailedException; +import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException; +import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint; +import org.opendaylight.controller.md.sal.dom.api.DOMRpcException; +import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult; +import org.opendaylight.controller.md.sal.dom.api.DOMRpcService; +import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult; import org.opendaylight.controller.sal.rest.api.Draft02; import org.opendaylight.controller.sal.rest.api.RestconfService; import org.opendaylight.controller.sal.restconf.impl.RestconfError.ErrorTag; import org.opendaylight.controller.sal.restconf.impl.RestconfError.ErrorType; -import org.opendaylight.controller.sal.restconf.rpc.impl.BrokerRpcExecutor; -import org.opendaylight.controller.sal.restconf.rpc.impl.MountPointRpcExecutor; -import org.opendaylight.controller.sal.restconf.rpc.impl.RpcExecutor; import org.opendaylight.controller.sal.streams.listeners.ListenerAdapter; import org.opendaylight.controller.sal.streams.listeners.Notificator; import org.opendaylight.controller.sal.streams.websockets.WebSocketServer; -import org.opendaylight.yangtools.concepts.Codec; import org.opendaylight.yangtools.yang.common.QName; -import org.opendaylight.yangtools.yang.common.RpcError; -import org.opendaylight.yangtools.yang.common.RpcResult; -import org.opendaylight.yangtools.yang.data.api.CompositeNode; -import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier; -import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.InstanceIdentifierBuilder; -import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.NodeIdentifierWithPredicates; -import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument; -import org.opendaylight.yangtools.yang.data.api.MutableCompositeNode; -import org.opendaylight.yangtools.yang.data.api.Node; -import org.opendaylight.yangtools.yang.data.api.SimpleNode; -import org.opendaylight.yangtools.yang.data.impl.ImmutableCompositeNode; -import org.opendaylight.yangtools.yang.data.impl.NodeFactory; -import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode; +import org.opendaylight.yangtools.yang.common.QNameModule; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument; +import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode; +import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode; +import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild; +import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode; +import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode; +import org.opendaylight.yangtools.yang.data.api.schema.MapNode; +import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; +import org.opendaylight.yangtools.yang.data.api.schema.tree.ModifiedNodeDoesNotExistException; +import org.opendaylight.yangtools.yang.data.impl.schema.Builders; +import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes; +import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder; +import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder; +import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder; +import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder; import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode; import org.opendaylight.yangtools.yang.model.api.DataNodeContainer; import org.opendaylight.yangtools.yang.model.api.DataSchemaNode; @@ -70,21 +85,21 @@ import org.opendaylight.yangtools.yang.model.api.ListSchemaNode; import org.opendaylight.yangtools.yang.model.api.Module; import org.opendaylight.yangtools.yang.model.api.RpcDefinition; import org.opendaylight.yangtools.yang.model.api.SchemaContext; +import org.opendaylight.yangtools.yang.model.api.SchemaNode; import org.opendaylight.yangtools.yang.model.api.SchemaPath; -import org.opendaylight.yangtools.yang.model.api.TypeDefinition; -import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition; -import org.opendaylight.yangtools.yang.model.util.EmptyType; -import org.opendaylight.yangtools.yang.parser.builder.impl.ContainerSchemaNodeBuilder; -import org.opendaylight.yangtools.yang.parser.builder.impl.LeafSchemaNodeBuilder; +import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; public class RestconfImpl implements RestconfService { + private enum UriParameters { PRETTY_PRINT("prettyPrint"), DEPTH("depth"); private String uriParameterName; - UriParameters(String uriParameterName) { + UriParameters(final String uriParameterName) { this.uriParameterName = uriParameterName; } @@ -94,22 +109,65 @@ public class RestconfImpl implements RestconfService { } } - private final static RestconfImpl INSTANCE = new RestconfImpl(); + private static final RestconfImpl INSTANCE = new RestconfImpl(); + + private static final int NOTIFICATION_PORT = 8181; private static final int CHAR_NOT_FOUND = -1; - private final static String MOUNT_POINT_MODULE_NAME = "ietf-netconf"; + private static final String MOUNT_POINT_MODULE_NAME = "ietf-netconf"; - private final static SimpleDateFormat REVISION_FORMAT = new SimpleDateFormat("yyyy-MM-dd"); + private static final SimpleDateFormat REVISION_FORMAT = new SimpleDateFormat("yyyy-MM-dd"); - private final static String SAL_REMOTE_NAMESPACE = "urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote"; + private static final String SAL_REMOTE_NAMESPACE = "urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote"; - private final static String SAL_REMOTE_RPC_SUBSRCIBE = "create-data-change-event-subscription"; + private static final String SAL_REMOTE_RPC_SUBSRCIBE = "create-data-change-event-subscription"; private BrokerFacade broker; private ControllerContext controllerContext; + private static final Logger LOG = LoggerFactory.getLogger(RestconfImpl.class); + + private static final DataChangeScope DEFAULT_SCOPE = DataChangeScope.BASE; + + private static final LogicalDatastoreType DEFAULT_DATASTORE = LogicalDatastoreType.CONFIGURATION; + + private static final URI NAMESPACE_EVENT_SUBSCRIPTION_AUGMENT = URI.create("urn:sal:restconf:event:subscription"); + + private static final String DATASTORE_PARAM_NAME = "datastore"; + + private static final String SCOPE_PARAM_NAME = "scope"; + + private static final String NETCONF_BASE = "urn:ietf:params:xml:ns:netconf:base:1.0"; + + private static final String NETCONF_BASE_PAYLOAD_NAME = "data"; + + private static final QName NETCONF_BASE_QNAME; + + private static final QNameModule SAL_REMOTE_AUGMENT; + + private static final YangInstanceIdentifier.AugmentationIdentifier SAL_REMOTE_AUG_IDENTIFIER; + + static { + try { + final Date eventSubscriptionAugRevision = new SimpleDateFormat("yyyy-MM-dd").parse("2014-07-08"); + NETCONF_BASE_QNAME = QName.create(QNameModule.create(new URI(NETCONF_BASE), null), NETCONF_BASE_PAYLOAD_NAME ); + SAL_REMOTE_AUGMENT = QNameModule.create(NAMESPACE_EVENT_SUBSCRIPTION_AUGMENT, + eventSubscriptionAugRevision); + SAL_REMOTE_AUG_IDENTIFIER = new YangInstanceIdentifier.AugmentationIdentifier(Sets.newHashSet(QName.create(SAL_REMOTE_AUGMENT, "scope"), + QName.create(SAL_REMOTE_AUGMENT, "datastore"))); + } catch (final ParseException e) { + throw new RestconfDocumentedException( + "It wasn't possible to convert revision date of sal-remote-augment to date", ErrorType.APPLICATION, + ErrorTag.OPERATION_FAILED); + } catch (final URISyntaxException e) { + throw new RestconfDocumentedException( + "It wasn't possible to create instance of URI class with "+NETCONF_BASE+" URI", ErrorType.APPLICATION, + ErrorTag.OPERATION_FAILED); + } + } + public void setBroker(final BrokerFacade broker) { this.broker = broker; } @@ -126,162 +184,152 @@ public class RestconfImpl implements RestconfService { } @Override - public StructuredData getModules(final UriInfo uriInfo) { - final Module restconfModule = this.getRestconfModule(); + public NormalizedNodeContext getModules(final UriInfo uriInfo) { + final Set allModules = controllerContext.getAllModules(); + final MapNode allModuleMap = makeModuleMapNode(allModules); - final List> modulesAsData = new ArrayList>(); - final DataSchemaNode moduleSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(restconfModule, - Draft02.RestConfModule.MODULE_LIST_SCHEMA_NODE); + final SchemaContext schemaContext = controllerContext.getGlobalSchema(); - Set allModules = this.controllerContext.getAllModules(); - for (final Module module : allModules) { - CompositeNode moduleCompositeNode = this.toModuleCompositeNode(module, moduleSchemaNode); - modulesAsData.add(moduleCompositeNode); - } + final Module restconfModule = getRestconfModule(); + final DataSchemaNode modulesSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode( + restconfModule, Draft02.RestConfModule.MODULES_CONTAINER_SCHEMA_NODE); + Preconditions.checkState(modulesSchemaNode instanceof ContainerSchemaNode); - final DataSchemaNode modulesSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(restconfModule, - Draft02.RestConfModule.MODULES_CONTAINER_SCHEMA_NODE); - QName qName = modulesSchemaNode.getQName(); - final CompositeNode modulesNode = NodeFactory.createImmutableCompositeNode(qName, null, modulesAsData); - return new StructuredData(modulesNode, modulesSchemaNode, null, parsePrettyPrintParameter(uriInfo)); + final DataContainerNodeAttrBuilder moduleContainerBuilder = + Builders.containerBuilder((ContainerSchemaNode) modulesSchemaNode); + moduleContainerBuilder.withChild(allModuleMap); + + return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, modulesSchemaNode, + null, schemaContext), moduleContainerBuilder.build()); } + /** + * Valid only for mount point + */ @Override - public StructuredData getAvailableStreams(final UriInfo uriInfo) { - Set availableStreams = Notificator.getStreamNames(); - - final List> streamsAsData = new ArrayList>(); - Module restconfModule = this.getRestconfModule(); - final DataSchemaNode streamSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(restconfModule, - Draft02.RestConfModule.STREAM_LIST_SCHEMA_NODE); - for (final String streamName : availableStreams) { - streamsAsData.add(this.toStreamCompositeNode(streamName, streamSchemaNode)); - } - - final DataSchemaNode streamsSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(restconfModule, - Draft02.RestConfModule.STREAMS_CONTAINER_SCHEMA_NODE); - QName qName = streamsSchemaNode.getQName(); - final CompositeNode streamsNode = NodeFactory.createImmutableCompositeNode(qName, null, streamsAsData); - return new StructuredData(streamsNode, streamsSchemaNode, null, parsePrettyPrintParameter(uriInfo)); + public NormalizedNodeContext getModules(final String identifier, final UriInfo uriInfo) { + Preconditions.checkNotNull(identifier); + if ( ! identifier.contains(ControllerContext.MOUNT)) { + final String errMsg = "URI has bad format. If modules behind mount point should be showed," + + " URI has to end with " + ControllerContext.MOUNT; + throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); + } + + final InstanceIdentifierContext mountPointIdentifier = controllerContext.toMountPointIdentifier(identifier); + final DOMMountPoint mountPoint = mountPointIdentifier.getMountPoint(); + final Set modules = controllerContext.getAllModules(mountPoint); + final MapNode mountPointModulesMap = makeModuleMapNode(modules); + + final Module restconfModule = getRestconfModule(); + final DataSchemaNode modulesSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode( + restconfModule, Draft02.RestConfModule.MODULES_CONTAINER_SCHEMA_NODE); + Preconditions.checkState(modulesSchemaNode instanceof ContainerSchemaNode); + + final DataContainerNodeAttrBuilder moduleContainerBuilder = + Builders.containerBuilder((ContainerSchemaNode) modulesSchemaNode); + moduleContainerBuilder.withChild(mountPointModulesMap); + + return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, modulesSchemaNode, + mountPoint, controllerContext.getGlobalSchema()), moduleContainerBuilder.build()); } @Override - public StructuredData getModules(final String identifier, final UriInfo uriInfo) { - Set modules = null; - MountInstance mountPoint = null; + public NormalizedNodeContext getModule(final String identifier, final UriInfo uriInfo) { + Preconditions.checkNotNull(identifier); + final QName moduleNameAndRevision = getModuleNameAndRevision(identifier); + Module module = null; + DOMMountPoint mountPoint = null; + final SchemaContext schemaContext; if (identifier.contains(ControllerContext.MOUNT)) { - InstanceIdWithSchemaNode mountPointIdentifier = this.controllerContext.toMountPointIdentifier(identifier); + final InstanceIdentifierContext mountPointIdentifier = controllerContext.toMountPointIdentifier(identifier); mountPoint = mountPointIdentifier.getMountPoint(); - modules = this.controllerContext.getAllModules(mountPoint); + module = controllerContext.findModuleByNameAndRevision(mountPoint, moduleNameAndRevision); + schemaContext = mountPoint.getSchemaContext(); } else { - throw new RestconfDocumentedException( - "URI has bad format. If modules behind mount point should be showed, URI has to end with " - + ControllerContext.MOUNT, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); + module = controllerContext.findModuleByNameAndRevision(moduleNameAndRevision); + schemaContext = controllerContext.getGlobalSchema(); } - final List> modulesAsData = new ArrayList>(); - Module restconfModule = this.getRestconfModule(); - final DataSchemaNode moduleSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(restconfModule, - Draft02.RestConfModule.MODULE_LIST_SCHEMA_NODE); - - for (final Module module : modules) { - modulesAsData.add(this.toModuleCompositeNode(module, moduleSchemaNode)); + if (module == null) { + final String errMsg = "Module with name '" + moduleNameAndRevision.getLocalName() + + "' and revision '" + moduleNameAndRevision.getRevision() + "' was not found."; + throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT); } - final DataSchemaNode modulesSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(restconfModule, - Draft02.RestConfModule.MODULES_CONTAINER_SCHEMA_NODE); - QName qName = modulesSchemaNode.getQName(); - final CompositeNode modulesNode = NodeFactory.createImmutableCompositeNode(qName, null, modulesAsData); - return new StructuredData(modulesNode, modulesSchemaNode, mountPoint, parsePrettyPrintParameter(uriInfo)); + final Module restconfModule = getRestconfModule(); + final Set modules = Collections.singleton(module); + final MapNode moduleMap = makeModuleMapNode(modules); + + final DataSchemaNode moduleSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode( + restconfModule, Draft02.RestConfModule.MODULE_LIST_SCHEMA_NODE); + Preconditions.checkState(moduleSchemaNode instanceof ListSchemaNode); + + return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, moduleSchemaNode, mountPoint, + schemaContext), moduleMap); } @Override - public StructuredData getModule(final String identifier, final UriInfo uriInfo) { - final QName moduleNameAndRevision = this.getModuleNameAndRevision(identifier); - Module module = null; - MountInstance mountPoint = null; - if (identifier.contains(ControllerContext.MOUNT)) { - InstanceIdWithSchemaNode mountPointIdentifier = this.controllerContext.toMountPointIdentifier(identifier); - mountPoint = mountPointIdentifier.getMountPoint(); - module = this.controllerContext.findModuleByNameAndRevision(mountPoint, moduleNameAndRevision); - } else { - module = this.controllerContext.findModuleByNameAndRevision(moduleNameAndRevision); - } + public NormalizedNodeContext getAvailableStreams(final UriInfo uriInfo) { + final SchemaContext schemaContext = controllerContext.getGlobalSchema(); + final Set availableStreams = Notificator.getStreamNames(); + final Module restconfModule = getRestconfModule(); + final DataSchemaNode streamSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(restconfModule, + Draft02.RestConfModule.STREAM_LIST_SCHEMA_NODE); + Preconditions.checkState(streamSchemaNode instanceof ListSchemaNode); - if (module == null) { - throw new RestconfDocumentedException("Module with name '" + moduleNameAndRevision.getLocalName() - + "' and revision '" + moduleNameAndRevision.getRevision() + "' was not found.", - ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT); + final CollectionNodeBuilder listStreamsBuilder = Builders + .mapBuilder((ListSchemaNode) streamSchemaNode); + + for (final String streamName : availableStreams) { + listStreamsBuilder.withChild(toStreamEntryNode(streamName, streamSchemaNode)); } - Module restconfModule = this.getRestconfModule(); - final DataSchemaNode moduleSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(restconfModule, - Draft02.RestConfModule.MODULE_LIST_SCHEMA_NODE); - final CompositeNode moduleNode = this.toModuleCompositeNode(module, moduleSchemaNode); - return new StructuredData(moduleNode, moduleSchemaNode, mountPoint, parsePrettyPrintParameter(uriInfo)); + final DataSchemaNode streamsContainerSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode( + restconfModule, Draft02.RestConfModule.STREAMS_CONTAINER_SCHEMA_NODE); + Preconditions.checkState(streamsContainerSchemaNode instanceof ContainerSchemaNode); + + final DataContainerNodeAttrBuilder streamsContainerBuilder = + Builders.containerBuilder((ContainerSchemaNode) streamsContainerSchemaNode); + streamsContainerBuilder.withChild(listStreamsBuilder.build()); + + + return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, streamsContainerSchemaNode, null, + schemaContext), streamsContainerBuilder.build()); } @Override - public StructuredData getOperations(final UriInfo uriInfo) { - Set allModules = this.controllerContext.getAllModules(); - return this.operationsFromModulesToStructuredData(allModules, null, parsePrettyPrintParameter(uriInfo)); + public NormalizedNodeContext getOperations(final UriInfo uriInfo) { + final Set allModules = controllerContext.getAllModules(); + return operationsFromModulesToNormalizedContext(allModules, null); } @Override - public StructuredData getOperations(final String identifier, final UriInfo uriInfo) { + public NormalizedNodeContext getOperations(final String identifier, final UriInfo uriInfo) { Set modules = null; - MountInstance mountPoint = null; + DOMMountPoint mountPoint = null; if (identifier.contains(ControllerContext.MOUNT)) { - InstanceIdWithSchemaNode mountPointIdentifier = this.controllerContext.toMountPointIdentifier(identifier); + final InstanceIdentifierContext mountPointIdentifier = controllerContext.toMountPointIdentifier(identifier); mountPoint = mountPointIdentifier.getMountPoint(); - modules = this.controllerContext.getAllModules(mountPoint); + modules = controllerContext.getAllModules(mountPoint); + } else { - throw new RestconfDocumentedException( - "URI has bad format. If operations behind mount point should be showed, URI has to end with " - + ControllerContext.MOUNT, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); + final String errMsg = "URI has bad format. If operations behind mount point should be showed, URI has to end with "; + throw new RestconfDocumentedException(errMsg + ControllerContext.MOUNT, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); } - return this.operationsFromModulesToStructuredData(modules, mountPoint, parsePrettyPrintParameter(uriInfo)); + return operationsFromModulesToNormalizedContext(modules, mountPoint); } - private StructuredData operationsFromModulesToStructuredData(final Set modules, - final MountInstance mountPoint, boolean prettyPrint) { - final List> operationsAsData = new ArrayList>(); - Module restconfModule = this.getRestconfModule(); - final DataSchemaNode operationsSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode( - restconfModule, Draft02.RestConfModule.OPERATIONS_CONTAINER_SCHEMA_NODE); - QName qName = operationsSchemaNode.getQName(); - SchemaPath path = operationsSchemaNode.getPath(); - ContainerSchemaNodeBuilder containerSchemaNodeBuilder = new ContainerSchemaNodeBuilder( - Draft02.RestConfModule.NAME, 0, qName, path); - final ContainerSchemaNodeBuilder fakeOperationsSchemaNode = containerSchemaNodeBuilder; - for (final Module module : modules) { - Set rpcs = module.getRpcs(); - for (final RpcDefinition rpc : rpcs) { - QName rpcQName = rpc.getQName(); - SimpleNode immutableSimpleNode = NodeFactory. createImmutableSimpleNode(rpcQName, null, - null); - operationsAsData.add(immutableSimpleNode); - - String name = module.getName(); - LeafSchemaNodeBuilder leafSchemaNodeBuilder = new LeafSchemaNodeBuilder(name, 0, rpcQName, - SchemaPath.create(true, QName.create("dummy"))); - final LeafSchemaNodeBuilder fakeRpcSchemaNode = leafSchemaNodeBuilder; - fakeRpcSchemaNode.setAugmenting(true); - - EmptyType instance = EmptyType.getInstance(); - fakeRpcSchemaNode.setType(instance); - fakeOperationsSchemaNode.addChildNode(fakeRpcSchemaNode.build()); - } - } + private NormalizedNodeContext operationsFromModulesToNormalizedContext(final Set modules, + final DOMMountPoint mountPoint) { - final CompositeNode operationsNode = NodeFactory.createImmutableCompositeNode(qName, null, operationsAsData); - ContainerSchemaNode schemaNode = fakeOperationsSchemaNode.build(); - return new StructuredData(operationsNode, schemaNode, mountPoint, prettyPrint); + // FIXME find best way to change restconf-netconf yang schema for provide this functionality + final String errMsg = "We are not able support view operations functionality yet."; + throw new RestconfDocumentedException(errMsg, ErrorType.APPLICATION, ErrorTag.OPERATION_NOT_SUPPORTED); } private Module getRestconfModule() { - Module restconfModule = controllerContext.getRestconfModule(); + final Module restconfModule = controllerContext.getRestconfModule(); if (restconfModule == null) { throw new RestconfDocumentedException("ietf-restconf module was not found.", ErrorType.APPLICATION, ErrorTag.OPERATION_NOT_SUPPORTED); @@ -299,8 +347,8 @@ public class RestconfImpl implements RestconfService { moduleNameAndRevision = identifier; } - Splitter splitter = Splitter.on("/").omitEmptyStrings(); - Iterable split = splitter.split(moduleNameAndRevision); + final Splitter splitter = Splitter.on("/").omitEmptyStrings(); + final Iterable split = splitter.split(moduleNameAndRevision); final List pathArgs = Lists. newArrayList(split); if (pathArgs.size() < 2) { throw new RestconfDocumentedException( @@ -310,175 +358,178 @@ public class RestconfImpl implements RestconfService { try { final String moduleName = pathArgs.get(0); - String revision = pathArgs.get(1); + final String revision = pathArgs.get(1); final Date moduleRevision = REVISION_FORMAT.parse(revision); return QName.create(null, moduleRevision, moduleName); - } catch (ParseException e) { + } catch (final ParseException e) { throw new RestconfDocumentedException("URI has bad format. It should be \'moduleName/yyyy-MM-dd\'", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); } } - private CompositeNode toStreamCompositeNode(final String streamName, final DataSchemaNode streamSchemaNode) { - final List> streamNodeValues = new ArrayList>(); - List instanceDataChildrenByName = this.controllerContext.findInstanceDataChildrenByName( - ((DataNodeContainer) streamSchemaNode), "name"); - final DataSchemaNode nameSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); - streamNodeValues - .add(NodeFactory. createImmutableSimpleNode(nameSchemaNode.getQName(), null, streamName)); - - instanceDataChildrenByName = this.controllerContext.findInstanceDataChildrenByName( - ((DataNodeContainer) streamSchemaNode), "description"); - final DataSchemaNode descriptionSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); - streamNodeValues.add(NodeFactory. createImmutableSimpleNode(descriptionSchemaNode.getQName(), null, - "DESCRIPTION_PLACEHOLDER")); - - instanceDataChildrenByName = this.controllerContext.findInstanceDataChildrenByName( - ((DataNodeContainer) streamSchemaNode), "replay-support"); - final DataSchemaNode replaySupportSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); - streamNodeValues.add(NodeFactory. createImmutableSimpleNode(replaySupportSchemaNode.getQName(), null, - Boolean.valueOf(true))); - - instanceDataChildrenByName = this.controllerContext.findInstanceDataChildrenByName( - ((DataNodeContainer) streamSchemaNode), "replay-log-creation-time"); - final DataSchemaNode replayLogCreationTimeSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); - streamNodeValues.add(NodeFactory. createImmutableSimpleNode(replayLogCreationTimeSchemaNode.getQName(), - null, "")); - - instanceDataChildrenByName = this.controllerContext.findInstanceDataChildrenByName( - ((DataNodeContainer) streamSchemaNode), "events"); - final DataSchemaNode eventsSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); - streamNodeValues.add(NodeFactory. createImmutableSimpleNode(eventsSchemaNode.getQName(), null, "")); - - return NodeFactory.createImmutableCompositeNode(streamSchemaNode.getQName(), null, streamNodeValues); + @Override + public Object getRoot() { + return null; } - private CompositeNode toModuleCompositeNode(final Module module, final DataSchemaNode moduleSchemaNode) { - final List> moduleNodeValues = new ArrayList>(); - List instanceDataChildrenByName = this.controllerContext.findInstanceDataChildrenByName( - ((DataNodeContainer) moduleSchemaNode), "name"); - final DataSchemaNode nameSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); - moduleNodeValues.add(NodeFactory. createImmutableSimpleNode(nameSchemaNode.getQName(), null, - module.getName())); + @Override + public NormalizedNodeContext invokeRpc(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) { + final SchemaPath type = payload.getInstanceIdentifierContext().getSchemaNode().getPath(); + final URI namespace = payload.getInstanceIdentifierContext().getSchemaNode().getQName().getNamespace(); + final CheckedFuture response; + final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint(); + final SchemaContext schemaContext; + if (identifier.contains(MOUNT_POINT_MODULE_NAME) && mountPoint != null) { + final Optional mountRpcServices = mountPoint.getService(DOMRpcService.class); + if ( ! mountRpcServices.isPresent()) { + throw new RestconfDocumentedException("Rpc service is missing."); + } + schemaContext = mountPoint.getSchemaContext(); + response = mountRpcServices.get().invokeRpc(type, payload.getData()); + } else { + if (namespace.toString().equals(SAL_REMOTE_NAMESPACE)) { + response = invokeSalRemoteRpcSubscribeRPC(payload); + } else { + response = broker.invokeRpc(type, payload.getData()); + } + schemaContext = controllerContext.getGlobalSchema(); + } - instanceDataChildrenByName = this.controllerContext.findInstanceDataChildrenByName( - ((DataNodeContainer) moduleSchemaNode), "revision"); - final DataSchemaNode revisionSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); - Date _revision = module.getRevision(); - moduleNodeValues.add(NodeFactory. createImmutableSimpleNode(revisionSchemaNode.getQName(), null, - REVISION_FORMAT.format(_revision))); + final DOMRpcResult result = checkRpcResponse(response); - instanceDataChildrenByName = this.controllerContext.findInstanceDataChildrenByName( - ((DataNodeContainer) moduleSchemaNode), "namespace"); - final DataSchemaNode namespaceSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); - moduleNodeValues.add(NodeFactory. createImmutableSimpleNode(namespaceSchemaNode.getQName(), null, - module.getNamespace().toString())); - - instanceDataChildrenByName = this.controllerContext.findInstanceDataChildrenByName( - ((DataNodeContainer) moduleSchemaNode), "feature"); - final DataSchemaNode featureSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); - for (final FeatureDefinition feature : module.getFeatures()) { - moduleNodeValues.add(NodeFactory. createImmutableSimpleNode(featureSchemaNode.getQName(), null, - feature.getQName().getLocalName())); + RpcDefinition resultNodeSchema = null; + final NormalizedNode resultData = result.getResult(); + if (result != null && result.getResult() != null) { + resultNodeSchema = (RpcDefinition) payload.getInstanceIdentifierContext().getSchemaNode(); } - return NodeFactory.createImmutableCompositeNode(moduleSchemaNode.getQName(), null, moduleNodeValues); - } - - @Override - public Object getRoot() { - return null; + return new NormalizedNodeContext(new InstanceIdentifierContext(null, + resultNodeSchema, mountPoint, schemaContext), resultData); } - @Override - public StructuredData invokeRpc(final String identifier, final CompositeNode payload, final UriInfo uriInfo) { - final RpcExecutor rpc = this.resolveIdentifierInInvokeRpc(identifier); - QName rpcName = rpc.getRpcDefinition().getQName(); - URI rpcNamespace = rpcName.getNamespace(); - if (Objects.equal(rpcNamespace.toString(), SAL_REMOTE_NAMESPACE) - && Objects.equal(rpcName.getLocalName(), SAL_REMOTE_RPC_SUBSRCIBE)) { - return invokeSalRemoteRpcSubscribeRPC(payload, rpc.getRpcDefinition(), parsePrettyPrintParameter(uriInfo)); + private DOMRpcResult checkRpcResponse(final CheckedFuture response) { + if (response == null) { + return null; } + try { + final DOMRpcResult retValue = response.get(); + if (retValue.getErrors() == null || retValue.getErrors().isEmpty()) { + return retValue; + } + throw new RestconfDocumentedException("RpcError message", null, retValue.getErrors()); + } + catch (final InterruptedException e) { + throw new RestconfDocumentedException( + "The operation was interrupted while executing and did not complete.", ErrorType.RPC, + ErrorTag.PARTIAL_OPERATION); + } + catch (final ExecutionException e) { + Throwable cause = e.getCause(); + if (cause instanceof CancellationException) { + throw new RestconfDocumentedException("The operation was cancelled while executing.", ErrorType.RPC, + ErrorTag.PARTIAL_OPERATION); + } else if (cause != null) { + while (cause.getCause() != null) { + cause = cause.getCause(); + } - validateInput(rpc.getRpcDefinition().getInput(), payload); + if (cause instanceof IllegalArgumentException) { + throw new RestconfDocumentedException(cause.getMessage(), ErrorType.PROTOCOL, + ErrorTag.INVALID_VALUE); + } - return callRpc(rpc, payload, parsePrettyPrintParameter(uriInfo)); + throw new RestconfDocumentedException("The operation encountered an unexpected error while executing.", + cause); + } else { + throw new RestconfDocumentedException("The operation encountered an unexpected error while executing.", + e); + } + } } - private void validateInput(final DataSchemaNode inputSchema, final CompositeNode payload) { - if (inputSchema != null && payload == null) { + private void validateInput(final SchemaNode inputSchema, final NormalizedNodeContext payload) { + if (inputSchema != null && payload.getData() == null) { // expected a non null payload throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE); - } else if (inputSchema == null && payload != null) { + } else if (inputSchema == null && payload.getData() != null) { // did not expect any input throw new RestconfDocumentedException("No input expected.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE); } // else // { // TODO: Validate "mandatory" and "config" values here??? Or should those be + // those be // validate in a more central location inside MD-SAL core. // } } - private StructuredData invokeSalRemoteRpcSubscribeRPC(final CompositeNode payload, final RpcDefinition rpc, - final boolean prettyPrint) { - final CompositeNode value = this.normalizeNode(payload, rpc.getInput(), null); - final SimpleNode pathNode = value == null ? null : value.getFirstSimpleByName(QName.create( - rpc.getQName(), "path")); - final Object pathValue = pathNode == null ? null : pathNode.getValue(); + private CheckedFuture invokeSalRemoteRpcSubscribeRPC(final NormalizedNodeContext payload) { + final ContainerNode value = (ContainerNode) payload.getData(); + final QName rpcQName = payload.getInstanceIdentifierContext().getSchemaNode().getQName(); + final Optional> path = value.getChild(new NodeIdentifier( + QName.create(payload.getInstanceIdentifierContext().getSchemaNode().getQName(), "path"))); + final Object pathValue = path.isPresent() ? path.get().getValue() : null; - if (!(pathValue instanceof InstanceIdentifier)) { + if (!(pathValue instanceof YangInstanceIdentifier)) { throw new RestconfDocumentedException("Instance identifier was not normalized correctly.", ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED); } - final InstanceIdentifier pathIdentifier = ((InstanceIdentifier) pathValue); + final YangInstanceIdentifier pathIdentifier = ((YangInstanceIdentifier) pathValue); String streamName = null; if (!Iterables.isEmpty(pathIdentifier.getPathArguments())) { - String fullRestconfIdentifier = this.controllerContext.toFullRestconfIdentifier(pathIdentifier); - streamName = Notificator.createStreamNameFromUri(fullRestconfIdentifier); + final String fullRestconfIdentifier = controllerContext.toFullRestconfIdentifier(pathIdentifier, null); + + LogicalDatastoreType datastore = parseEnumTypeParameter(value, LogicalDatastoreType.class, + DATASTORE_PARAM_NAME); + datastore = datastore == null ? DEFAULT_DATASTORE : datastore; + + DataChangeScope scope = parseEnumTypeParameter(value, DataChangeScope.class, SCOPE_PARAM_NAME); + scope = scope == null ? DEFAULT_SCOPE : scope; + + streamName = Notificator.createStreamNameFromUri(fullRestconfIdentifier + "/datastore=" + datastore + + "/scope=" + scope); } if (Strings.isNullOrEmpty(streamName)) { throw new RestconfDocumentedException( - "Path is empty or contains data node which is not Container or List build-in type.", + "Path is empty or contains value node which is not Container or List build-in type.", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); } - final SimpleNode streamNameNode = NodeFactory. createImmutableSimpleNode( - QName.create(rpc.getOutput().getQName(), "stream-name"), null, streamName); - final List> output = new ArrayList>(); - output.add(streamNameNode); + final QName outputQname = QName.create(rpcQName, "output"); + final QName streamNameQname = QName.create(rpcQName, "stream-name"); - final MutableCompositeNode responseData = NodeFactory.createMutableCompositeNode(rpc.getOutput().getQName(), - null, output, null, null); + final ContainerNode output = ImmutableContainerNodeBuilder.create().withNodeIdentifier(new NodeIdentifier(outputQname)) + .withChild(ImmutableNodes.leafNode(streamNameQname, streamName)).build(); - if (!Notificator.existListenerFor(pathIdentifier)) { - Notificator.createListener(pathIdentifier, streamName); + if (!Notificator.existListenerFor(streamName)) { + final YangInstanceIdentifier normalizedPathIdentifier = controllerContext.toNormalized(pathIdentifier); + Notificator.createListener(normalizedPathIdentifier, streamName); } - return new StructuredData(responseData, rpc.getOutput(), null, prettyPrint); + final DOMRpcResult defaultDOMRpcResult = new DefaultDOMRpcResult(output); + + return Futures.immediateCheckedFuture(defaultDOMRpcResult); } @Override - public StructuredData invokeRpc(final String identifier, final String noPayload, final UriInfo uriInfo) { + public NormalizedNodeContext invokeRpc(final String identifier, final String noPayload, final UriInfo uriInfo) { if (StringUtils.isNotBlank(noPayload)) { throw new RestconfDocumentedException("Content must be empty.", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); } - return invokeRpc(identifier, (CompositeNode) null, uriInfo); - } - private RpcExecutor resolveIdentifierInInvokeRpc(final String identifier) { String identifierEncoded = null; - MountInstance mountPoint = null; + DOMMountPoint mountPoint = null; + final SchemaContext schemaContext; if (identifier.contains(ControllerContext.MOUNT)) { // mounted RPC call - look up mount instance. - InstanceIdWithSchemaNode mountPointId = controllerContext.toMountPointIdentifier(identifier); + final InstanceIdentifierContext mountPointId = controllerContext.toMountPointIdentifier(identifier); mountPoint = mountPointId.getMountPoint(); - - int startOfRemoteRpcName = identifier.lastIndexOf(ControllerContext.MOUNT) + schemaContext = mountPoint.getSchemaContext(); + final int startOfRemoteRpcName = identifier.lastIndexOf(ControllerContext.MOUNT) + ControllerContext.MOUNT.length() + 1; - String remoteRpcName = identifier.substring(startOfRemoteRpcName); + final String remoteRpcName = identifier.substring(startOfRemoteRpcName); identifierEncoded = remoteRpcName; } else if (identifier.indexOf("/") != CHAR_NOT_FOUND) { @@ -487,6 +538,7 @@ public class RestconfImpl implements RestconfService { throw new RestconfDocumentedException(slashErrorMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); } else { identifierEncoded = identifier; + schemaContext = controllerContext.getGlobalSchema(); } final String identifierDecoded = controllerContext.urlPathArgDecode(identifierEncoded); @@ -502,12 +554,35 @@ public class RestconfImpl implements RestconfService { throw new RestconfDocumentedException("RPC does not exist.", ErrorType.RPC, ErrorTag.UNKNOWN_ELEMENT); } - if (mountPoint == null) { - return new BrokerRpcExecutor(rpc, broker); + if (rpc.getInput() != null) { + // FIXME : find a correct Error from specification + throw new IllegalStateException("RPC " + rpc + " does'n need input value!"); + } + + final CheckedFuture response; + if (mountPoint != null) { + final Optional mountRpcServices = mountPoint.getService(DOMRpcService.class); + if ( ! mountRpcServices.isPresent()) { + throw new RestconfDocumentedException("Rpc service is missing."); + } + response = mountRpcServices.get().invokeRpc(rpc.getPath(), null); } else { - return new MountPointRpcExecutor(rpc, mountPoint); + response = broker.invokeRpc(rpc.getPath(), null); } + final DOMRpcResult result = checkRpcResponse(response); + + DataSchemaNode resultNodeSchema = null; + NormalizedNode resultData = null; + if (result != null && result.getResult() != null) { + resultData = result.getResult(); + final ContainerSchemaNode rpcDataSchemaNode = + SchemaContextUtil.getRpcDataSchema(schemaContext, rpc.getOutput().getPath()); + resultNodeSchema = rpcDataSchemaNode.getDataChildByName(result.getResult().getNodeType()); + } + + return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, resultNodeSchema, mountPoint, + schemaContext), resultData); } private RpcDefinition findRpc(final SchemaContext schemaContext, final String identifierDecoded) { @@ -517,9 +592,9 @@ public class RestconfImpl implements RestconfService { + " couldn't be splitted to 2 parts (module:rpc name)", ErrorType.APPLICATION, ErrorTag.INVALID_VALUE); } - for (Module module : schemaContext.getModules()) { + for (final Module module : schemaContext.getModules()) { if (module.getName().equals(splittedIdentifier[0])) { - for (RpcDefinition rpcDefinition : module.getRpcs()) { + for (final RpcDefinition rpcDefinition : module.getRpcs()) { if (rpcDefinition.getQName().getLocalName().equals(splittedIdentifier[1])) { return rpcDefinition; } @@ -529,101 +604,35 @@ public class RestconfImpl implements RestconfService { return null; } - private StructuredData callRpc(final RpcExecutor rpcExecutor, final CompositeNode payload, boolean prettyPrint) { - if (rpcExecutor == null) { - throw new RestconfDocumentedException("RPC does not exist.", ErrorType.RPC, ErrorTag.UNKNOWN_ELEMENT); - } - - CompositeNode rpcRequest = null; - RpcDefinition rpc = rpcExecutor.getRpcDefinition(); - QName rpcName = rpc.getQName(); - - if (payload == null) { - rpcRequest = NodeFactory.createMutableCompositeNode(rpcName, null, null, null, null); - } else { - final CompositeNode value = this.normalizeNode(payload, rpc.getInput(), null); - List> input = Collections.> singletonList(value); - rpcRequest = NodeFactory.createMutableCompositeNode(rpcName, null, input, null, null); - } - - RpcResult rpcResult = rpcExecutor.invokeRpc(rpcRequest); - - checkRpcSuccessAndThrowException(rpcResult); - - if (rpcResult.getResult() == null) { - return null; - } - - if (rpc.getOutput() == null) { - return null; // no output, nothing to send back. - } - - return new StructuredData(rpcResult.getResult(), rpc.getOutput(), null, prettyPrint); - } - - private void checkRpcSuccessAndThrowException(final RpcResult rpcResult) { - if (rpcResult.isSuccessful() == false) { - - Collection rpcErrors = rpcResult.getErrors(); - if (rpcErrors == null || rpcErrors.isEmpty()) { - throw new RestconfDocumentedException( - "The operation was not successful and there were no RPC errors returned", ErrorType.RPC, - ErrorTag.OPERATION_FAILED); - } - - List errorList = Lists.newArrayList(); - for (RpcError rpcError : rpcErrors) { - errorList.add(new RestconfError(rpcError)); - } - - throw new RestconfDocumentedException(errorList); - } - } - @Override - public StructuredData readConfigurationData(final String identifier, final UriInfo uriInfo) { - final InstanceIdWithSchemaNode iiWithData = this.controllerContext.toInstanceIdentifier(identifier); - CompositeNode data = null; - MountInstance mountPoint = iiWithData.getMountPoint(); + public NormalizedNodeContext readConfigurationData(final String identifier, final UriInfo uriInfo) { + final InstanceIdentifierContext iiWithData = controllerContext.toInstanceIdentifier(identifier); + final DOMMountPoint mountPoint = iiWithData.getMountPoint(); + NormalizedNode data = null; + final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier(); if (mountPoint != null) { - data = broker.readConfigurationDataBehindMountPoint(mountPoint, iiWithData.getInstanceIdentifier()); + data = broker.readConfigurationData(mountPoint, normalizedII); } else { - data = broker.readConfigurationData(iiWithData.getInstanceIdentifier()); + data = broker.readConfigurationData(normalizedII); } - - data = pruneDataAtDepth(data, parseDepthParameter(uriInfo)); - boolean prettyPrintMode = parsePrettyPrintParameter(uriInfo); - return new StructuredData(data, iiWithData.getSchemaNode(), iiWithData.getMountPoint(), prettyPrintMode); - } - - @SuppressWarnings("unchecked") - private > T pruneDataAtDepth(final T node, final Integer depth) { - if (depth == null) { - return node; - } - - if (node instanceof CompositeNode) { - ImmutableList.Builder> newChildNodes = ImmutableList.> builder(); - if (depth > 1) { - for (Node childNode : ((CompositeNode) node).getValue()) { - newChildNodes.add(pruneDataAtDepth(childNode, depth - 1)); - } - } - - return (T) ImmutableCompositeNode.create(node.getNodeType(), newChildNodes.build()); - } else { // SimpleNode - return node; + if(data == null) { + throw new RestconfDocumentedException( + "Request could not be completed because the relevant data model content does not exist.", + ErrorType.APPLICATION, ErrorTag.DATA_MISSING); } + return new NormalizedNodeContext(iiWithData, data); } + // FIXME: Move this to proper place + @SuppressWarnings("unused") private Integer parseDepthParameter(final UriInfo info) { - String param = info.getQueryParameters(false).getFirst(UriParameters.DEPTH.toString()); + final String param = info.getQueryParameters(false).getFirst(UriParameters.DEPTH.toString()); if (Strings.isNullOrEmpty(param) || "unbounded".equals(param)) { return null; } try { - Integer depth = Integer.valueOf(param); + final Integer depth = Integer.valueOf(param); if (depth < 1) { throw new RestconfDocumentedException(new RestconfError(ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE, "Invalid depth parameter: " + depth, null, @@ -631,7 +640,7 @@ public class RestconfImpl implements RestconfService { } return depth; - } catch (NumberFormatException e) { + } catch (final NumberFormatException e) { throw new RestconfDocumentedException(new RestconfError(ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE, "Invalid depth parameter: " + e.getMessage(), null, "The depth parameter must be an integer > 1 or \"unbounded\"")); @@ -639,53 +648,98 @@ public class RestconfImpl implements RestconfService { } @Override - public StructuredData readOperationalData(final String identifier, final UriInfo info) { - final InstanceIdWithSchemaNode iiWithData = this.controllerContext.toInstanceIdentifier(identifier); - CompositeNode data = null; - MountInstance mountPoint = iiWithData.getMountPoint(); + public NormalizedNodeContext readOperationalData(final String identifier, final UriInfo info) { + final InstanceIdentifierContext iiWithData = controllerContext.toInstanceIdentifier(identifier); + final DOMMountPoint mountPoint = iiWithData.getMountPoint(); + NormalizedNode data = null; + final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier(); if (mountPoint != null) { - data = broker.readOperationalDataBehindMountPoint(mountPoint, iiWithData.getInstanceIdentifier()); + data = broker.readOperationalData(mountPoint, normalizedII); } else { - data = broker.readOperationalData(iiWithData.getInstanceIdentifier()); + data = broker.readOperationalData(normalizedII); } - - data = pruneDataAtDepth(data, parseDepthParameter(info)); - boolean prettyPrintMode = parsePrettyPrintParameter(info); - return new StructuredData(data, iiWithData.getSchemaNode(), mountPoint, prettyPrintMode); - } - - private boolean parsePrettyPrintParameter(UriInfo info) { - String param = info.getQueryParameters(false).getFirst(UriParameters.PRETTY_PRINT.toString()); - return Boolean.parseBoolean(param); + if(data == null) { + throw new RestconfDocumentedException( + "Request could not be completed because the relevant data model content does not exist.", + ErrorType.APPLICATION, ErrorTag.DATA_MISSING); + } + return new NormalizedNodeContext(iiWithData, data); } @Override - public Response updateConfigurationData(final String identifier, final CompositeNode payload) { - final InstanceIdWithSchemaNode iiWithData = this.controllerContext.toInstanceIdentifier(identifier); + public Response updateConfigurationData(final String identifier, final NormalizedNodeContext payload) { + Preconditions.checkNotNull(identifier); + final InstanceIdentifierContext iiWithData = payload.getInstanceIdentifierContext(); validateInput(iiWithData.getSchemaNode(), payload); + validateTopLevelNodeName(payload, iiWithData.getInstanceIdentifier()); + validateListKeysEqualityInPayloadAndUri(iiWithData, payload.getData()); + + final DOMMountPoint mountPoint = iiWithData.getMountPoint(); + final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier(); + + /* + * There is a small window where another write transaction could be updating the same data + * simultaneously and we get an OptimisticLockFailedException. This error is likely + * transient and The WriteTransaction#submit API docs state that a retry will likely + * succeed. So we'll try again if that scenario occurs. If it fails a third time then it + * probably will never succeed so we'll fail in that case. + * + * By retrying we're attempting to hide the internal implementation of the data store and + * how it handles concurrent updates from the restconf client. The client has instructed us + * to put the data and we should make every effort to do so without pushing optimistic lock + * failures back to the client and forcing them to handle it via retry (and having to + * document the behavior). + */ + int tries = 2; + while(true) { + try { + if (mountPoint != null) { + broker.commitConfigurationDataPut(mountPoint, normalizedII, payload.getData()).checkedGet(); + } else { + broker.commitConfigurationDataPut(normalizedII, payload.getData()).checkedGet(); + } - MountInstance mountPoint = iiWithData.getMountPoint(); - final CompositeNode value = this.normalizeNode(payload, iiWithData.getSchemaNode(), mountPoint); - validateListKeysEqualityInPayloadAndUri(iiWithData, payload); - RpcResult status = null; + break; + } catch (final TransactionCommitFailedException e) { + if(e instanceof OptimisticLockFailedException) { + if(--tries <= 0) { + LOG.debug("Got OptimisticLockFailedException on last try - failing"); + throw new RestconfDocumentedException(e.getMessage(), e, e.getErrorList()); + } - try { - if (mountPoint != null) { - status = broker.commitConfigurationDataPutBehindMountPoint(mountPoint, - iiWithData.getInstanceIdentifier(), value).get(); - } else { - status = broker.commitConfigurationDataPut(iiWithData.getInstanceIdentifier(), value).get(); + LOG.debug("Got OptimisticLockFailedException - trying again"); + } else { + throw new RestconfDocumentedException(e.getMessage(), e, e.getErrorList()); + } } - } catch (Exception e) { - throw new RestconfDocumentedException("Error updating data", e); } - if (status.getResult() == TransactionStatus.COMMITED) { - return Response.status(Status.OK).build(); - } + return Response.status(Status.OK).build(); + } + + private void validateTopLevelNodeName(final NormalizedNodeContext node, + final YangInstanceIdentifier identifier) { - return Response.status(Status.INTERNAL_SERVER_ERROR).build(); + final String payloadName = node.getData().getNodeType().getLocalName(); + final Iterator pathArguments = identifier.getReversePathArguments().iterator(); + + //no arguments + if ( ! pathArguments.hasNext()) { + //no "data" payload + if ( ! node.getData().getNodeType().equals(NETCONF_BASE_QNAME)) { + throw new RestconfDocumentedException("Instance identifier has to contain at least one path argument", + ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE); + } + //any arguments + } else { + final String identifierName = pathArguments.next().getNodeType().getLocalName(); + if ( ! payloadName.equals(identifierName)) { + throw new RestconfDocumentedException("Payload name (" + payloadName + + ") is different from identifier name (" + identifierName + ")", ErrorType.PROTOCOL, + ErrorTag.MALFORMED_MESSAGE); + } + } } /** @@ -695,8 +749,8 @@ public class RestconfImpl implements RestconfService { * if key values or key count in payload and URI isn't equal * */ - private void validateListKeysEqualityInPayloadAndUri(final InstanceIdWithSchemaNode iiWithData, - final CompositeNode payload) { + private void validateListKeysEqualityInPayloadAndUri(final InstanceIdentifierContext iiWithData, + final NormalizedNode payload) { if (iiWithData.getSchemaNode() instanceof ListSchemaNode) { final List keyDefinitions = ((ListSchemaNode) iiWithData.getSchemaNode()).getKeyDefinition(); final PathArgument lastPathArgument = iiWithData.getInstanceIdentifier().getLastPathArgument(); @@ -708,182 +762,147 @@ public class RestconfImpl implements RestconfService { } } - private void isEqualUriAndPayloadKeyValues(final Map uriKeyValues, final CompositeNode payload, + private void isEqualUriAndPayloadKeyValues(final Map uriKeyValues, final NormalizedNode payload, final List keyDefinitions) { - for (QName keyDefinition : keyDefinitions) { + for (final QName keyDefinition : keyDefinitions) { final Object uriKeyValue = uriKeyValues.get(keyDefinition); // should be caught during parsing URI to InstanceIdentifier if (uriKeyValue == null) { - throw new RestconfDocumentedException("Missing key " + keyDefinition + " in URI.", ErrorType.PROTOCOL, - ErrorTag.DATA_MISSING); - } - final List> payloadKeyValues = payload.getSimpleNodesByName(keyDefinition.getLocalName()); - if (payloadKeyValues.isEmpty()) { - throw new RestconfDocumentedException("Missing key " + keyDefinition.getLocalName() - + " in the message body.", ErrorType.PROTOCOL, ErrorTag.DATA_MISSING); - } - - Object payloadKeyValue = payloadKeyValues.iterator().next().getValue(); - if (!uriKeyValue.equals(payloadKeyValue)) { - throw new RestconfDocumentedException("The value '" + uriKeyValue + "' for key '" - + keyDefinition.getLocalName() + "' specified in the URI doesn't match the value '" - + payloadKeyValue + "' specified in the message body. ", ErrorType.PROTOCOL, - ErrorTag.INVALID_VALUE); + final String errMsg = "Missing key " + keyDefinition + " in URI."; + throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.DATA_MISSING); } + // TODO thing about the possibility to fix +// final List> payloadKeyValues = payload.getSimpleNodesByName(keyDefinition.getLocalName()); +// if (payloadKeyValues.isEmpty()) { +// final String errMsg = "Missing key " + keyDefinition.getLocalName() + " in the message body."; +// throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.DATA_MISSING); +// } +// +// final Object payloadKeyValue = payloadKeyValues.iterator().next().getValue(); +// if (!uriKeyValue.equals(payloadKeyValue)) { +// final String errMsg = "The value '" + uriKeyValue + "' for key '" + keyDefinition.getLocalName() + +// "' specified in the URI doesn't match the value '" + payloadKeyValue + "' specified in the message body. "; +// throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); +// } } } @Override - public Response createConfigurationData(final String identifier, final CompositeNode payload) { - if (payload == null) { - throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE); - } - - URI payloadNS = this.namespace(payload); - if (payloadNS == null) { - throw new RestconfDocumentedException( - "Data has bad format. Root element node must have namespace (XML format) or module name(JSON format)", - ErrorType.PROTOCOL, ErrorTag.UNKNOWN_NAMESPACE); - } - - InstanceIdWithSchemaNode iiWithData = null; - CompositeNode value = null; - if (this.representsMountPointRootData(payload)) { - // payload represents mount point data and URI represents path to the mount point - - if (this.endsWithMountPoint(identifier)) { - throw new RestconfDocumentedException("URI has bad format. URI should be without \"" - + ControllerContext.MOUNT + "\" for POST operation.", ErrorType.PROTOCOL, - ErrorTag.INVALID_VALUE); - } - - final String completeIdentifier = this.addMountPointIdentifier(identifier); - iiWithData = this.controllerContext.toInstanceIdentifier(completeIdentifier); - - value = this.normalizeNode(payload, iiWithData.getSchemaNode(), iiWithData.getMountPoint()); - } else { - final InstanceIdWithSchemaNode incompleteInstIdWithData = this.controllerContext - .toInstanceIdentifier(identifier); - final DataNodeContainer parentSchema = (DataNodeContainer) incompleteInstIdWithData.getSchemaNode(); - MountInstance mountPoint = incompleteInstIdWithData.getMountPoint(); - final Module module = this.findModule(mountPoint, payload); - if (module == null) { - throw new RestconfDocumentedException("Module was not found for \"" + payloadNS + "\"", - ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT); - } - - String payloadName = this.getName(payload); - final DataSchemaNode schemaNode = this.controllerContext.findInstanceDataChildByNameAndNamespace( - parentSchema, payloadName, module.getNamespace()); - value = this.normalizeNode(payload, schemaNode, mountPoint); - - iiWithData = this.addLastIdentifierFromData(incompleteInstIdWithData, value, schemaNode); - } + public Response createConfigurationData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) { + return createConfigurationData(payload, uriInfo); + } - RpcResult status = null; - MountInstance mountPoint = iiWithData.getMountPoint(); - try { - if (mountPoint != null) { - Future> future = broker.commitConfigurationDataPostBehindMountPoint( - mountPoint, iiWithData.getInstanceIdentifier(), value); - status = future == null ? null : future.get(); - } else { - Future> future = broker.commitConfigurationDataPost( - iiWithData.getInstanceIdentifier(), value); - status = future == null ? null : future.get(); + // FIXME create RestconfIdetifierHelper and move this method there + private YangInstanceIdentifier checkConsistencyOfNormalizedNodeContext(final NormalizedNodeContext payload) { + Preconditions.checkArgument(payload != null); + Preconditions.checkArgument(payload.getData() != null); + Preconditions.checkArgument(payload.getData().getNodeType() != null); + Preconditions.checkArgument(payload.getInstanceIdentifierContext() != null); + Preconditions.checkArgument(payload.getInstanceIdentifierContext().getInstanceIdentifier() != null); + + final QName payloadNodeQname = payload.getData().getNodeType(); + final YangInstanceIdentifier yangIdent = payload.getInstanceIdentifierContext().getInstanceIdentifier(); + if (payloadNodeQname.compareTo(yangIdent.getLastPathArgument().getNodeType()) > 0) { + return yangIdent; + } + final InstanceIdentifierContext parentContext = payload.getInstanceIdentifierContext(); + final SchemaNode parentSchemaNode = parentContext.getSchemaNode(); + if(parentSchemaNode instanceof DataNodeContainer) { + final DataNodeContainer cast = (DataNodeContainer) parentSchemaNode; + for (final DataSchemaNode child : cast.getChildNodes()) { + if (payloadNodeQname.compareTo(child.getQName()) == 0) { + return YangInstanceIdentifier.builder(yangIdent).node(child.getQName()).build(); + } } - } catch (Exception e) { - throw new RestconfDocumentedException("Error creating data", e); } - - if (status == null) { - return Response.status(Status.ACCEPTED).build(); + if (parentSchemaNode instanceof RpcDefinition) { + return yangIdent; } - - if (status.getResult() == TransactionStatus.COMMITED) { - return Response.status(Status.NO_CONTENT).build(); - } - - return Response.status(Status.INTERNAL_SERVER_ERROR).build(); + final String errMsg = "Error parsing input: DataSchemaNode has not children"; + throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE); } @Override - public Response createConfigurationData(final CompositeNode payload) { + public Response createConfigurationData(final NormalizedNodeContext payload, final UriInfo uriInfo) { if (payload == null) { throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE); } - URI payloadNS = this.namespace(payload); + final URI payloadNS = payload.getData().getNodeType().getNamespace(); if (payloadNS == null) { throw new RestconfDocumentedException( "Data has bad format. Root element node must have namespace (XML format) or module name(JSON format)", ErrorType.PROTOCOL, ErrorTag.UNKNOWN_NAMESPACE); } - final Module module = this.findModule(null, payload); - if (module == null) { - throw new RestconfDocumentedException( - "Data has bad format. Root element node has incorrect namespace (XML format) or module name(JSON format)", - ErrorType.PROTOCOL, ErrorTag.UNKNOWN_NAMESPACE); - } - - String payloadName = this.getName(payload); - final DataSchemaNode schemaNode = this.controllerContext.findInstanceDataChildByNameAndNamespace(module, - payloadName, module.getNamespace()); - final CompositeNode value = this.normalizeNode(payload, schemaNode, null); - final InstanceIdWithSchemaNode iiWithData = this.addLastIdentifierFromData(null, value, schemaNode); - RpcResult status = null; - MountInstance mountPoint = iiWithData.getMountPoint(); - + final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint(); + final InstanceIdentifierContext iiWithData = payload.getInstanceIdentifierContext(); + final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier(); try { if (mountPoint != null) { - Future> future = broker.commitConfigurationDataPostBehindMountPoint( - mountPoint, iiWithData.getInstanceIdentifier(), value); - status = future == null ? null : future.get(); + broker.commitConfigurationDataPost(mountPoint, normalizedII, payload.getData()).checkedGet(); } else { - Future> future = broker.commitConfigurationDataPost( - iiWithData.getInstanceIdentifier(), value); - status = future == null ? null : future.get(); + broker.commitConfigurationDataPost(normalizedII, payload.getData()).checkedGet(); } - } catch (Exception e) { + } catch(final RestconfDocumentedException e) { + throw e; + } catch (final Exception e) { throw new RestconfDocumentedException("Error creating data", e); } - if (status == null) { - return Response.status(Status.ACCEPTED).build(); + final ResponseBuilder responseBuilder = Response.status(Status.NO_CONTENT); + // FIXME: Provide path to result. + final URI location = resolveLocation(uriInfo, "", mountPoint, normalizedII); + if (location != null) { + responseBuilder.location(location); } + return responseBuilder.build(); + } - if (status.getResult() == TransactionStatus.COMMITED) { - return Response.status(Status.NO_CONTENT).build(); + private URI resolveLocation(final UriInfo uriInfo, final String uriBehindBase, final DOMMountPoint mountPoint, final YangInstanceIdentifier normalizedII) { + final UriBuilder uriBuilder = uriInfo.getBaseUriBuilder(); + uriBuilder.path("config"); + try { + uriBuilder.path(controllerContext.toFullRestconfIdentifier(normalizedII, mountPoint)); + } catch (final Exception e) { + LOG.debug("Location for instance identifier"+normalizedII+"wasn't created", e); + return null; } - - return Response.status(Status.INTERNAL_SERVER_ERROR).build(); + return uriBuilder.build(); } @Override public Response deleteConfigurationData(final String identifier) { - final InstanceIdWithSchemaNode iiWithData = this.controllerContext.toInstanceIdentifier(identifier); - RpcResult status = null; - MountInstance mountPoint = iiWithData.getMountPoint(); + final InstanceIdentifierContext iiWithData = controllerContext.toInstanceIdentifier(identifier); + final DOMMountPoint mountPoint = iiWithData.getMountPoint(); + final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier(); try { if (mountPoint != null) { - status = broker.commitConfigurationDataDeleteBehindMountPoint(mountPoint, - iiWithData.getInstanceIdentifier()).get(); + broker.commitConfigurationDataDelete(mountPoint, normalizedII); } else { - status = broker.commitConfigurationDataDelete(iiWithData.getInstanceIdentifier()).get(); + broker.commitConfigurationDataDelete(normalizedII).get(); } - } catch (Exception e) { - throw new RestconfDocumentedException("Error creating data", e); - } - - if (status.getResult() == TransactionStatus.COMMITED) { - return Response.status(Status.OK).build(); + } catch (final Exception e) { + final Optional searchedException = Iterables.tryFind(Throwables.getCausalChain(e), + Predicates.instanceOf(ModifiedNodeDoesNotExistException.class)); + if (searchedException.isPresent()) { + throw new RestconfDocumentedException("Data specified for deleting doesn't exist.", ErrorType.APPLICATION, ErrorTag.DATA_MISSING); + } + throw new RestconfDocumentedException("Error while deleting data", e); } - - return Response.status(Status.INTERNAL_SERVER_ERROR).build(); + return Response.status(Status.OK).build(); } + /** + * Subscribes to some path in schema context (stream) to listen on changes on this stream. + * + * Additional parameters for subscribing to stream are loaded via rpc input parameters: + *
    + *
  • datastore
    • - default CONFIGURATION (other values of {@link LogicalDatastoreType} enum type) + *
  • scope
    • - default BASE (other values of {@link DataChangeScope}) + *
+ */ @Override public Response subscribeToStream(final String identifier, final UriInfo uriInfo) { final String streamName = Notificator.createStreamNameFromUri(identifier); @@ -896,415 +915,205 @@ public class RestconfImpl implements RestconfService { throw new RestconfDocumentedException("Stream was not found.", ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT); } - broker.registerToListenDataChanges(listener); - - final UriBuilder uriBuilder = uriInfo.getAbsolutePathBuilder(); - UriBuilder port = uriBuilder.port(WebSocketServer.getInstance().getPort()); - final URI uriToWebsocketServer = port.replacePath(streamName).build(); - - return Response.status(Status.OK).location(uriToWebsocketServer).build(); - } - - private Module findModule(final MountInstance mountPoint, final CompositeNode data) { - if (data instanceof CompositeNodeWrapper) { - return findModule(mountPoint, (CompositeNodeWrapper) data); - } else if (data != null) { - URI namespace = data.getNodeType().getNamespace(); - if (mountPoint != null) { - return this.controllerContext.findModuleByNamespace(mountPoint, namespace); - } else { - return this.controllerContext.findModuleByNamespace(namespace); - } - } else { - throw new IllegalArgumentException("Unhandled parameter types: " - + Arrays. asList(mountPoint, data).toString()); - } - } - - private Module findModule(final MountInstance mountPoint, final CompositeNodeWrapper data) { - URI namespace = data.getNamespace(); - Preconditions. checkNotNull(namespace); - - Module module = null; - if (mountPoint != null) { - module = this.controllerContext.findModuleByNamespace(mountPoint, namespace); - if (module == null) { - module = this.controllerContext.findModuleByName(mountPoint, namespace.toString()); - } - } else { - module = this.controllerContext.findModuleByNamespace(namespace); - if (module == null) { - module = this.controllerContext.findModuleByName(namespace.toString()); - } + final Map paramToValues = resolveValuesFromUri(identifier); + final LogicalDatastoreType datastore = parserURIEnumParameter(LogicalDatastoreType.class, + paramToValues.get(DATASTORE_PARAM_NAME)); + if (datastore == null) { + throw new RestconfDocumentedException("Stream name doesn't contains datastore value (pattern /datastore=)", + ErrorType.APPLICATION, ErrorTag.MISSING_ATTRIBUTE); } - - return module; - } - - private InstanceIdWithSchemaNode addLastIdentifierFromData(final InstanceIdWithSchemaNode identifierWithSchemaNode, - final CompositeNode data, final DataSchemaNode schemaOfData) { - InstanceIdentifier instanceIdentifier = null; - if (identifierWithSchemaNode != null) { - instanceIdentifier = identifierWithSchemaNode.getInstanceIdentifier(); + final DataChangeScope scope = parserURIEnumParameter(DataChangeScope.class, paramToValues.get(SCOPE_PARAM_NAME)); + if (scope == null) { + throw new RestconfDocumentedException("Stream name doesn't contains datastore value (pattern /scope=)", + ErrorType.APPLICATION, ErrorTag.MISSING_ATTRIBUTE); } - final InstanceIdentifier iiOriginal = instanceIdentifier; - InstanceIdentifierBuilder iiBuilder = null; - if (iiOriginal == null) { - iiBuilder = InstanceIdentifier.builder(); - } else { - iiBuilder = InstanceIdentifier.builder(iiOriginal); - } + broker.registerToListenDataChanges(datastore, scope, listener); - if ((schemaOfData instanceof ListSchemaNode)) { - HashMap keys = this.resolveKeysFromData(((ListSchemaNode) schemaOfData), data); - iiBuilder.nodeWithKey(schemaOfData.getQName(), keys); - } else { - iiBuilder.node(schemaOfData.getQName()); - } - - InstanceIdentifier instance = iiBuilder.toInstance(); - MountInstance mountPoint = null; - if (identifierWithSchemaNode != null) { - mountPoint = identifierWithSchemaNode.getMountPoint(); - } - - return new InstanceIdWithSchemaNode(instance, schemaOfData, mountPoint); - } - - private HashMap resolveKeysFromData(final ListSchemaNode listNode, final CompositeNode dataNode) { - final HashMap keyValues = new HashMap(); - List _keyDefinition = listNode.getKeyDefinition(); - for (final QName key : _keyDefinition) { - SimpleNode head = null; - String localName = key.getLocalName(); - List> simpleNodesByName = dataNode.getSimpleNodesByName(localName); - if (simpleNodesByName != null) { - head = Iterables.getFirst(simpleNodesByName, null); - } - - Object dataNodeKeyValueObject = null; - if (head != null) { - dataNodeKeyValueObject = head.getValue(); - } - - if (dataNodeKeyValueObject == null) { - throw new RestconfDocumentedException("Data contains list \"" + dataNode.getNodeType().getLocalName() - + "\" which does not contain key: \"" + key.getLocalName() + "\"", ErrorType.PROTOCOL, - ErrorTag.INVALID_VALUE); - } - - keyValues.put(key, dataNodeKeyValueObject); - } - - return keyValues; - } - - private boolean endsWithMountPoint(final String identifier) { - return identifier.endsWith(ControllerContext.MOUNT) || identifier.endsWith(ControllerContext.MOUNT + "/"); - } - - private boolean representsMountPointRootData(final CompositeNode data) { - URI namespace = this.namespace(data); - return (SchemaContext.NAME.getNamespace().equals(namespace) /* - * || MOUNT_POINT_MODULE_NAME .equals( namespace . - * toString( ) ) - */) - && SchemaContext.NAME.getLocalName().equals(this.localName(data)); - } - - private String addMountPointIdentifier(final String identifier) { - boolean endsWith = identifier.endsWith("/"); - if (endsWith) { - return (identifier + ControllerContext.MOUNT); + final UriBuilder uriBuilder = uriInfo.getAbsolutePathBuilder(); + int notificationPort = NOTIFICATION_PORT; + try { + final WebSocketServer webSocketServerInstance = WebSocketServer.getInstance(); + notificationPort = webSocketServerInstance.getPort(); + } catch (final NullPointerException e) { + WebSocketServer.createInstance(NOTIFICATION_PORT); } + final UriBuilder uriToWebsocketServerBuilder = uriBuilder.port(notificationPort).scheme("ws"); + final URI uriToWebsocketServer = uriToWebsocketServerBuilder.replacePath(streamName).build(); - return identifier + "/" + ControllerContext.MOUNT; + return Response.status(Status.OK).location(uriToWebsocketServer).build(); } - private CompositeNode normalizeNode(final CompositeNode node, final DataSchemaNode schema, - final MountInstance mountPoint) { - if (schema == null) { - QName nodeType = node == null ? null : node.getNodeType(); - String localName = nodeType == null ? null : nodeType.getLocalName(); - - throw new RestconfDocumentedException("Data schema node was not found for " + localName, - ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); + /** + * Load parameter for subscribing to stream from input composite node + * + * @param compNode + * contains value + * @return enum object if its string value is equal to {@code paramName}. In other cases null. + */ + private T parseEnumTypeParameter(final ContainerNode value, final Class classDescriptor, + final String paramName) { + final Optional> augNode = value.getChild(SAL_REMOTE_AUG_IDENTIFIER); + if (!augNode.isPresent() && !(augNode instanceof AugmentationNode)) { + return null; } - - if (!(schema instanceof DataNodeContainer)) { - throw new RestconfDocumentedException("Root element has to be container or list yang datatype.", - ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); + final Optional> enumNode = + ((AugmentationNode) augNode.get()).getChild(new NodeIdentifier(QName.create(SAL_REMOTE_AUGMENT, paramName))); + if (!enumNode.isPresent()) { + return null; } - - if ((node instanceof CompositeNodeWrapper)) { - boolean isChangeAllowed = ((CompositeNodeWrapper) node).isChangeAllowed(); - if (isChangeAllowed) { - try { - this.normalizeNode(((CompositeNodeWrapper) node), schema, null, mountPoint); - } catch (IllegalArgumentException e) { - throw new RestconfDocumentedException(e.getMessage(), ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); - } - } - - return ((CompositeNodeWrapper) node).unwrap(); + final Object rawValue = enumNode.get().getValue(); + if (!(rawValue instanceof String)) { + return null; } - return node; + return resolveAsEnum(classDescriptor, (String) rawValue); } - private void normalizeNode(final NodeWrapper nodeBuilder, final DataSchemaNode schema, - final QName previousAugment, final MountInstance mountPoint) { - if (schema == null) { - throw new RestconfDocumentedException("Data has bad format.\n\"" + nodeBuilder.getLocalName() - + "\" does not exist in yang schema.", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); - } - - QName currentAugment = null; - if (nodeBuilder.getQname() != null) { - currentAugment = previousAugment; - } else { - currentAugment = this.normalizeNodeName(nodeBuilder, schema, previousAugment, mountPoint); - if (nodeBuilder.getQname() == null) { - throw new RestconfDocumentedException( - "Data has bad format.\nIf data is in XML format then namespace for \"" - + nodeBuilder.getLocalName() + "\" should be \"" + schema.getQName().getNamespace() - + "\".\n" + "If data is in JSON format then module name for \"" - + nodeBuilder.getLocalName() + "\" should be corresponding to namespace \"" - + schema.getQName().getNamespace() + "\".", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); - } - } - - if (nodeBuilder instanceof CompositeNodeWrapper) { - if (schema instanceof DataNodeContainer) { - normalizeCompositeNode((CompositeNodeWrapper) nodeBuilder, (DataNodeContainer) schema, mountPoint, - currentAugment); - } else if (schema instanceof AnyXmlSchemaNode) { - normalizeAnyXmlNode((CompositeNodeWrapper) nodeBuilder, (AnyXmlSchemaNode) schema); - } - } else if (nodeBuilder instanceof SimpleNodeWrapper) { - normalizeSimpleNode((SimpleNodeWrapper) nodeBuilder, schema, mountPoint); - } else if ((nodeBuilder instanceof EmptyNodeWrapper)) { - normalizeEmptyNode((EmptyNodeWrapper) nodeBuilder, schema); + /** + * Checks whether {@code value} is one of the string representation of enumeration {@code classDescriptor} + * + * @return enum object if string value of {@code classDescriptor} enumeration is equal to {@code value}. Other cases + * null. + */ + private T parserURIEnumParameter(final Class classDescriptor, final String value) { + if (Strings.isNullOrEmpty(value)) { + return null; } + return resolveAsEnum(classDescriptor, value); } - private void normalizeAnyXmlNode(final CompositeNodeWrapper compositeNode, final AnyXmlSchemaNode schema) { - List> children = compositeNode.getValues(); - for (NodeWrapper child : children) { - child.setNamespace(schema.getQName().getNamespace()); - if (child instanceof CompositeNodeWrapper) { - normalizeAnyXmlNode((CompositeNodeWrapper) child, schema); + private T resolveAsEnum(final Class classDescriptor, final String value) { + final T[] enumConstants = classDescriptor.getEnumConstants(); + if (enumConstants != null) { + for (final T enm : classDescriptor.getEnumConstants()) { + if (((Enum) enm).name().equals(value)) { + return enm; + } } } + return null; } - private void normalizeEmptyNode(final EmptyNodeWrapper emptyNodeBuilder, final DataSchemaNode schema) { - if ((schema instanceof LeafSchemaNode)) { - emptyNodeBuilder.setComposite(false); - } else { - if ((schema instanceof ContainerSchemaNode)) { - // FIXME: Add presence check - emptyNodeBuilder.setComposite(true); + private Map resolveValuesFromUri(final String uri) { + final Map result = new HashMap<>(); + final String[] tokens = uri.split("/"); + for (int i = 1; i < tokens.length; i++) { + final String[] parameterTokens = tokens[i].split("="); + if (parameterTokens.length == 2) { + result.put(parameterTokens[0], parameterTokens[1]); } } + return result; } - private void normalizeSimpleNode(final SimpleNodeWrapper simpleNode, final DataSchemaNode schema, - final MountInstance mountPoint) { - final Object value = simpleNode.getValue(); - Object inputValue = value; - TypeDefinition typeDefinition = this.typeDefinition(schema); - if ((typeDefinition instanceof IdentityrefTypeDefinition)) { - if ((value instanceof String)) { - inputValue = new IdentityValuesDTO(simpleNode.getNamespace().toString(), (String) value, null, - (String) value); - } // else value is already instance of IdentityValuesDTO - } - - Object outputValue = inputValue; - - if (typeDefinition != null) { - Codec codec = RestCodec.from(typeDefinition, mountPoint); - outputValue = codec == null ? null : codec.deserialize(inputValue); - } - - simpleNode.setValue(outputValue); + public BigInteger getOperationalReceived() { + // TODO Auto-generated method stub + return null; } - private void normalizeCompositeNode(final CompositeNodeWrapper compositeNodeBuilder, - final DataNodeContainer schema, final MountInstance mountPoint, final QName currentAugment) { - final List> children = compositeNodeBuilder.getValues(); - checkNodeMultiplicityAccordingToSchema(schema, children); - for (final NodeWrapper child : children) { - final List potentialSchemaNodes = this.controllerContext.findInstanceDataChildrenByName( - schema, child.getLocalName()); - - if (potentialSchemaNodes.size() > 1 && child.getNamespace() == null) { - StringBuilder builder = new StringBuilder(); - for (final DataSchemaNode potentialSchemaNode : potentialSchemaNodes) { - builder.append(" ").append(potentialSchemaNode.getQName().getNamespace().toString()).append("\n"); - } - - throw new RestconfDocumentedException("Node \"" + child.getLocalName() - + "\" is added as augment from more than one module. " - + "Therefore node must have namespace (XML format) or module name (JSON format)." - + "\nThe node is added as augment from modules with namespaces:\n" + builder, - ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); - } - - boolean rightNodeSchemaFound = false; - for (final DataSchemaNode potentialSchemaNode : potentialSchemaNodes) { - if (!rightNodeSchemaFound) { - final QName potentialCurrentAugment = this.normalizeNodeName(child, potentialSchemaNode, - currentAugment, mountPoint); - if (child.getQname() != null) { - this.normalizeNode(child, potentialSchemaNode, potentialCurrentAugment, mountPoint); - rightNodeSchemaFound = true; - } - } - } - - if (!rightNodeSchemaFound) { - throw new RestconfDocumentedException("Schema node \"" + child.getLocalName() - + "\" was not found in module.", ErrorType.APPLICATION, ErrorTag.UNKNOWN_ELEMENT); - } - } + private MapNode makeModuleMapNode(final Set modules) { + Preconditions.checkNotNull(modules); + final Module restconfModule = getRestconfModule(); + final DataSchemaNode moduleSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode( + restconfModule, Draft02.RestConfModule.MODULE_LIST_SCHEMA_NODE); + Preconditions.checkState(moduleSchemaNode instanceof ListSchemaNode); - if ((schema instanceof ListSchemaNode)) { - ListSchemaNode listSchemaNode = (ListSchemaNode) schema; - final List listKeys = listSchemaNode.getKeyDefinition(); - for (final QName listKey : listKeys) { - boolean foundKey = false; - for (final NodeWrapper child : children) { - if (Objects.equal(child.unwrap().getNodeType().getLocalName(), listKey.getLocalName())) { - foundKey = true; - } - } + final CollectionNodeBuilder listModuleBuilder = Builders + .mapBuilder((ListSchemaNode) moduleSchemaNode); - if (!foundKey) { - throw new RestconfDocumentedException("Missing key in URI \"" + listKey.getLocalName() - + "\" of list \"" + listSchemaNode.getQName().getLocalName() + "\"", ErrorType.PROTOCOL, - ErrorTag.DATA_MISSING); - } - } + for (final Module module : modules) { + listModuleBuilder.withChild(toModuleEntryNode(module, moduleSchemaNode)); } + return listModuleBuilder.build(); } - private void checkNodeMultiplicityAccordingToSchema(final DataNodeContainer dataNodeContainer, - final List> nodes) { - Map equalNodeNamesToCounts = new HashMap(); - for (NodeWrapper child : nodes) { - Integer count = equalNodeNamesToCounts.get(child.getLocalName()); - equalNodeNamesToCounts.put(child.getLocalName(), count == null ? 1 : ++count); - } - - for (DataSchemaNode childSchemaNode : dataNodeContainer.getChildNodes()) { - if (childSchemaNode instanceof ContainerSchemaNode || childSchemaNode instanceof LeafSchemaNode) { - String localName = childSchemaNode.getQName().getLocalName(); - Integer count = equalNodeNamesToCounts.get(localName); - if (count != null && count > 1) { - throw new RestconfDocumentedException("Multiple input data elements were specified for '" - + childSchemaNode.getQName().getLocalName() - + "'. The data for this element type can only be specified once.", ErrorType.APPLICATION, - ErrorTag.BAD_ELEMENT); - } - } - } - } + protected MapEntryNode toModuleEntryNode(final Module module, final DataSchemaNode moduleSchemaNode) { + Preconditions.checkArgument(moduleSchemaNode instanceof ListSchemaNode, + "moduleSchemaNode has to be of type ListSchemaNode"); + final ListSchemaNode listModuleSchemaNode = (ListSchemaNode) moduleSchemaNode; + final DataContainerNodeAttrBuilder moduleNodeValues = Builders + .mapEntryBuilder(listModuleSchemaNode); - private QName normalizeNodeName(final NodeWrapper nodeBuilder, final DataSchemaNode schema, - final QName previousAugment, final MountInstance mountPoint) { - QName validQName = schema.getQName(); - QName currentAugment = previousAugment; - if (schema.isAugmenting()) { - currentAugment = schema.getQName(); - } else if (previousAugment != null - && !Objects.equal(schema.getQName().getNamespace(), previousAugment.getNamespace())) { - validQName = QName.create(currentAugment, schema.getQName().getLocalName()); - } + List instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName( + (listModuleSchemaNode), "name"); + final DataSchemaNode nameSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); + Preconditions.checkState(nameSchemaNode instanceof LeafSchemaNode); + moduleNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) nameSchemaNode).withValue(module.getName()) + .build()); - String moduleName = null; - if (mountPoint == null) { - moduleName = controllerContext.findModuleNameByNamespace(validQName.getNamespace()); - } else { - moduleName = controllerContext.findModuleNameByNamespace(mountPoint, validQName.getNamespace()); - } + instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName( + (listModuleSchemaNode), "revision"); + final DataSchemaNode revisionSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); + Preconditions.checkState(revisionSchemaNode instanceof LeafSchemaNode); + final String revision = REVISION_FORMAT.format(module.getRevision()); + moduleNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) revisionSchemaNode).withValue(revision) + .build()); - if (nodeBuilder.getNamespace() == null || Objects.equal(nodeBuilder.getNamespace(), validQName.getNamespace()) - || Objects.equal(nodeBuilder.getNamespace().toString(), moduleName) /* - * || Note : this check is wrong - - * can never be true as it compares - * a URI with a String not sure what - * the intention is so commented out - * ... Objects . equal ( nodeBuilder - * . getNamespace ( ) , - * MOUNT_POINT_MODULE_NAME ) - */) { + instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName( + (listModuleSchemaNode), "namespace"); + final DataSchemaNode namespaceSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); + Preconditions.checkState(namespaceSchemaNode instanceof LeafSchemaNode); + moduleNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) namespaceSchemaNode) + .withValue(module.getNamespace().toString()).build()); - nodeBuilder.setQname(validQName); + instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName( + (listModuleSchemaNode), "feature"); + final DataSchemaNode featureSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); + Preconditions.checkState(featureSchemaNode instanceof LeafListSchemaNode); + final ListNodeBuilder> featuresBuilder = Builders + .leafSetBuilder((LeafListSchemaNode) featureSchemaNode); + for (final FeatureDefinition feature : module.getFeatures()) { + featuresBuilder.withChild(Builders.leafSetEntryBuilder(((LeafListSchemaNode) featureSchemaNode)) + .withValue(feature.getQName().getLocalName()).build()); } + moduleNodeValues.withChild(featuresBuilder.build()); - return currentAugment; + return moduleNodeValues.build(); } - private URI namespace(final CompositeNode data) { - if (data instanceof CompositeNodeWrapper) { - return ((CompositeNodeWrapper) data).getNamespace(); - } else if (data != null) { - return data.getNodeType().getNamespace(); - } else { - throw new IllegalArgumentException("Unhandled parameter types: " + Arrays. asList(data).toString()); - } - } - - private String localName(final CompositeNode data) { - if (data instanceof CompositeNodeWrapper) { - return ((CompositeNodeWrapper) data).getLocalName(); - } else if (data != null) { - return data.getNodeType().getLocalName(); - } else { - throw new IllegalArgumentException("Unhandled parameter types: " + Arrays. asList(data).toString()); - } - } + protected MapEntryNode toStreamEntryNode(final String streamName, final DataSchemaNode streamSchemaNode) { + Preconditions.checkArgument(streamSchemaNode instanceof ListSchemaNode, + "streamSchemaNode has to be of type ListSchemaNode"); + final ListSchemaNode listStreamSchemaNode = (ListSchemaNode) streamSchemaNode; + final DataContainerNodeAttrBuilder streamNodeValues = Builders + .mapEntryBuilder(listStreamSchemaNode); - private String getName(final CompositeNode data) { - if (data instanceof CompositeNodeWrapper) { - return ((CompositeNodeWrapper) data).getLocalName(); - } else if (data != null) { - return data.getNodeType().getLocalName(); - } else { - throw new IllegalArgumentException("Unhandled parameter types: " + Arrays. asList(data).toString()); - } - } + List instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName( + (listStreamSchemaNode), "name"); + final DataSchemaNode nameSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); + Preconditions.checkState(nameSchemaNode instanceof LeafSchemaNode); + streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) nameSchemaNode).withValue(streamName) + .build()); - private TypeDefinition _typeDefinition(final LeafSchemaNode node) { - TypeDefinition baseType = node.getType(); - while (baseType.getBaseType() != null) { - baseType = baseType.getBaseType(); - } + instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName( + (listStreamSchemaNode), "description"); + final DataSchemaNode descriptionSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); + Preconditions.checkState(descriptionSchemaNode instanceof LeafSchemaNode); + streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) nameSchemaNode) + .withValue("DESCRIPTION_PLACEHOLDER").build()); - return baseType; - } + instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName( + (listStreamSchemaNode), "replay-support"); + final DataSchemaNode replaySupportSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); + Preconditions.checkState(replaySupportSchemaNode instanceof LeafSchemaNode); + streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) replaySupportSchemaNode) + .withValue(Boolean.valueOf(true)).build()); - private TypeDefinition typeDefinition(final LeafListSchemaNode node) { - TypeDefinition baseType = node.getType(); - while (baseType.getBaseType() != null) { - baseType = baseType.getBaseType(); - } + instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName( + (listStreamSchemaNode), "replay-log-creation-time"); + final DataSchemaNode replayLogCreationTimeSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); + Preconditions.checkState(replayLogCreationTimeSchemaNode instanceof LeafSchemaNode); + streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) replayLogCreationTimeSchemaNode) + .withValue("").build()); - return baseType; - } + instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName( + (listStreamSchemaNode), "events"); + final DataSchemaNode eventsSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); + Preconditions.checkState(eventsSchemaNode instanceof LeafSchemaNode); + streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) eventsSchemaNode) + .withValue("").build()); - private TypeDefinition typeDefinition(final DataSchemaNode node) { - if (node instanceof LeafListSchemaNode) { - return typeDefinition((LeafListSchemaNode) node); - } else if (node instanceof LeafSchemaNode) { - return _typeDefinition((LeafSchemaNode) node); - } else if (node instanceof AnyXmlSchemaNode) { - return null; - } else { - throw new IllegalArgumentException("Unhandled parameter types: " + Arrays. asList(node).toString()); - } + return streamNodeValues.build(); } }