2 * Copyright (c) 2014, 2015 Brocade Communication Systems, Inc., Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.netconf.sal.restconf.impl;
11 import com.google.common.base.CharMatcher;
12 import com.google.common.base.Optional;
13 import com.google.common.base.Preconditions;
14 import com.google.common.base.Predicate;
15 import com.google.common.base.Predicates;
16 import com.google.common.base.Splitter;
17 import com.google.common.base.Strings;
18 import com.google.common.base.Throwables;
19 import com.google.common.collect.Iterables;
20 import com.google.common.collect.Lists;
21 import com.google.common.collect.Maps;
22 import com.google.common.collect.Sets;
23 import com.google.common.util.concurrent.CheckedFuture;
24 import com.google.common.util.concurrent.Futures;
25 import java.math.BigInteger;
27 import java.net.URISyntaxException;
28 import java.text.ParseException;
29 import java.text.SimpleDateFormat;
30 import java.util.ArrayList;
31 import java.util.Collections;
32 import java.util.Date;
33 import java.util.HashMap;
34 import java.util.List;
37 import java.util.concurrent.CancellationException;
38 import java.util.concurrent.ExecutionException;
39 import javax.ws.rs.core.Response;
40 import javax.ws.rs.core.Response.ResponseBuilder;
41 import javax.ws.rs.core.Response.Status;
42 import javax.ws.rs.core.UriBuilder;
43 import javax.ws.rs.core.UriInfo;
44 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
45 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
46 import org.opendaylight.controller.md.sal.common.api.data.OptimisticLockFailedException;
47 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
48 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
49 import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
50 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
51 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
52 import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult;
53 import org.opendaylight.netconf.md.sal.rest.common.RestconfValidationUtils;
54 import org.opendaylight.netconf.sal.rest.api.Draft02;
55 import org.opendaylight.netconf.sal.rest.api.RestconfService;
56 import org.opendaylight.netconf.sal.restconf.impl.RestconfError.ErrorTag;
57 import org.opendaylight.netconf.sal.restconf.impl.RestconfError.ErrorType;
58 import org.opendaylight.netconf.sal.streams.listeners.ListenerAdapter;
59 import org.opendaylight.netconf.sal.streams.listeners.Notificator;
60 import org.opendaylight.netconf.sal.streams.websockets.WebSocketServer;
61 import org.opendaylight.yangtools.yang.common.QName;
62 import org.opendaylight.yangtools.yang.common.QNameModule;
63 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
64 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
65 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
66 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
67 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
68 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
69 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
70 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
71 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
72 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
73 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
74 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
75 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModifiedNodeDoesNotExistException;
76 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
77 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
78 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
79 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
80 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
81 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
82 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
83 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
84 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
85 import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
86 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
87 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
88 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
89 import org.opendaylight.yangtools.yang.model.api.Module;
90 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
91 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
92 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
93 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
94 import org.opendaylight.yangtools.yang.model.util.EmptyType;
95 import org.opendaylight.yangtools.yang.parser.builder.api.GroupingBuilder;
96 import org.opendaylight.yangtools.yang.parser.builder.impl.ContainerSchemaNodeBuilder;
97 import org.opendaylight.yangtools.yang.parser.builder.impl.LeafSchemaNodeBuilder;
98 import org.opendaylight.yangtools.yang.parser.builder.impl.ModuleBuilder;
99 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
100 import org.slf4j.Logger;
101 import org.slf4j.LoggerFactory;
103 public class RestconfImpl implements RestconfService {
105 private static final RestconfImpl INSTANCE = new RestconfImpl();
107 private static final int NOTIFICATION_PORT = 8181;
109 private static final int CHAR_NOT_FOUND = -1;
111 private static final SimpleDateFormat REVISION_FORMAT = new SimpleDateFormat("yyyy-MM-dd");
113 private static final String SAL_REMOTE_NAMESPACE = "urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote";
115 private static final String SAL_REMOTE_RPC_SUBSRCIBE = "create-data-change-event-subscription";
117 private BrokerFacade broker;
119 private ControllerContext controllerContext;
121 private static final Logger LOG = LoggerFactory.getLogger(RestconfImpl.class);
123 private static final DataChangeScope DEFAULT_SCOPE = DataChangeScope.BASE;
125 private static final LogicalDatastoreType DEFAULT_DATASTORE = LogicalDatastoreType.CONFIGURATION;
127 private static final URI NAMESPACE_EVENT_SUBSCRIPTION_AUGMENT = URI.create("urn:sal:restconf:event:subscription");
129 private static final String DATASTORE_PARAM_NAME = "datastore";
131 private static final String SCOPE_PARAM_NAME = "scope";
133 private static final String NETCONF_BASE = "urn:ietf:params:xml:ns:netconf:base:1.0";
135 private static final String NETCONF_BASE_PAYLOAD_NAME = "data";
137 private static final QName NETCONF_BASE_QNAME;
139 private static final QNameModule SAL_REMOTE_AUGMENT;
141 private static final YangInstanceIdentifier.AugmentationIdentifier SAL_REMOTE_AUG_IDENTIFIER;
145 final Date eventSubscriptionAugRevision = new SimpleDateFormat("yyyy-MM-dd").parse("2014-07-08");
146 NETCONF_BASE_QNAME = QName.create(QNameModule.create(new URI(NETCONF_BASE), null), NETCONF_BASE_PAYLOAD_NAME );
147 SAL_REMOTE_AUGMENT = QNameModule.create(NAMESPACE_EVENT_SUBSCRIPTION_AUGMENT,
148 eventSubscriptionAugRevision);
149 SAL_REMOTE_AUG_IDENTIFIER = new YangInstanceIdentifier.AugmentationIdentifier(Sets.newHashSet(QName.create(SAL_REMOTE_AUGMENT, "scope"),
150 QName.create(SAL_REMOTE_AUGMENT, "datastore")));
151 } catch (final ParseException e) {
152 final String errMsg = "It wasn't possible to convert revision date of sal-remote-augment to date";
154 throw new RestconfDocumentedException(errMsg, ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED);
155 } catch (final URISyntaxException e) {
156 final String errMsg = "It wasn't possible to create instance of URI class with "+NETCONF_BASE+" URI";
157 throw new RestconfDocumentedException(errMsg, ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED);
161 public void setBroker(final BrokerFacade broker) {
162 this.broker = broker;
165 public void setControllerContext(final ControllerContext controllerContext) {
166 this.controllerContext = controllerContext;
169 private RestconfImpl() {
172 public static RestconfImpl getInstance() {
177 public NormalizedNodeContext getModules(final UriInfo uriInfo) {
178 final Set<Module> allModules = controllerContext.getAllModules();
179 final MapNode allModuleMap = makeModuleMapNode(allModules);
181 final SchemaContext schemaContext = controllerContext.getGlobalSchema();
183 final Module restconfModule = getRestconfModule();
184 final DataSchemaNode modulesSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(
185 restconfModule, Draft02.RestConfModule.MODULES_CONTAINER_SCHEMA_NODE);
186 Preconditions.checkState(modulesSchemaNode instanceof ContainerSchemaNode);
188 final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> moduleContainerBuilder =
189 Builders.containerBuilder((ContainerSchemaNode) modulesSchemaNode);
190 moduleContainerBuilder.withChild(allModuleMap);
192 return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, modulesSchemaNode,
193 null, schemaContext), moduleContainerBuilder.build(),
194 QueryParametersParser.parseWriterParameters(uriInfo));
198 * Valid only for mount point
201 public NormalizedNodeContext getModules(final String identifier, final UriInfo uriInfo) {
202 Preconditions.checkNotNull(identifier);
203 if ( ! identifier.contains(ControllerContext.MOUNT)) {
204 final String errMsg = "URI has bad format. If modules behind mount point should be showed,"
205 + " URI has to end with " + ControllerContext.MOUNT;
206 LOG.debug(errMsg + " for " + identifier);
207 throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
210 final InstanceIdentifierContext<?> mountPointIdentifier = controllerContext.toMountPointIdentifier(identifier);
211 final DOMMountPoint mountPoint = mountPointIdentifier.getMountPoint();
212 final Set<Module> modules = controllerContext.getAllModules(mountPoint);
213 final MapNode mountPointModulesMap = makeModuleMapNode(modules);
215 final Module restconfModule = getRestconfModule();
216 final DataSchemaNode modulesSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(
217 restconfModule, Draft02.RestConfModule.MODULES_CONTAINER_SCHEMA_NODE);
218 Preconditions.checkState(modulesSchemaNode instanceof ContainerSchemaNode);
220 final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> moduleContainerBuilder =
221 Builders.containerBuilder((ContainerSchemaNode) modulesSchemaNode);
222 moduleContainerBuilder.withChild(mountPointModulesMap);
224 return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, modulesSchemaNode,
225 mountPoint, controllerContext.getGlobalSchema()), moduleContainerBuilder.build(),
226 QueryParametersParser.parseWriterParameters(uriInfo));
230 public NormalizedNodeContext getModule(final String identifier, final UriInfo uriInfo) {
231 Preconditions.checkNotNull(identifier);
232 final QName moduleNameAndRevision = getModuleNameAndRevision(identifier);
233 Module module = null;
234 DOMMountPoint mountPoint = null;
235 final SchemaContext schemaContext;
236 if (identifier.contains(ControllerContext.MOUNT)) {
237 final InstanceIdentifierContext<?> mountPointIdentifier = controllerContext.toMountPointIdentifier(identifier);
238 mountPoint = mountPointIdentifier.getMountPoint();
239 module = controllerContext.findModuleByNameAndRevision(mountPoint, moduleNameAndRevision);
240 schemaContext = mountPoint.getSchemaContext();
242 module = controllerContext.findModuleByNameAndRevision(moduleNameAndRevision);
243 schemaContext = controllerContext.getGlobalSchema();
246 if (module == null) {
247 final String errMsg = "Module with name '" + moduleNameAndRevision.getLocalName()
248 + "' and revision '" + moduleNameAndRevision.getRevision() + "' was not found.";
250 throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT);
253 final Module restconfModule = getRestconfModule();
254 final Set<Module> modules = Collections.singleton(module);
255 final MapNode moduleMap = makeModuleMapNode(modules);
257 final DataSchemaNode moduleSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(
258 restconfModule, Draft02.RestConfModule.MODULE_LIST_SCHEMA_NODE);
259 Preconditions.checkState(moduleSchemaNode instanceof ListSchemaNode);
261 return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, moduleSchemaNode, mountPoint,
262 schemaContext), moduleMap, QueryParametersParser.parseWriterParameters(uriInfo));
266 public NormalizedNodeContext getAvailableStreams(final UriInfo uriInfo) {
267 final SchemaContext schemaContext = controllerContext.getGlobalSchema();
268 final Set<String> availableStreams = Notificator.getStreamNames();
269 final Module restconfModule = getRestconfModule();
270 final DataSchemaNode streamSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(restconfModule,
271 Draft02.RestConfModule.STREAM_LIST_SCHEMA_NODE);
272 Preconditions.checkState(streamSchemaNode instanceof ListSchemaNode);
274 final CollectionNodeBuilder<MapEntryNode, MapNode> listStreamsBuilder = Builders
275 .mapBuilder((ListSchemaNode) streamSchemaNode);
277 for (final String streamName : availableStreams) {
278 listStreamsBuilder.withChild(toStreamEntryNode(streamName, streamSchemaNode));
281 final DataSchemaNode streamsContainerSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(
282 restconfModule, Draft02.RestConfModule.STREAMS_CONTAINER_SCHEMA_NODE);
283 Preconditions.checkState(streamsContainerSchemaNode instanceof ContainerSchemaNode);
285 final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> streamsContainerBuilder =
286 Builders.containerBuilder((ContainerSchemaNode) streamsContainerSchemaNode);
287 streamsContainerBuilder.withChild(listStreamsBuilder.build());
290 return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, streamsContainerSchemaNode, null,
291 schemaContext), streamsContainerBuilder.build(), QueryParametersParser.parseWriterParameters(uriInfo));
295 public NormalizedNodeContext getOperations(final UriInfo uriInfo) {
296 final Set<Module> allModules = controllerContext.getAllModules();
297 return operationsFromModulesToNormalizedContext(allModules, null);
301 public NormalizedNodeContext getOperations(final String identifier, final UriInfo uriInfo) {
302 Set<Module> modules = null;
303 DOMMountPoint mountPoint = null;
304 if (identifier.contains(ControllerContext.MOUNT)) {
305 final InstanceIdentifierContext<?> mountPointIdentifier = controllerContext.toMountPointIdentifier(identifier);
306 mountPoint = mountPointIdentifier.getMountPoint();
307 modules = controllerContext.getAllModules(mountPoint);
310 final String errMsg = "URI has bad format. If operations behind mount point should be showed, URI has to end with ";
311 LOG.debug(errMsg + ControllerContext.MOUNT + " for " + identifier);
312 throw new RestconfDocumentedException(errMsg + ControllerContext.MOUNT, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
315 return operationsFromModulesToNormalizedContext(modules, mountPoint);
318 private static final Predicate<GroupingBuilder> GROUPING_FILTER = new Predicate<GroupingBuilder>() {
320 public boolean apply(final GroupingBuilder g) {
321 return Draft02.RestConfModule.RESTCONF_GROUPING_SCHEMA_NODE.equals(g.getQName().getLocalName());
325 private NormalizedNodeContext operationsFromModulesToNormalizedContext(final Set<Module> modules,
326 final DOMMountPoint mountPoint) {
328 final Module restconfModule = getRestconfModule();
329 final ModuleBuilder restConfModuleBuilder = new ModuleBuilder(restconfModule);
330 final Set<GroupingBuilder> gropingBuilders = restConfModuleBuilder.getGroupingBuilders();
331 final Iterable<GroupingBuilder> filteredGroups = Iterables.filter(gropingBuilders, GROUPING_FILTER);
332 final GroupingBuilder restconfGroupingBuilder = Iterables.getFirst(filteredGroups, null);
333 final ContainerSchemaNodeBuilder restContainerSchemaNodeBuilder = (ContainerSchemaNodeBuilder) restconfGroupingBuilder
334 .getDataChildByName(Draft02.RestConfModule.RESTCONF_CONTAINER_SCHEMA_NODE);
335 final ContainerSchemaNodeBuilder containerSchemaNodeBuilder = (ContainerSchemaNodeBuilder) restContainerSchemaNodeBuilder
336 .getDataChildByName(Draft02.RestConfModule.OPERATIONS_CONTAINER_SCHEMA_NODE);
338 final ContainerSchemaNodeBuilder fakeOperationsSchemaNodeBuilder = containerSchemaNodeBuilder;
339 final SchemaPath fakeSchemaPath = fakeOperationsSchemaNodeBuilder.getPath().createChild(QName.create("dummy"));
341 final List<LeafNode<Object>> operationsAsData = new ArrayList<>();
343 for (final Module module : modules) {
344 final Set<RpcDefinition> rpcs = module.getRpcs();
345 for (final RpcDefinition rpc : rpcs) {
346 final QName rpcQName = rpc.getQName();
347 final String name = module.getName();
349 final QName qName = QName.create(restconfModule.getQNameModule(), rpcQName.getLocalName());
350 final LeafSchemaNodeBuilder leafSchemaNodeBuilder = new LeafSchemaNodeBuilder(name, 0, qName, fakeSchemaPath);
351 final LeafSchemaNodeBuilder fakeRpcSchemaNodeBuilder = leafSchemaNodeBuilder;
352 fakeRpcSchemaNodeBuilder.setAugmenting(true);
354 final EmptyType instance = EmptyType.getInstance();
355 fakeRpcSchemaNodeBuilder.setType(instance);
356 final LeafSchemaNode fakeRpcSchemaNode = fakeRpcSchemaNodeBuilder.build();
357 fakeOperationsSchemaNodeBuilder.addChildNode(fakeRpcSchemaNode);
359 final LeafNode<Object> leaf = Builders.leafBuilder(fakeRpcSchemaNode).build();
360 operationsAsData.add(leaf);
364 final ContainerSchemaNode operContainerSchemaNode = fakeOperationsSchemaNodeBuilder.build();
365 final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> operContainerNode = Builders.containerBuilder(operContainerSchemaNode);
367 for (final LeafNode<Object> oper : operationsAsData) {
368 operContainerNode.withChild(oper);
371 final Set<Module> fakeRpcModules = Collections.singleton(restConfModuleBuilder.build());
373 final YangParserImpl yangParser = new YangParserImpl();
374 final SchemaContext fakeSchemaCx = yangParser.resolveSchemaContext(fakeRpcModules);
376 final InstanceIdentifierContext<?> fakeIICx = new InstanceIdentifierContext<>(null, operContainerSchemaNode, mountPoint, fakeSchemaCx);
378 return new NormalizedNodeContext(fakeIICx, operContainerNode.build());
381 private Module getRestconfModule() {
382 final Module restconfModule = controllerContext.getRestconfModule();
383 if (restconfModule == null) {
384 LOG.debug("ietf-restconf module was not found.");
385 throw new RestconfDocumentedException("ietf-restconf module was not found.", ErrorType.APPLICATION,
386 ErrorTag.OPERATION_NOT_SUPPORTED);
389 return restconfModule;
392 private static QName getModuleNameAndRevision(final String identifier) {
393 final int mountIndex = identifier.indexOf(ControllerContext.MOUNT);
394 String moduleNameAndRevision = "";
395 if (mountIndex >= 0) {
396 moduleNameAndRevision = identifier.substring(mountIndex + ControllerContext.MOUNT.length());
398 moduleNameAndRevision = identifier;
401 final Splitter splitter = Splitter.on("/").omitEmptyStrings();
402 final Iterable<String> split = splitter.split(moduleNameAndRevision);
403 final List<String> pathArgs = Lists.<String> newArrayList(split);
404 if (pathArgs.size() < 2) {
405 LOG.debug("URI has bad format. It should be \'moduleName/yyyy-MM-dd\' " + identifier);
406 throw new RestconfDocumentedException(
407 "URI has bad format. End of URI should be in format \'moduleName/yyyy-MM-dd\'", ErrorType.PROTOCOL,
408 ErrorTag.INVALID_VALUE);
412 final String moduleName = pathArgs.get(0);
413 final String revision = pathArgs.get(1);
414 final Date moduleRevision = REVISION_FORMAT.parse(revision);
415 return QName.create(null, moduleRevision, moduleName);
416 } catch (final ParseException e) {
417 LOG.debug("URI has bad format. It should be \'moduleName/yyyy-MM-dd\' " + identifier);
418 throw new RestconfDocumentedException("URI has bad format. It should be \'moduleName/yyyy-MM-dd\'",
419 ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
424 public Object getRoot() {
429 public NormalizedNodeContext invokeRpc(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
430 final SchemaPath type = payload.getInstanceIdentifierContext().getSchemaNode().getPath();
431 final URI namespace = payload.getInstanceIdentifierContext().getSchemaNode().getQName().getNamespace();
432 final CheckedFuture<DOMRpcResult, DOMRpcException> response;
433 final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
434 final SchemaContext schemaContext;
435 if (mountPoint != null) {
436 final Optional<DOMRpcService> mountRpcServices = mountPoint.getService(DOMRpcService.class);
437 if ( ! mountRpcServices.isPresent()) {
438 LOG.debug("Error: Rpc service is missing.");
439 throw new RestconfDocumentedException("Rpc service is missing.");
441 schemaContext = mountPoint.getSchemaContext();
442 response = mountRpcServices.get().invokeRpc(type, payload.getData());
444 if (namespace.toString().equals(SAL_REMOTE_NAMESPACE)) {
445 response = invokeSalRemoteRpcSubscribeRPC(payload);
447 response = broker.invokeRpc(type, payload.getData());
449 schemaContext = controllerContext.getGlobalSchema();
452 final DOMRpcResult result = checkRpcResponse(response);
454 RpcDefinition resultNodeSchema = null;
455 final NormalizedNode<?, ?> resultData = result.getResult();
456 if (result != null && result.getResult() != null) {
457 resultNodeSchema = (RpcDefinition) payload.getInstanceIdentifierContext().getSchemaNode();
460 return new NormalizedNodeContext(new InstanceIdentifierContext<RpcDefinition>(null,
461 resultNodeSchema, mountPoint, schemaContext), resultData,
462 QueryParametersParser.parseWriterParameters(uriInfo));
465 private static DOMRpcResult checkRpcResponse(final CheckedFuture<DOMRpcResult, DOMRpcException> response) {
466 if (response == null) {
470 final DOMRpcResult retValue = response.get();
471 if (retValue.getErrors() == null || retValue.getErrors().isEmpty()) {
474 LOG.debug("RpcError message", retValue.getErrors());
475 throw new RestconfDocumentedException("RpcError message", null, retValue.getErrors());
476 } catch (final InterruptedException e) {
477 final String errMsg = "The operation was interrupted while executing and did not complete.";
478 LOG.debug("Rpc Interrupt - " + errMsg, e);
479 throw new RestconfDocumentedException(errMsg, ErrorType.RPC, ErrorTag.PARTIAL_OPERATION);
480 } catch (final ExecutionException e) {
481 LOG.debug("Execution RpcError: ", e);
482 Throwable cause = e.getCause();
484 while (cause.getCause() != null) {
485 cause = cause.getCause();
488 if (cause instanceof IllegalArgumentException) {
489 throw new RestconfDocumentedException(cause.getMessage(), ErrorType.PROTOCOL,
490 ErrorTag.INVALID_VALUE);
492 throw new RestconfDocumentedException("The operation encountered an unexpected error while executing.",cause);
494 throw new RestconfDocumentedException("The operation encountered an unexpected error while executing.",e);
496 } catch (final CancellationException e) {
497 final String errMsg = "The operation was cancelled while executing.";
498 LOG.debug("Cancel RpcExecution: " + errMsg, e);
499 throw new RestconfDocumentedException(errMsg, ErrorType.RPC, ErrorTag.PARTIAL_OPERATION);
503 private static void validateInput(final SchemaNode inputSchema, final NormalizedNodeContext payload) {
504 if (inputSchema != null && payload.getData() == null) {
505 // expected a non null payload
506 throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
507 } else if (inputSchema == null && payload.getData() != null) {
508 // did not expect any input
509 throw new RestconfDocumentedException("No input expected.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
513 // TODO: Validate "mandatory" and "config" values here??? Or should those be
515 // validate in a more central location inside MD-SAL core.
519 private CheckedFuture<DOMRpcResult, DOMRpcException> invokeSalRemoteRpcSubscribeRPC(final NormalizedNodeContext payload) {
520 final ContainerNode value = (ContainerNode) payload.getData();
521 final QName rpcQName = payload.getInstanceIdentifierContext().getSchemaNode().getQName();
522 final Optional<DataContainerChild<? extends PathArgument, ?>> path = value.getChild(new NodeIdentifier(
523 QName.create(payload.getInstanceIdentifierContext().getSchemaNode().getQName(), "path")));
524 final Object pathValue = path.isPresent() ? path.get().getValue() : null;
526 if (!(pathValue instanceof YangInstanceIdentifier)) {
527 final String errMsg = "Instance identifier was not normalized correctly ";
528 LOG.debug(errMsg + rpcQName);
529 throw new RestconfDocumentedException(errMsg, ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED);
532 final YangInstanceIdentifier pathIdentifier = ((YangInstanceIdentifier) pathValue);
533 String streamName = null;
534 if (!pathIdentifier.isEmpty()) {
535 final String fullRestconfIdentifier = controllerContext.toFullRestconfIdentifier(pathIdentifier, null);
537 LogicalDatastoreType datastore = parseEnumTypeParameter(value, LogicalDatastoreType.class, DATASTORE_PARAM_NAME);
538 datastore = datastore == null ? DEFAULT_DATASTORE : datastore;
540 DataChangeScope scope = parseEnumTypeParameter(value, DataChangeScope.class, SCOPE_PARAM_NAME);
541 scope = scope == null ? DEFAULT_SCOPE : scope;
543 streamName = Notificator.createStreamNameFromUri(fullRestconfIdentifier + "/datastore=" + datastore
544 + "/scope=" + scope);
547 if (Strings.isNullOrEmpty(streamName)) {
548 final String errMsg = "Path is empty or contains value node which is not Container or List build-in type.";
549 LOG.debug(errMsg + pathIdentifier);
550 throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
553 final QName outputQname = QName.create(rpcQName, "output");
554 final QName streamNameQname = QName.create(rpcQName, "stream-name");
556 final ContainerNode output = ImmutableContainerNodeBuilder.create().withNodeIdentifier(new NodeIdentifier(outputQname))
557 .withChild(ImmutableNodes.leafNode(streamNameQname, streamName)).build();
559 if (!Notificator.existListenerFor(streamName)) {
560 Notificator.createListener(pathIdentifier, streamName);
563 final DOMRpcResult defaultDOMRpcResult = new DefaultDOMRpcResult(output);
565 return Futures.immediateCheckedFuture(defaultDOMRpcResult);
569 public NormalizedNodeContext invokeRpc(final String identifier, final String noPayload, final UriInfo uriInfo) {
570 if (noPayload != null && !CharMatcher.WHITESPACE.matchesAllOf(noPayload)) {
571 throw new RestconfDocumentedException("Content must be empty.", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
574 String identifierEncoded = null;
575 DOMMountPoint mountPoint = null;
576 final SchemaContext schemaContext;
577 if (identifier.contains(ControllerContext.MOUNT)) {
578 // mounted RPC call - look up mount instance.
579 final InstanceIdentifierContext<?> mountPointId = controllerContext.toMountPointIdentifier(identifier);
580 mountPoint = mountPointId.getMountPoint();
581 schemaContext = mountPoint.getSchemaContext();
582 final int startOfRemoteRpcName = identifier.lastIndexOf(ControllerContext.MOUNT)
583 + ControllerContext.MOUNT.length() + 1;
584 final String remoteRpcName = identifier.substring(startOfRemoteRpcName);
585 identifierEncoded = remoteRpcName;
587 } else if (identifier.indexOf("/") != CHAR_NOT_FOUND) {
588 final String slashErrorMsg = String.format("Identifier %n%s%ncan\'t contain slash "
589 + "character (/).%nIf slash is part of identifier name then use %%2F placeholder.", identifier);
590 LOG.debug(slashErrorMsg);
591 throw new RestconfDocumentedException(slashErrorMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
593 identifierEncoded = identifier;
594 schemaContext = controllerContext.getGlobalSchema();
597 final String identifierDecoded = controllerContext.urlPathArgDecode(identifierEncoded);
599 RpcDefinition rpc = null;
600 if (mountPoint == null) {
601 rpc = controllerContext.getRpcDefinition(identifierDecoded);
603 rpc = findRpc(mountPoint.getSchemaContext(), identifierDecoded);
607 LOG.debug("RPC " + identifierDecoded + " does not exist.");
608 throw new RestconfDocumentedException("RPC does not exist.", ErrorType.RPC, ErrorTag.UNKNOWN_ELEMENT);
611 if (rpc.getInput() != null) {
612 LOG.debug("RPC " + rpc + " does not need input value.");
613 // FIXME : find a correct Error from specification
614 throw new IllegalStateException("RPC " + rpc + " does'n need input value!");
617 final CheckedFuture<DOMRpcResult, DOMRpcException> response;
618 if (mountPoint != null) {
619 final Optional<DOMRpcService> mountRpcServices = mountPoint.getService(DOMRpcService.class);
620 if ( ! mountRpcServices.isPresent()) {
621 throw new RestconfDocumentedException("Rpc service is missing.");
623 response = mountRpcServices.get().invokeRpc(rpc.getPath(), null);
625 response = broker.invokeRpc(rpc.getPath(), null);
628 final DOMRpcResult result = checkRpcResponse(response);
630 return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, rpc, mountPoint, schemaContext),
631 result.getResult(), QueryParametersParser.parseWriterParameters(uriInfo));
634 private static RpcDefinition findRpc(final SchemaContext schemaContext, final String identifierDecoded) {
635 final String[] splittedIdentifier = identifierDecoded.split(":");
636 if (splittedIdentifier.length != 2) {
637 final String errMsg = identifierDecoded + " couldn't be splitted to 2 parts (module:rpc name)";
639 throw new RestconfDocumentedException(errMsg, ErrorType.APPLICATION, ErrorTag.INVALID_VALUE);
641 for (final Module module : schemaContext.getModules()) {
642 if (module.getName().equals(splittedIdentifier[0])) {
643 for (final RpcDefinition rpcDefinition : module.getRpcs()) {
644 if (rpcDefinition.getQName().getLocalName().equals(splittedIdentifier[1])) {
645 return rpcDefinition;
654 public NormalizedNodeContext readConfigurationData(final String identifier, final UriInfo uriInfo) {
655 final InstanceIdentifierContext<?> iiWithData = controllerContext.toInstanceIdentifier(identifier);
656 final DOMMountPoint mountPoint = iiWithData.getMountPoint();
657 NormalizedNode<?, ?> data = null;
658 final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
659 if (mountPoint != null) {
660 data = broker.readConfigurationData(mountPoint, normalizedII);
662 data = broker.readConfigurationData(normalizedII);
665 final String errMsg = "Request could not be completed because the relevant data model content does not exist ";
666 LOG.debug(errMsg + identifier);
667 throw new RestconfDocumentedException(errMsg, ErrorType.APPLICATION, ErrorTag.DATA_MISSING);
669 return new NormalizedNodeContext(iiWithData, data, QueryParametersParser.parseWriterParameters(uriInfo));
673 public NormalizedNodeContext readOperationalData(final String identifier, final UriInfo uriInfo) {
674 final InstanceIdentifierContext<?> iiWithData = controllerContext.toInstanceIdentifier(identifier);
675 final DOMMountPoint mountPoint = iiWithData.getMountPoint();
676 NormalizedNode<?, ?> data = null;
677 final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
678 if (mountPoint != null) {
679 data = broker.readOperationalData(mountPoint, normalizedII);
681 data = broker.readOperationalData(normalizedII);
684 final String errMsg = "Request could not be completed because the relevant data model content does not exist ";
685 LOG.debug(errMsg + identifier);
686 throw new RestconfDocumentedException(errMsg , ErrorType.APPLICATION, ErrorTag.DATA_MISSING);
688 return new NormalizedNodeContext(iiWithData, data, QueryParametersParser.parseWriterParameters(uriInfo));
692 public Response updateConfigurationData(final String identifier, final NormalizedNodeContext payload) {
693 Preconditions.checkNotNull(identifier);
694 final InstanceIdentifierContext<?> iiWithData = payload.getInstanceIdentifierContext();
696 validateInput(iiWithData.getSchemaNode(), payload);
697 validateTopLevelNodeName(payload, iiWithData.getInstanceIdentifier());
698 validateListKeysEqualityInPayloadAndUri(payload);
700 final DOMMountPoint mountPoint = iiWithData.getMountPoint();
701 final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
704 * There is a small window where another write transaction could be updating the same data
705 * simultaneously and we get an OptimisticLockFailedException. This error is likely
706 * transient and The WriteTransaction#submit API docs state that a retry will likely
707 * succeed. So we'll try again if that scenario occurs. If it fails a third time then it
708 * probably will never succeed so we'll fail in that case.
710 * By retrying we're attempting to hide the internal implementation of the data store and
711 * how it handles concurrent updates from the restconf client. The client has instructed us
712 * to put the data and we should make every effort to do so without pushing optimistic lock
713 * failures back to the client and forcing them to handle it via retry (and having to
714 * document the behavior).
719 if (mountPoint != null) {
720 broker.commitConfigurationDataPut(mountPoint, normalizedII, payload.getData()).checkedGet();
722 broker.commitConfigurationDataPut(controllerContext.getGlobalSchema(), normalizedII, payload.getData()).checkedGet();
726 } catch (final TransactionCommitFailedException e) {
727 if(e instanceof OptimisticLockFailedException) {
729 LOG.debug("Got OptimisticLockFailedException on last try - failing " + identifier);
730 throw new RestconfDocumentedException(e.getMessage(), e, e.getErrorList());
733 LOG.debug("Got OptimisticLockFailedException - trying again " + identifier);
735 LOG.debug("Update ConfigDataStore fail " + identifier, e);
736 throw new RestconfDocumentedException(e.getMessage(), e, e.getErrorList());
738 } catch (Exception e) {
739 final String errMsg = "Error updating data ";
740 LOG.debug(errMsg + identifier, e);
741 throw new RestconfDocumentedException(errMsg, e);
745 return Response.status(Status.OK).build();
748 private static void validateTopLevelNodeName(final NormalizedNodeContext node,
749 final YangInstanceIdentifier identifier) {
751 final String payloadName = node.getData().getNodeType().getLocalName();
754 if (identifier.isEmpty()) {
756 if (!node.getData().getNodeType().equals(NETCONF_BASE_QNAME)) {
757 throw new RestconfDocumentedException("Instance identifier has to contain at least one path argument",
758 ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
762 final String identifierName = identifier.getLastPathArgument().getNodeType().getLocalName();
763 if (!payloadName.equals(identifierName)) {
764 throw new RestconfDocumentedException("Payload name (" + payloadName
765 + ") is different from identifier name (" + identifierName + ")", ErrorType.PROTOCOL,
766 ErrorTag.MALFORMED_MESSAGE);
772 * Validates whether keys in {@code payload} are equal to values of keys in {@code iiWithData} for list schema node
774 * @throws RestconfDocumentedException
775 * if key values or key count in payload and URI isn't equal
778 private static void validateListKeysEqualityInPayloadAndUri(final NormalizedNodeContext payload) {
779 Preconditions.checkArgument(payload != null);
780 final InstanceIdentifierContext<?> iiWithData = payload.getInstanceIdentifierContext();
781 final PathArgument lastPathArgument = iiWithData.getInstanceIdentifier().getLastPathArgument();
782 final SchemaNode schemaNode = iiWithData.getSchemaNode();
783 final NormalizedNode<?, ?> data = payload.getData();
784 if (schemaNode instanceof ListSchemaNode) {
785 final List<QName> keyDefinitions = ((ListSchemaNode) schemaNode).getKeyDefinition();
786 if (lastPathArgument instanceof NodeIdentifierWithPredicates && data instanceof MapEntryNode) {
787 final Map<QName, Object> uriKeyValues = ((NodeIdentifierWithPredicates) lastPathArgument).getKeyValues();
788 isEqualUriAndPayloadKeyValues(uriKeyValues, (MapEntryNode) data, keyDefinitions);
793 private static void isEqualUriAndPayloadKeyValues(final Map<QName, Object> uriKeyValues,
794 final MapEntryNode payload, final List<QName> keyDefinitions) {
796 final Map<QName, Object> mutableCopyUriKeyValues = Maps.newHashMap(uriKeyValues);
797 for (final QName keyDefinition : keyDefinitions) {
798 final Object uriKeyValue = mutableCopyUriKeyValues.remove(keyDefinition);
799 // should be caught during parsing URI to InstanceIdentifier
800 RestconfValidationUtils.checkDocumentedError(uriKeyValue != null, ErrorType.PROTOCOL, ErrorTag.DATA_MISSING,
801 "Missing key " + keyDefinition + " in URI.");
803 final Object dataKeyValue = payload.getIdentifier().getKeyValues().get(keyDefinition);
805 if ( ! uriKeyValue.equals(dataKeyValue)) {
806 final String errMsg = "The value '" + uriKeyValue + "' for key '" + keyDefinition.getLocalName() +
807 "' specified in the URI doesn't match the value '" + dataKeyValue + "' specified in the message body. ";
808 throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
814 public Response createConfigurationData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
815 return createConfigurationData(payload, uriInfo);
818 // FIXME create RestconfIdetifierHelper and move this method there
819 private static YangInstanceIdentifier checkConsistencyOfNormalizedNodeContext(final NormalizedNodeContext payload) {
820 Preconditions.checkArgument(payload != null);
821 Preconditions.checkArgument(payload.getData() != null);
822 Preconditions.checkArgument(payload.getData().getNodeType() != null);
823 Preconditions.checkArgument(payload.getInstanceIdentifierContext() != null);
824 Preconditions.checkArgument(payload.getInstanceIdentifierContext().getInstanceIdentifier() != null);
826 final QName payloadNodeQname = payload.getData().getNodeType();
827 final YangInstanceIdentifier yangIdent = payload.getInstanceIdentifierContext().getInstanceIdentifier();
828 if (payloadNodeQname.compareTo(yangIdent.getLastPathArgument().getNodeType()) > 0) {
831 final InstanceIdentifierContext<?> parentContext = payload.getInstanceIdentifierContext();
832 final SchemaNode parentSchemaNode = parentContext.getSchemaNode();
833 if(parentSchemaNode instanceof DataNodeContainer) {
834 final DataNodeContainer cast = (DataNodeContainer) parentSchemaNode;
835 for (final DataSchemaNode child : cast.getChildNodes()) {
836 if (payloadNodeQname.compareTo(child.getQName()) == 0) {
837 return YangInstanceIdentifier.builder(yangIdent).node(child.getQName()).build();
841 if (parentSchemaNode instanceof RpcDefinition) {
844 final String errMsg = "Error parsing input: DataSchemaNode has not children ";
845 LOG.info(errMsg + yangIdent);
846 throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
850 public Response createConfigurationData(final NormalizedNodeContext payload, final UriInfo uriInfo) {
851 if (payload == null) {
852 throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
855 // FIXME: move this to parsing stage (we can have augmentation nodes here which do not have namespace)
856 // final URI payloadNS = payload.getData().getNodeType().getNamespace();
857 // if (payloadNS == null) {
858 // throw new RestconfDocumentedException(
859 // "Data has bad format. Root element node must have namespace (XML format) or module name(JSON format)",
860 // ErrorType.PROTOCOL, ErrorTag.UNKNOWN_NAMESPACE);
863 final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
864 final InstanceIdentifierContext<?> iiWithData = payload.getInstanceIdentifierContext();
865 final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
867 if (mountPoint != null) {
868 broker.commitConfigurationDataPost(mountPoint, normalizedII, payload.getData()).checkedGet();
870 broker.commitConfigurationDataPost(controllerContext.getGlobalSchema(), normalizedII, payload.getData()).checkedGet();
872 } catch(final RestconfDocumentedException e) {
874 } catch (final Exception e) {
875 final String errMsg = "Error creating data ";
876 LOG.info(errMsg + (uriInfo != null ? uriInfo.getPath() : ""), e);
877 throw new RestconfDocumentedException(errMsg, e);
880 final ResponseBuilder responseBuilder = Response.status(Status.NO_CONTENT);
881 // FIXME: Provide path to result.
882 final URI location = resolveLocation(uriInfo, "", mountPoint, normalizedII);
883 if (location != null) {
884 responseBuilder.location(location);
886 return responseBuilder.build();
889 private URI resolveLocation(final UriInfo uriInfo, final String uriBehindBase, final DOMMountPoint mountPoint, final YangInstanceIdentifier normalizedII) {
890 if(uriInfo == null) {
891 // This is null if invoked internally
895 final UriBuilder uriBuilder = uriInfo.getBaseUriBuilder();
896 uriBuilder.path("config");
898 uriBuilder.path(controllerContext.toFullRestconfIdentifier(normalizedII, mountPoint));
899 } catch (final Exception e) {
900 LOG.info("Location for instance identifier" + normalizedII + "wasn't created", e);
903 return uriBuilder.build();
907 public Response deleteConfigurationData(final String identifier) {
908 final InstanceIdentifierContext<?> iiWithData = controllerContext.toInstanceIdentifier(identifier);
909 final DOMMountPoint mountPoint = iiWithData.getMountPoint();
910 final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
913 if (mountPoint != null) {
914 broker.commitConfigurationDataDelete(mountPoint, normalizedII);
916 broker.commitConfigurationDataDelete(normalizedII).get();
918 } catch (final Exception e) {
919 final Optional<Throwable> searchedException = Iterables.tryFind(Throwables.getCausalChain(e),
920 Predicates.instanceOf(ModifiedNodeDoesNotExistException.class));
921 if (searchedException.isPresent()) {
922 throw new RestconfDocumentedException("Data specified for deleting doesn't exist.", ErrorType.APPLICATION, ErrorTag.DATA_MISSING);
924 final String errMsg = "Error while deleting data";
926 throw new RestconfDocumentedException(errMsg, e);
928 return Response.status(Status.OK).build();
932 * Subscribes to some path in schema context (stream) to listen on changes on this stream.
934 * Additional parameters for subscribing to stream are loaded via rpc input parameters:
936 * <li>datastore - default CONFIGURATION (other values of {@link LogicalDatastoreType} enum type)</li>
937 * <li>scope - default BASE (other values of {@link DataChangeScope})</li>
941 public Response subscribeToStream(final String identifier, final UriInfo uriInfo) {
942 final String streamName = Notificator.createStreamNameFromUri(identifier);
943 if (Strings.isNullOrEmpty(streamName)) {
944 throw new RestconfDocumentedException("Stream name is empty.", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
947 final ListenerAdapter listener = Notificator.getListenerFor(streamName);
948 if (listener == null) {
949 throw new RestconfDocumentedException("Stream was not found.", ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT);
952 final Map<String, String> paramToValues = resolveValuesFromUri(identifier);
953 final LogicalDatastoreType datastore = parserURIEnumParameter(LogicalDatastoreType.class,
954 paramToValues.get(DATASTORE_PARAM_NAME));
955 if (datastore == null) {
956 throw new RestconfDocumentedException("Stream name doesn't contains datastore value (pattern /datastore=)",
957 ErrorType.APPLICATION, ErrorTag.MISSING_ATTRIBUTE);
959 final DataChangeScope scope = parserURIEnumParameter(DataChangeScope.class, paramToValues.get(SCOPE_PARAM_NAME));
961 throw new RestconfDocumentedException("Stream name doesn't contains datastore value (pattern /scope=)",
962 ErrorType.APPLICATION, ErrorTag.MISSING_ATTRIBUTE);
965 broker.registerToListenDataChanges(datastore, scope, listener);
967 final UriBuilder uriBuilder = uriInfo.getAbsolutePathBuilder();
968 int notificationPort = NOTIFICATION_PORT;
970 final WebSocketServer webSocketServerInstance = WebSocketServer.getInstance();
971 notificationPort = webSocketServerInstance.getPort();
972 } catch (final NullPointerException e) {
973 WebSocketServer.createInstance(NOTIFICATION_PORT);
975 final UriBuilder uriToWebsocketServerBuilder = uriBuilder.port(notificationPort).scheme("ws");
976 final URI uriToWebsocketServer = uriToWebsocketServerBuilder.replacePath(streamName).build();
978 return Response.status(Status.OK).location(uriToWebsocketServer).build();
982 * Load parameter for subscribing to stream from input composite node
986 * @return enum object if its string value is equal to {@code paramName}. In other cases null.
988 private static <T> T parseEnumTypeParameter(final ContainerNode value, final Class<T> classDescriptor,
989 final String paramName) {
990 final Optional<DataContainerChild<? extends PathArgument, ?>> augNode = value.getChild(SAL_REMOTE_AUG_IDENTIFIER);
991 if (!augNode.isPresent() && !(augNode instanceof AugmentationNode)) {
994 final Optional<DataContainerChild<? extends PathArgument, ?>> enumNode =
995 ((AugmentationNode) augNode.get()).getChild(new NodeIdentifier(QName.create(SAL_REMOTE_AUGMENT, paramName)));
996 if (!enumNode.isPresent()) {
999 final Object rawValue = enumNode.get().getValue();
1000 if (!(rawValue instanceof String)) {
1004 return resolveAsEnum(classDescriptor, (String) rawValue);
1008 * Checks whether {@code value} is one of the string representation of enumeration {@code classDescriptor}
1010 * @return enum object if string value of {@code classDescriptor} enumeration is equal to {@code value}. Other cases
1013 private static <T> T parserURIEnumParameter(final Class<T> classDescriptor, final String value) {
1014 if (Strings.isNullOrEmpty(value)) {
1017 return resolveAsEnum(classDescriptor, value);
1020 private static <T> T resolveAsEnum(final Class<T> classDescriptor, final String value) {
1021 final T[] enumConstants = classDescriptor.getEnumConstants();
1022 if (enumConstants != null) {
1023 for (final T enm : classDescriptor.getEnumConstants()) {
1024 if (((Enum<?>) enm).name().equals(value)) {
1032 private static Map<String, String> resolveValuesFromUri(final String uri) {
1033 final Map<String, String> result = new HashMap<>();
1034 final String[] tokens = uri.split("/");
1035 for (int i = 1; i < tokens.length; i++) {
1036 final String[] parameterTokens = tokens[i].split("=");
1037 if (parameterTokens.length == 2) {
1038 result.put(parameterTokens[0], parameterTokens[1]);
1044 public BigInteger getOperationalReceived() {
1045 // TODO Auto-generated method stub
1049 private MapNode makeModuleMapNode(final Set<Module> modules) {
1050 Preconditions.checkNotNull(modules);
1051 final Module restconfModule = getRestconfModule();
1052 final DataSchemaNode moduleSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(
1053 restconfModule, Draft02.RestConfModule.MODULE_LIST_SCHEMA_NODE);
1054 Preconditions.checkState(moduleSchemaNode instanceof ListSchemaNode);
1056 final CollectionNodeBuilder<MapEntryNode, MapNode> listModuleBuilder = Builders
1057 .mapBuilder((ListSchemaNode) moduleSchemaNode);
1059 for (final Module module : modules) {
1060 listModuleBuilder.withChild(toModuleEntryNode(module, moduleSchemaNode));
1062 return listModuleBuilder.build();
1065 protected MapEntryNode toModuleEntryNode(final Module module, final DataSchemaNode moduleSchemaNode) {
1066 Preconditions.checkArgument(moduleSchemaNode instanceof ListSchemaNode,
1067 "moduleSchemaNode has to be of type ListSchemaNode");
1068 final ListSchemaNode listModuleSchemaNode = (ListSchemaNode) moduleSchemaNode;
1069 final DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> moduleNodeValues = Builders
1070 .mapEntryBuilder(listModuleSchemaNode);
1072 List<DataSchemaNode> instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1073 (listModuleSchemaNode), "name");
1074 final DataSchemaNode nameSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1075 Preconditions.checkState(nameSchemaNode instanceof LeafSchemaNode);
1076 moduleNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) nameSchemaNode).withValue(module.getName())
1079 instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1080 (listModuleSchemaNode), "revision");
1081 final DataSchemaNode revisionSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1082 Preconditions.checkState(revisionSchemaNode instanceof LeafSchemaNode);
1083 final String revision = REVISION_FORMAT.format(module.getRevision());
1084 moduleNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) revisionSchemaNode).withValue(revision)
1087 instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1088 (listModuleSchemaNode), "namespace");
1089 final DataSchemaNode namespaceSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1090 Preconditions.checkState(namespaceSchemaNode instanceof LeafSchemaNode);
1091 moduleNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) namespaceSchemaNode)
1092 .withValue(module.getNamespace().toString()).build());
1094 instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1095 (listModuleSchemaNode), "feature");
1096 final DataSchemaNode featureSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1097 Preconditions.checkState(featureSchemaNode instanceof LeafListSchemaNode);
1098 final ListNodeBuilder<Object, LeafSetEntryNode<Object>> featuresBuilder = Builders
1099 .leafSetBuilder((LeafListSchemaNode) featureSchemaNode);
1100 for (final FeatureDefinition feature : module.getFeatures()) {
1101 featuresBuilder.withChild(Builders.leafSetEntryBuilder(((LeafListSchemaNode) featureSchemaNode))
1102 .withValue(feature.getQName().getLocalName()).build());
1104 moduleNodeValues.withChild(featuresBuilder.build());
1106 return moduleNodeValues.build();
1109 protected MapEntryNode toStreamEntryNode(final String streamName, final DataSchemaNode streamSchemaNode) {
1110 Preconditions.checkArgument(streamSchemaNode instanceof ListSchemaNode,
1111 "streamSchemaNode has to be of type ListSchemaNode");
1112 final ListSchemaNode listStreamSchemaNode = (ListSchemaNode) streamSchemaNode;
1113 final DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> streamNodeValues = Builders
1114 .mapEntryBuilder(listStreamSchemaNode);
1116 List<DataSchemaNode> instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1117 (listStreamSchemaNode), "name");
1118 final DataSchemaNode nameSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1119 Preconditions.checkState(nameSchemaNode instanceof LeafSchemaNode);
1120 streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) nameSchemaNode).withValue(streamName)
1123 instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1124 (listStreamSchemaNode), "description");
1125 final DataSchemaNode descriptionSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1126 Preconditions.checkState(descriptionSchemaNode instanceof LeafSchemaNode);
1127 streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) nameSchemaNode)
1128 .withValue("DESCRIPTION_PLACEHOLDER").build());
1130 instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1131 (listStreamSchemaNode), "replay-support");
1132 final DataSchemaNode replaySupportSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1133 Preconditions.checkState(replaySupportSchemaNode instanceof LeafSchemaNode);
1134 streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) replaySupportSchemaNode)
1135 .withValue(Boolean.valueOf(true)).build());
1137 instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1138 (listStreamSchemaNode), "replay-log-creation-time");
1139 final DataSchemaNode replayLogCreationTimeSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1140 Preconditions.checkState(replayLogCreationTimeSchemaNode instanceof LeafSchemaNode);
1141 streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) replayLogCreationTimeSchemaNode)
1142 .withValue("").build());
1144 instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1145 (listStreamSchemaNode), "events");
1146 final DataSchemaNode eventsSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1147 Preconditions.checkState(eventsSchemaNode instanceof LeafSchemaNode);
1148 streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) eventsSchemaNode)
1149 .withValue("").build());
1151 return streamNodeValues.build();