/** * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved. * Copyright (c) 2014 Brocade Communication Systems, Inc. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ 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.base.Throwables; import com.google.common.collect.ImmutableList; import com.google.common.collect.Iterables; import com.google.common.collect.Lists; 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.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 javax.ws.rs.core.Response; 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.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.common.impl.util.compat.DataNormalizer; import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint; 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.QNameModule; import org.opendaylight.yangtools.yang.common.RpcResult; import org.opendaylight.yangtools.yang.data.api.CompositeNode; 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.api.YangInstanceIdentifier; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.InstanceIdentifierBuilder; 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.ContainerNode; 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.composite.node.schema.cnsn.parser.CnSnToNormalizedNodeParserFactory; import org.opendaylight.yangtools.yang.data.impl.ImmutableCompositeNode; import org.opendaylight.yangtools.yang.data.impl.NodeFactory; import org.opendaylight.yangtools.yang.data.impl.schema.Builders; 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.model.api.AnyXmlSchemaNode; import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode; import org.opendaylight.yangtools.yang.model.api.DataNodeContainer; import org.opendaylight.yangtools.yang.model.api.DataSchemaNode; import org.opendaylight.yangtools.yang.model.api.FeatureDefinition; import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode; import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode; 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.SchemaPath; import org.opendaylight.yangtools.yang.model.api.TypeDefinition; import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition; import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition; import org.opendaylight.yangtools.yang.model.util.EmptyType; import org.opendaylight.yangtools.yang.model.util.ExtendedType; import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil; import org.opendaylight.yangtools.yang.parser.builder.impl.ContainerSchemaNodeBuilder; import org.opendaylight.yangtools.yang.parser.builder.impl.LeafSchemaNodeBuilder; 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(final String uriParameterName) { this.uriParameterName = uriParameterName; } @Override public String toString() { return uriParameterName; } } private static class TypeDef { public final TypeDefinition typedef; public final QName qName; TypeDef(final TypeDefinition typedef, final QName qName) { this.typedef = typedef; this.qName = qName; } } private final static 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 final static 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 final static 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 Date EVENT_SUBSCRIPTION_AUGMENT_REVISION; 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; static { try { EVENT_SUBSCRIPTION_AUGMENT_REVISION = 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 ); } 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; } public void setControllerContext(final ControllerContext controllerContext) { this.controllerContext = controllerContext; } private RestconfImpl() { } public static RestconfImpl getInstance() { return INSTANCE; } @Override public NormalizedNodeContext getModules(final UriInfo uriInfo) { final Set allModules = controllerContext.getAllModules(); final MapNode allModuleMap = makeModuleMapNode(allModules); final SchemaContext schemaContext = controllerContext.getGlobalSchema(); 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(allModuleMap); return new NormalizedNodeContext(new InstanceIdentifierContext(null, modulesSchemaNode, null, schemaContext), moduleContainerBuilder.build()); } /** * Valid only for mount point */ @Override 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 SchemaContext schemaContext = mountPoint.getSchemaContext(); 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, schemaContext), moduleContainerBuilder.build()); } @Override 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)) { final InstanceIdentifierContext mountPointIdentifier = controllerContext.toMountPointIdentifier(identifier); mountPoint = mountPointIdentifier.getMountPoint(); module = controllerContext.findModuleByNameAndRevision(mountPoint, moduleNameAndRevision); schemaContext = mountPoint.getSchemaContext(); } else { module = controllerContext.findModuleByNameAndRevision(moduleNameAndRevision); schemaContext = controllerContext.getGlobalSchema(); } 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 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 getAvailableStreams(final UriInfo uriInfo) { final Set availableStreams = Notificator.getStreamNames(); final List> streamsAsData = new ArrayList>(); final Module restconfModule = getRestconfModule(); final DataSchemaNode streamSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(restconfModule, Draft02.RestConfModule.STREAM_LIST_SCHEMA_NODE); for (final String streamName : availableStreams) { streamsAsData.add(toStreamCompositeNode(streamName, streamSchemaNode)); } final DataSchemaNode streamsSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(restconfModule, Draft02.RestConfModule.STREAMS_CONTAINER_SCHEMA_NODE); final QName qName = streamsSchemaNode.getQName(); final CompositeNode streamsNode = NodeFactory.createImmutableCompositeNode(qName, null, streamsAsData); return new StructuredData(streamsNode, streamsSchemaNode, null, parsePrettyPrintParameter(uriInfo)); } @Override public StructuredData getOperations(final UriInfo uriInfo) { final Set allModules = controllerContext.getAllModules(); return operationsFromModulesToStructuredData(allModules, null, parsePrettyPrintParameter(uriInfo)); } @Override public StructuredData getOperations(final String identifier, final UriInfo uriInfo) { Set modules = null; DOMMountPoint mountPoint = null; if (identifier.contains(ControllerContext.MOUNT)) { final InstanceIdentifierContext mountPointIdentifier = controllerContext.toMountPointIdentifier(identifier); mountPoint = mountPointIdentifier.getMountPoint(); 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); } return operationsFromModulesToStructuredData(modules, mountPoint, parsePrettyPrintParameter(uriInfo)); } private StructuredData operationsFromModulesToStructuredData(final Set modules, final DOMMountPoint mountPoint, final boolean prettyPrint) { final List> operationsAsData = new ArrayList>(); final Module restconfModule = getRestconfModule(); final DataSchemaNode operationsSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode( restconfModule, Draft02.RestConfModule.OPERATIONS_CONTAINER_SCHEMA_NODE); final QName qName = operationsSchemaNode.getQName(); final SchemaPath path = operationsSchemaNode.getPath(); final ContainerSchemaNodeBuilder containerSchemaNodeBuilder = new ContainerSchemaNodeBuilder( Draft02.RestConfModule.NAME, 0, qName, path); final ContainerSchemaNodeBuilder fakeOperationsSchemaNode = containerSchemaNodeBuilder; for (final Module module : modules) { final Set rpcs = module.getRpcs(); for (final RpcDefinition rpc : rpcs) { final QName rpcQName = rpc.getQName(); final SimpleNode immutableSimpleNode = NodeFactory. createImmutableSimpleNode(rpcQName, null, null); operationsAsData.add(immutableSimpleNode); final String name = module.getName(); final LeafSchemaNodeBuilder leafSchemaNodeBuilder = new LeafSchemaNodeBuilder(name, 0, rpcQName, SchemaPath.create(true, QName.create("dummy"))); final LeafSchemaNodeBuilder fakeRpcSchemaNode = leafSchemaNodeBuilder; fakeRpcSchemaNode.setAugmenting(true); final EmptyType instance = EmptyType.getInstance(); fakeRpcSchemaNode.setType(instance); fakeOperationsSchemaNode.addChildNode(fakeRpcSchemaNode.build()); } } final CompositeNode operationsNode = NodeFactory.createImmutableCompositeNode(qName, null, operationsAsData); final ContainerSchemaNode schemaNode = fakeOperationsSchemaNode.build(); return new StructuredData(operationsNode, schemaNode, mountPoint, prettyPrint); } private Module getRestconfModule() { final Module restconfModule = controllerContext.getRestconfModule(); if (restconfModule == null) { throw new RestconfDocumentedException("ietf-restconf module was not found.", ErrorType.APPLICATION, ErrorTag.OPERATION_NOT_SUPPORTED); } return restconfModule; } private QName getModuleNameAndRevision(final String identifier) { final int mountIndex = identifier.indexOf(ControllerContext.MOUNT); String moduleNameAndRevision = ""; if (mountIndex >= 0) { moduleNameAndRevision = identifier.substring(mountIndex + ControllerContext.MOUNT.length()); } else { moduleNameAndRevision = identifier; } 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( "URI has bad format. End of URI should be in format \'moduleName/yyyy-MM-dd\'", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); } try { final String moduleName = pathArgs.get(0); final String revision = pathArgs.get(1); final Date moduleRevision = REVISION_FORMAT.parse(revision); return QName.create(null, moduleRevision, moduleName); } 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 = ControllerContext.findInstanceDataChildrenByName( ((DataNodeContainer) streamSchemaNode), "name"); final DataSchemaNode nameSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); streamNodeValues .add(NodeFactory. createImmutableSimpleNode(nameSchemaNode.getQName(), null, streamName)); instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName( ((DataNodeContainer) streamSchemaNode), "description"); final DataSchemaNode descriptionSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); streamNodeValues.add(NodeFactory. createImmutableSimpleNode(descriptionSchemaNode.getQName(), null, "DESCRIPTION_PLACEHOLDER")); instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName( ((DataNodeContainer) streamSchemaNode), "replay-support"); final DataSchemaNode replaySupportSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); streamNodeValues.add(NodeFactory. createImmutableSimpleNode(replaySupportSchemaNode.getQName(), null, Boolean.valueOf(true))); instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName( ((DataNodeContainer) streamSchemaNode), "replay-log-creation-time"); final DataSchemaNode replayLogCreationTimeSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); streamNodeValues.add(NodeFactory. createImmutableSimpleNode(replayLogCreationTimeSchemaNode.getQName(), null, "")); instanceDataChildrenByName = 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); } private CompositeNode toModuleCompositeNode(final Module module, final DataSchemaNode moduleSchemaNode) { final List> moduleNodeValues = new ArrayList>(); List instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName( ((DataNodeContainer) moduleSchemaNode), "name"); final DataSchemaNode nameSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); moduleNodeValues.add(NodeFactory. createImmutableSimpleNode(nameSchemaNode.getQName(), null, module.getName())); instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName( ((DataNodeContainer) moduleSchemaNode), "revision"); final DataSchemaNode revisionSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); final Date _revision = module.getRevision(); moduleNodeValues.add(NodeFactory. createImmutableSimpleNode(revisionSchemaNode.getQName(), null, REVISION_FORMAT.format(_revision))); instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName( ((DataNodeContainer) moduleSchemaNode), "namespace"); final DataSchemaNode namespaceSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null); moduleNodeValues.add(NodeFactory. createImmutableSimpleNode(namespaceSchemaNode.getQName(), null, module.getNamespace().toString())); instanceDataChildrenByName = 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())); } return NodeFactory.createImmutableCompositeNode(moduleSchemaNode.getQName(), null, moduleNodeValues); } @Override public Object getRoot() { return null; } @Override public StructuredData invokeRpc(final String identifier, final CompositeNode payload, final UriInfo uriInfo) { final RpcExecutor rpc = resolveIdentifierInInvokeRpc(identifier); final QName rpcName = rpc.getRpcDefinition().getQName(); final 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)); } validateInput(rpc.getRpcDefinition().getInput(), payload); return callRpc(rpc, payload, parsePrettyPrintParameter(uriInfo)); } private void validateInput(final DataSchemaNode inputSchema, final Node payload) { if (inputSchema != null && payload == null) { // expected a non null payload throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE); } else if (inputSchema == null && payload != 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(); if (!(pathValue instanceof YangInstanceIdentifier)) { throw new RestconfDocumentedException("Instance identifier was not normalized correctly.", ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED); } final YangInstanceIdentifier pathIdentifier = ((YangInstanceIdentifier) pathValue); String streamName = null; if (!Iterables.isEmpty(pathIdentifier.getPathArguments())) { final String fullRestconfIdentifier = controllerContext.toFullRestconfIdentifier(pathIdentifier); 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.", 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 MutableCompositeNode responseData = NodeFactory.createMutableCompositeNode(rpc.getOutput().getQName(), null, output, null, null); if (!Notificator.existListenerFor(streamName)) { Notificator.createListener(pathIdentifier, streamName); } return new StructuredData(responseData, rpc.getOutput(), null, prettyPrint); } @Override public StructuredData 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; DOMMountPoint mountPoint = null; if (identifier.contains(ControllerContext.MOUNT)) { // mounted RPC call - look up mount instance. final InstanceIdentifierContext mountPointId = controllerContext.toMountPointIdentifier(identifier); mountPoint = mountPointId.getMountPoint(); final int startOfRemoteRpcName = identifier.lastIndexOf(ControllerContext.MOUNT) + ControllerContext.MOUNT.length() + 1; final String remoteRpcName = identifier.substring(startOfRemoteRpcName); identifierEncoded = remoteRpcName; } else if (identifier.indexOf("/") != CHAR_NOT_FOUND) { final String slashErrorMsg = String.format("Identifier %n%s%ncan\'t contain slash " + "character (/).%nIf slash is part of identifier name then use %%2F placeholder.", identifier); throw new RestconfDocumentedException(slashErrorMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); } else { identifierEncoded = identifier; } final String identifierDecoded = controllerContext.urlPathArgDecode(identifierEncoded); RpcDefinition rpc = null; if (mountPoint == null) { rpc = controllerContext.getRpcDefinition(identifierDecoded); } else { rpc = findRpc(mountPoint.getSchemaContext(), identifierDecoded); } if (rpc == null) { throw new RestconfDocumentedException("RPC does not exist.", ErrorType.RPC, ErrorTag.UNKNOWN_ELEMENT); } if (mountPoint == null) { return new BrokerRpcExecutor(rpc, broker); } else { return new MountPointRpcExecutor(rpc, mountPoint); } } private RpcDefinition findRpc(final SchemaContext schemaContext, final String identifierDecoded) { final String[] splittedIdentifier = identifierDecoded.split(":"); if (splittedIdentifier.length != 2) { throw new RestconfDocumentedException(identifierDecoded + " couldn't be splitted to 2 parts (module:rpc name)", ErrorType.APPLICATION, ErrorTag.INVALID_VALUE); } for (final Module module : schemaContext.getModules()) { if (module.getName().equals(splittedIdentifier[0])) { for (final RpcDefinition rpcDefinition : module.getRpcs()) { if (rpcDefinition.getQName().getLocalName().equals(splittedIdentifier[1])) { return rpcDefinition; } } } } return null; } private StructuredData callRpc(final RpcExecutor rpcExecutor, final CompositeNode payload, final boolean prettyPrint) { if (rpcExecutor == null) { throw new RestconfDocumentedException("RPC does not exist.", ErrorType.RPC, ErrorTag.UNKNOWN_ELEMENT); } CompositeNode rpcRequest = null; final RpcDefinition rpc = rpcExecutor.getRpcDefinition(); final 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); final List> input = Collections.> singletonList(value); rpcRequest = NodeFactory.createMutableCompositeNode(rpcName, null, input, null, null); } final 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) { throw new RestconfDocumentedException("The operation was not successful", null, rpcResult.getErrors()); } } @Override public NormalizedNodeContext readConfigurationData(final String identifier, final UriInfo uriInfo) { final InstanceIdentifierContext iiWithData = controllerContext.toInstanceIdentifier(identifier); final DOMMountPoint mountPoint = iiWithData.getMountPoint(); NormalizedNode data = null; YangInstanceIdentifier normalizedII; if (mountPoint != null) { normalizedII = new DataNormalizer(mountPoint.getSchemaContext()).toNormalized(iiWithData .getInstanceIdentifier()); data = broker.readConfigurationData(mountPoint, normalizedII); } else { normalizedII = controllerContext.toNormalized(iiWithData.getInstanceIdentifier()); data = broker.readConfigurationData(normalizedII); } return new NormalizedNodeContext(iiWithData, data); } @SuppressWarnings("unchecked") private > T pruneDataAtDepth(final T node, final Integer depth) { if (depth == null) { return node; } if (node instanceof CompositeNode) { final ImmutableList.Builder> newChildNodes = ImmutableList.> builder(); if (depth > 1) { for (final Node childNode : ((CompositeNode) node).getValue()) { newChildNodes.add(pruneDataAtDepth(childNode, depth - 1)); } } return (T) ImmutableCompositeNode.create(node.getNodeType(), newChildNodes.build()); } else { // SimpleNode return node; } } private Integer parseDepthParameter(final UriInfo info) { final String param = info.getQueryParameters(false).getFirst(UriParameters.DEPTH.toString()); if (Strings.isNullOrEmpty(param) || "unbounded".equals(param)) { return null; } try { final Integer depth = Integer.valueOf(param); if (depth < 1) { throw new RestconfDocumentedException(new RestconfError(ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE, "Invalid depth parameter: " + depth, null, "The depth parameter must be an integer > 1 or \"unbounded\"")); } return depth; } 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\"")); } } @Override public NormalizedNodeContext readOperationalData(final String identifier, final UriInfo info) { final InstanceIdentifierContext iiWithData = controllerContext.toInstanceIdentifier(identifier); final DOMMountPoint mountPoint = iiWithData.getMountPoint(); NormalizedNode data = null; YangInstanceIdentifier normalizedII; if (mountPoint != null) { normalizedII = new DataNormalizer(mountPoint.getSchemaContext()).toNormalized(iiWithData .getInstanceIdentifier()); data = broker.readOperationalData(mountPoint, normalizedII); } else { normalizedII = controllerContext.toNormalized(iiWithData.getInstanceIdentifier()); data = broker.readOperationalData(normalizedII); } return new NormalizedNodeContext(iiWithData, data); } private boolean parsePrettyPrintParameter(final UriInfo info) { final String param = info.getQueryParameters(false).getFirst(UriParameters.PRETTY_PRINT.toString()); return Boolean.parseBoolean(param); } @Override public Response updateConfigurationData(final String identifier, final Node payload) { final InstanceIdentifierContext iiWithData = controllerContext.toInstanceIdentifier(identifier); validateInput(iiWithData.getSchemaNode(), payload); final DOMMountPoint mountPoint = iiWithData.getMountPoint(); validateTopLevelNodeName(payload, iiWithData.getInstanceIdentifier()); final CompositeNode value = this.normalizeNode(payload, iiWithData.getSchemaNode(), mountPoint); validateListKeysEqualityInPayloadAndUri(iiWithData, value); final NormalizedNode datastoreNormalizedNode = compositeNodeToDatastoreNormalizedNode(value, iiWithData.getSchemaNode()); YangInstanceIdentifier normalizedII; if (mountPoint != null) { normalizedII = new DataNormalizer(mountPoint.getSchemaContext()).toNormalized( iiWithData.getInstanceIdentifier()); } else { normalizedII = controllerContext.toNormalized(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, datastoreNormalizedNode).checkedGet(); } else { broker.commitConfigurationDataPut(normalizedII, datastoreNormalizedNode).checkedGet(); } 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()); } LOG.debug("Got OptimisticLockFailedException - trying again"); } else { throw new RestconfDocumentedException(e.getMessage(), e, e.getErrorList()); } } } return Response.status(Status.OK).build(); } private void validateTopLevelNodeName(final Node node, final YangInstanceIdentifier identifier) { final String payloadName = getName(node); final Iterator pathArguments = identifier.getReversePathArguments().iterator(); //no arguments if (!pathArguments.hasNext()) { //no "data" payload if (!node.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); } } } /** * Validates whether keys in {@code payload} are equal to values of keys in {@code iiWithData} for list schema node * * @throws RestconfDocumentedException * if key values or key count in payload and URI isn't equal * */ private void validateListKeysEqualityInPayloadAndUri(final InstanceIdentifierContext iiWithData, final CompositeNode payload) { if (iiWithData.getSchemaNode() instanceof ListSchemaNode) { final List keyDefinitions = ((ListSchemaNode) iiWithData.getSchemaNode()).getKeyDefinition(); final PathArgument lastPathArgument = iiWithData.getInstanceIdentifier().getLastPathArgument(); if (lastPathArgument instanceof NodeIdentifierWithPredicates) { final Map uriKeyValues = ((NodeIdentifierWithPredicates) lastPathArgument) .getKeyValues(); isEqualUriAndPayloadKeyValues(uriKeyValues, payload, keyDefinitions); } } } private void isEqualUriAndPayloadKeyValues(final Map uriKeyValues, final CompositeNode payload, final List 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); } final 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); } } } @Override public Response createConfigurationData(final String identifier, final Node payload) { if (payload == null) { throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE); } final URI payloadNS = 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); } InstanceIdentifierContext iiWithData = null; CompositeNode value = null; if (representsMountPointRootData(payload)) { // payload represents mount point data and URI represents path to the mount point if (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 = addMountPointIdentifier(identifier); iiWithData = controllerContext.toInstanceIdentifier(completeIdentifier); value = this.normalizeNode(payload, iiWithData.getSchemaNode(), iiWithData.getMountPoint()); } else { final InstanceIdentifierContext incompleteInstIdWithData = controllerContext .toInstanceIdentifier(identifier); final DataNodeContainer parentSchema = (DataNodeContainer) incompleteInstIdWithData.getSchemaNode(); final DOMMountPoint mountPoint = incompleteInstIdWithData.getMountPoint(); final Module module = findModule(mountPoint, payload); final String payloadName = getName(payload); final DataSchemaNode schemaNode = ControllerContext.findInstanceDataChildByNameAndNamespace( parentSchema, payloadName, module.getNamespace()); value = this.normalizeNode(payload, schemaNode, mountPoint); iiWithData = addLastIdentifierFromData(incompleteInstIdWithData, value, schemaNode,incompleteInstIdWithData.getSchemaContext()); } final NormalizedNode datastoreNormalizedData = compositeNodeToDatastoreNormalizedNode(value, iiWithData.getSchemaNode()); final DOMMountPoint mountPoint = iiWithData.getMountPoint(); YangInstanceIdentifier normalizedII; try { if (mountPoint != null) { normalizedII = new DataNormalizer(mountPoint.getSchemaContext()).toNormalized(iiWithData .getInstanceIdentifier()); broker.commitConfigurationDataPost(mountPoint, normalizedII, datastoreNormalizedData); } else { normalizedII = controllerContext.toNormalized(iiWithData.getInstanceIdentifier()); broker.commitConfigurationDataPost(normalizedII, datastoreNormalizedData); } } catch(final RestconfDocumentedException e) { throw e; } catch (final Exception e) { throw new RestconfDocumentedException("Error creating data", e); } return Response.status(Status.NO_CONTENT).build(); } @Override public Response createConfigurationData(final Node payload) { if (payload == null) { throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE); } final URI payloadNS = 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); } final Module module = this.findModule(null, payload); final String payloadName = getName(payload); final DataSchemaNode schemaNode = ControllerContext.findInstanceDataChildByNameAndNamespace(module, payloadName, module.getNamespace()); final CompositeNode value = this.normalizeNode(payload, schemaNode, null); final InstanceIdentifierContext iiWithData = addLastIdentifierFromData(null, value, schemaNode,ControllerContext.getInstance().getGlobalSchema()); final NormalizedNode datastoreNormalizedData = compositeNodeToDatastoreNormalizedNode(value, schemaNode); final DOMMountPoint mountPoint = iiWithData.getMountPoint(); YangInstanceIdentifier normalizedII; try { if (mountPoint != null) { normalizedII = new DataNormalizer(mountPoint.getSchemaContext()).toNormalized(iiWithData .getInstanceIdentifier()); broker.commitConfigurationDataPost(mountPoint, normalizedII, datastoreNormalizedData); } else { normalizedII = controllerContext.toNormalized(iiWithData.getInstanceIdentifier()); broker.commitConfigurationDataPost(normalizedII, datastoreNormalizedData); } } catch(final RestconfDocumentedException e) { throw e; } catch (final Exception e) { throw new RestconfDocumentedException("Error creating data", e); } return Response.status(Status.NO_CONTENT).build(); } @Override public Response deleteConfigurationData(final String identifier) { final InstanceIdentifierContext iiWithData = controllerContext.toInstanceIdentifier(identifier); final DOMMountPoint mountPoint = iiWithData.getMountPoint(); YangInstanceIdentifier normalizedII; try { if (mountPoint != null) { normalizedII = new DataNormalizer(mountPoint.getSchemaContext()).toNormalized(iiWithData .getInstanceIdentifier()); broker.commitConfigurationDataDelete(mountPoint, normalizedII); } else { normalizedII = controllerContext.toNormalized(iiWithData.getInstanceIdentifier()); broker.commitConfigurationDataDelete(normalizedII).get(); } } 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.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); if (Strings.isNullOrEmpty(streamName)) { throw new RestconfDocumentedException("Stream name is empty.", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); } final ListenerAdapter listener = Notificator.getListenerFor(streamName); if (listener == null) { throw new RestconfDocumentedException("Stream was not found.", ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT); } 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); } 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); } broker.registerToListenDataChanges(datastore, scope, listener); 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 port = uriBuilder.port(notificationPort); final URI uriToWebsocketServer = port.replacePath(streamName).build(); return Response.status(Status.OK).location(uriToWebsocketServer).build(); } /** * 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 CompositeNode compNode, final Class classDescriptor, final String paramName) { final QNameModule salRemoteAugment = QNameModule.create(NAMESPACE_EVENT_SUBSCRIPTION_AUGMENT, EVENT_SUBSCRIPTION_AUGMENT_REVISION); final SimpleNode simpleNode = compNode.getFirstSimpleByName(QName.create(salRemoteAugment, paramName)); if (simpleNode == null) { return null; } final Object rawValue = simpleNode.getValue(); if (!(rawValue instanceof String)) { return null; } return resolveAsEnum(classDescriptor, (String) rawValue); } /** * 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 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 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 Module findModule(final DOMMountPoint mountPoint, final Node data) { Module module = null; if (data instanceof NodeWrapper) { module = findModule(mountPoint, (NodeWrapper) data); } else if (data != null) { final URI namespace = data.getNodeType().getNamespace(); if (mountPoint != null) { module = controllerContext.findModuleByNamespace(mountPoint, namespace); } else { module = controllerContext.findModuleByNamespace(namespace); } } if (module != null) { return module; } 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); } private Module findModule(final DOMMountPoint mountPoint, final NodeWrapper data) { final URI namespace = data.getNamespace(); Preconditions. checkNotNull(namespace); Module module = null; if (mountPoint != null) { module = controllerContext.findModuleByNamespace(mountPoint, namespace); if (module == null) { module = controllerContext.findModuleByName(mountPoint, namespace.toString()); } } else { module = controllerContext.findModuleByNamespace(namespace); if (module == null) { module = controllerContext.findModuleByName(namespace.toString()); } } return module; } private InstanceIdentifierContext addLastIdentifierFromData(final InstanceIdentifierContext identifierWithSchemaNode, final CompositeNode data, final DataSchemaNode schemaOfData, final SchemaContext schemaContext) { YangInstanceIdentifier instanceIdentifier = null; if (identifierWithSchemaNode != null) { instanceIdentifier = identifierWithSchemaNode.getInstanceIdentifier(); } final YangInstanceIdentifier iiOriginal = instanceIdentifier; InstanceIdentifierBuilder iiBuilder = null; if (iiOriginal == null) { iiBuilder = YangInstanceIdentifier.builder(); } else { iiBuilder = YangInstanceIdentifier.builder(iiOriginal); } if ((schemaOfData instanceof ListSchemaNode)) { final HashMap keys = resolveKeysFromData(((ListSchemaNode) schemaOfData), data); iiBuilder.nodeWithKey(schemaOfData.getQName(), keys); } else { iiBuilder.node(schemaOfData.getQName()); } final YangInstanceIdentifier instance = iiBuilder.toInstance(); DOMMountPoint mountPoint = null; final SchemaContext schemaCtx = null; if (identifierWithSchemaNode != null) { mountPoint = identifierWithSchemaNode.getMountPoint(); } return new InstanceIdentifierContext(instance, schemaOfData, mountPoint,schemaContext); } private HashMap resolveKeysFromData(final ListSchemaNode listNode, final CompositeNode dataNode) { final HashMap keyValues = new HashMap(); final List _keyDefinition = listNode.getKeyDefinition(); for (final QName key : _keyDefinition) { SimpleNode head = null; final String localName = key.getLocalName(); final 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 Node data) { final URI namespace = namespace(data); return (SchemaContext.NAME.getNamespace().equals(namespace) /* * || MOUNT_POINT_MODULE_NAME .equals( namespace . * toString( ) ) */) && SchemaContext.NAME.getLocalName().equals(localName(data)); } private String addMountPointIdentifier(final String identifier) { final boolean endsWith = identifier.endsWith("/"); if (endsWith) { return (identifier + ControllerContext.MOUNT); } return identifier + "/" + ControllerContext.MOUNT; } private CompositeNode normalizeNode(final Node node, final DataSchemaNode schema, final DOMMountPoint mountPoint) { if (schema == null) { final String localName = node == null ? null : node instanceof NodeWrapper ? ((NodeWrapper)node).getLocalName() : node.getNodeType().getLocalName(); throw new RestconfDocumentedException("Data schema node was not found for " + localName, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); } if (!(schema instanceof DataNodeContainer)) { throw new RestconfDocumentedException("Root element has to be container or list yang datatype.", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); } if ((node instanceof NodeWrapper)) { NodeWrapper nodeWrap = (NodeWrapper) node; final boolean isChangeAllowed = ((NodeWrapper) node).isChangeAllowed(); if (isChangeAllowed) { nodeWrap = topLevelElementAsCompositeNodeWrapper((NodeWrapper) node, schema); try { this.normalizeNode(nodeWrap, schema, null, mountPoint); } catch (final IllegalArgumentException e) { final RestconfDocumentedException restconfDocumentedException = new RestconfDocumentedException(e.getMessage(), ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); restconfDocumentedException.addSuppressed(e); throw restconfDocumentedException; } if (nodeWrap instanceof CompositeNodeWrapper) { return ((CompositeNodeWrapper) nodeWrap).unwrap(); } } } if (node instanceof CompositeNode) { return (CompositeNode) node; } throw new RestconfDocumentedException("Top level element is not interpreted as composite node.", ErrorType.APPLICATION, ErrorTag.INVALID_VALUE); } private void normalizeNode(final NodeWrapper nodeBuilder, final DataSchemaNode schema, final QName previousAugment, final DOMMountPoint 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 = 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); } } private void normalizeAnyXmlNode(final CompositeNodeWrapper compositeNode, final AnyXmlSchemaNode schema) { final List> children = compositeNode.getValues(); for (final NodeWrapper child : children) { child.setNamespace(schema.getQName().getNamespace()); if (child instanceof CompositeNodeWrapper) { normalizeAnyXmlNode((CompositeNodeWrapper) child, schema); } } } 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 void normalizeSimpleNode(final SimpleNodeWrapper simpleNode, final DataSchemaNode schema, final DOMMountPoint mountPoint) { final Object value = simpleNode.getValue(); Object inputValue = value; final TypeDef typeDef = this.typeDefinition(schema); TypeDefinition typeDefinition = typeDef != null ? typeDef.typedef : null; // For leafrefs, extract the type it is pointing to if(typeDefinition instanceof LeafrefTypeDefinition) { if (schema.getQName().equals(typeDef.qName)) { typeDefinition = SchemaContextUtil.getBaseTypeForLeafRef(((LeafrefTypeDefinition) typeDefinition), mountPoint == null ? controllerContext.getGlobalSchema() : mountPoint.getSchemaContext(), schema); } else { typeDefinition = SchemaContextUtil.getBaseTypeForLeafRef(((LeafrefTypeDefinition) typeDefinition), mountPoint == null ? controllerContext.getGlobalSchema() : mountPoint.getSchemaContext(), typeDef.qName); } } if (typeDefinition instanceof IdentityrefTypeDefinition) { inputValue = parseToIdentityValuesDTO(simpleNode, value, inputValue); } Object outputValue = inputValue; if (typeDefinition != null) { final Codec codec = RestCodec.from(typeDefinition, mountPoint); outputValue = codec == null ? null : codec.deserialize(inputValue); } simpleNode.setValue(outputValue); } private Object parseToIdentityValuesDTO(final SimpleNodeWrapper simpleNode, final Object value, Object inputValue) { if ((value instanceof String)) { inputValue = new IdentityValuesDTO(simpleNode.getNamespace().toString(), (String) value, null, (String) value); } // else value is already instance of IdentityValuesDTO return inputValue; } private void normalizeCompositeNode(final CompositeNodeWrapper compositeNodeBuilder, final DataNodeContainer schema, final DOMMountPoint mountPoint, final QName currentAugment) { final List> children = compositeNodeBuilder.getValues(); checkNodeMultiplicityAccordingToSchema(schema, children); for (final NodeWrapper child : children) { final List potentialSchemaNodes = ControllerContext.findInstanceDataChildrenByName( schema, child.getLocalName()); if (potentialSchemaNodes.size() > 1 && child.getNamespace() == null) { final 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 = 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); } } if ((schema instanceof ListSchemaNode)) { final 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; } } if (!foundKey) { throw new RestconfDocumentedException("Missing key in URI \"" + listKey.getLocalName() + "\" of list \"" + listSchemaNode.getQName().getLocalName() + "\"", ErrorType.PROTOCOL, ErrorTag.DATA_MISSING); } } } } private void checkNodeMultiplicityAccordingToSchema(final DataNodeContainer dataNodeContainer, final List> nodes) { final Map equalNodeNamesToCounts = new HashMap(); for (final NodeWrapper child : nodes) { Integer count = equalNodeNamesToCounts.get(child.getLocalName()); equalNodeNamesToCounts.put(child.getLocalName(), count == null ? 1 : ++count); } for (final DataSchemaNode childSchemaNode : dataNodeContainer.getChildNodes()) { if (childSchemaNode instanceof ContainerSchemaNode || childSchemaNode instanceof LeafSchemaNode) { final String localName = childSchemaNode.getQName().getLocalName(); final 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); } } } } private QName normalizeNodeName(final NodeWrapper nodeBuilder, final DataSchemaNode schema, final QName previousAugment, final DOMMountPoint 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()); } String moduleName = null; if (mountPoint == null) { moduleName = controllerContext.findModuleNameByNamespace(validQName.getNamespace()); } else { moduleName = controllerContext.findModuleNameByNamespace(mountPoint, validQName.getNamespace()); } 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 ) */ nodeBuilder.setQname(validQName); } return currentAugment; } private URI namespace(final Node data) { if (data instanceof NodeWrapper) { return ((NodeWrapper) 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 Node data) { if (data instanceof NodeWrapper) { return ((NodeWrapper) data).getLocalName(); } else if (data != null) { return data.getNodeType().getLocalName(); } else { throw new IllegalArgumentException("Unhandled parameter types: " + Arrays. asList(data).toString()); } } private String getName(final Node data) { if (data instanceof NodeWrapper) { return ((NodeWrapper) data).getLocalName(); } else if (data != null) { return data.getNodeType().getLocalName(); } else { throw new IllegalArgumentException("Unhandled parameter types: " + Arrays. asList(data).toString()); } } private TypeDef typeDefinition(final TypeDefinition type, final QName nodeQName) { TypeDefinition baseType = type; QName qName = nodeQName; while (baseType.getBaseType() != null) { if (baseType instanceof ExtendedType) { qName = baseType.getQName(); } baseType = baseType.getBaseType(); } return new TypeDef(baseType, qName); } private TypeDef typeDefinition(final DataSchemaNode node) { if (node instanceof LeafListSchemaNode) { return typeDefinition(((LeafListSchemaNode)node).getType(), node.getQName()); } else if (node instanceof LeafSchemaNode) { return typeDefinition(((LeafSchemaNode)node).getType(), node.getQName()); } else if (node instanceof AnyXmlSchemaNode) { return null; } else { throw new IllegalArgumentException("Unhandled parameter types: " + Arrays. asList(node).toString()); } } private CompositeNode datastoreNormalizedNodeToCompositeNode(final NormalizedNode dataNode, final DataSchemaNode schema) { Node nodes = null; if (dataNode == null) { throw new RestconfDocumentedException(new RestconfError(ErrorType.APPLICATION, ErrorTag.DATA_MISSING, "No data was found.")); } nodes = DataNormalizer.toLegacy(dataNode); if (nodes != null) { if (nodes instanceof CompositeNode) { return (CompositeNode) nodes; } else { LOG.error("The node " + dataNode.getNodeType() + " couldn't be transformed to compositenode."); } } else { LOG.error("Top level node isn't of type Container or List schema node but " + schema.getClass().getSimpleName()); } throw new RestconfDocumentedException(new RestconfError(ErrorType.APPLICATION, ErrorTag.INVALID_VALUE, "It wasn't possible to correctly interpret data.")); } private NormalizedNode compositeNodeToDatastoreNormalizedNode(final CompositeNode compNode, final DataSchemaNode schema) { final List> lst = new ArrayList>(); lst.add(compNode); if (schema instanceof ContainerSchemaNode) { return CnSnToNormalizedNodeParserFactory.getInstance().getContainerNodeParser() .parse(lst, (ContainerSchemaNode) schema); } else if (schema instanceof ListSchemaNode) { return CnSnToNormalizedNodeParserFactory.getInstance().getMapEntryNodeParser() .parse(lst, (ListSchemaNode) schema); } LOG.error("Top level isn't of type container, list, leaf schema node but " + schema.getClass().getSimpleName()); throw new RestconfDocumentedException(new RestconfError(ErrorType.APPLICATION, ErrorTag.INVALID_VALUE, "It wasn't possible to translate specified data to datastore readable form.")); } private InstanceIdentifierContext normalizeInstanceIdentifierWithSchemaNode( final InstanceIdentifierContext iiWithSchemaNode) { return normalizeInstanceIdentifierWithSchemaNode(iiWithSchemaNode, false); } private InstanceIdentifierContext normalizeInstanceIdentifierWithSchemaNode( final InstanceIdentifierContext iiWithSchemaNode, final boolean unwrapLastListNode) { return new InstanceIdentifierContext(instanceIdentifierToReadableFormForNormalizeNode( iiWithSchemaNode.getInstanceIdentifier(), unwrapLastListNode), iiWithSchemaNode.getSchemaNode(), iiWithSchemaNode.getMountPoint(),iiWithSchemaNode.getSchemaContext()); } private YangInstanceIdentifier instanceIdentifierToReadableFormForNormalizeNode( final YangInstanceIdentifier instIdentifier, final boolean unwrapLastListNode) { Preconditions.checkNotNull(instIdentifier, "Instance identifier can't be null"); final List result = new ArrayList(); final Iterator iter = instIdentifier.getPathArguments().iterator(); while (iter.hasNext()) { final PathArgument pathArgument = iter.next(); if (pathArgument instanceof NodeIdentifierWithPredicates && (iter.hasNext() || unwrapLastListNode)) { result.add(new YangInstanceIdentifier.NodeIdentifier(pathArgument.getNodeType())); } result.add(pathArgument); } return YangInstanceIdentifier.create(result); } private CompositeNodeWrapper topLevelElementAsCompositeNodeWrapper(final NodeWrapper node, final DataSchemaNode schemaNode) { if (node instanceof CompositeNodeWrapper) { return (CompositeNodeWrapper) node; } else if (node instanceof SimpleNodeWrapper && isDataContainerNode(schemaNode)) { final SimpleNodeWrapper simpleNodeWrapper = (SimpleNodeWrapper) node; return new CompositeNodeWrapper(namespace(simpleNodeWrapper), localName(simpleNodeWrapper)); } throw new RestconfDocumentedException(new RestconfError(ErrorType.APPLICATION, ErrorTag.INVALID_VALUE, "Top level element has to be composite node or has to represent data container node.")); } private boolean isDataContainerNode(final DataSchemaNode schemaNode) { if (schemaNode instanceof ContainerSchemaNode || schemaNode instanceof ListSchemaNode) { return true; } return false; } public BigInteger getOperationalReceived() { // TODO Auto-generated method stub return null; } 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); final CollectionNodeBuilder listModuleBuilder = Builders .mapBuilder((ListSchemaNode) moduleSchemaNode); for (final Module module : modules) { listModuleBuilder.withChild(toModuleEntryNode(module, moduleSchemaNode)); } return listModuleBuilder.build(); } 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); 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()); 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()); 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()); 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 moduleNodeValues.build(); } }