Merge "Cleanup: Remove passing around of DataPersistenceProvider"
[controller.git] / opendaylight / md-sal / sal-rest-connector / src / main / java / org / opendaylight / controller / sal / restconf / impl / RestconfImpl.java
1 /**
2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
3  * Copyright (c) 2014 Brocade Communication Systems, Inc.
4  *
5  * This program and the accompanying materials are made available under the
6  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
7  * and is available at http://www.eclipse.org/legal/epl-v10.html
8  */
9 package org.opendaylight.controller.sal.restconf.impl;
10
11 import com.google.common.base.Optional;
12 import com.google.common.base.Preconditions;
13 import com.google.common.base.Predicates;
14 import com.google.common.base.Splitter;
15 import com.google.common.base.Strings;
16 import com.google.common.base.Throwables;
17 import com.google.common.collect.Iterables;
18 import com.google.common.collect.Lists;
19 import com.google.common.collect.Sets;
20 import com.google.common.util.concurrent.CheckedFuture;
21 import com.google.common.util.concurrent.Futures;
22 import java.math.BigInteger;
23 import java.net.URI;
24 import java.net.URISyntaxException;
25 import java.text.ParseException;
26 import java.text.SimpleDateFormat;
27 import java.util.Collections;
28 import java.util.Date;
29 import java.util.HashMap;
30 import java.util.Iterator;
31 import java.util.List;
32 import java.util.Map;
33 import java.util.Set;
34 import java.util.concurrent.CancellationException;
35 import java.util.concurrent.ExecutionException;
36 import javax.ws.rs.core.Response;
37 import javax.ws.rs.core.Response.ResponseBuilder;
38 import javax.ws.rs.core.Response.Status;
39 import javax.ws.rs.core.UriBuilder;
40 import javax.ws.rs.core.UriInfo;
41 import org.apache.commons.lang3.StringUtils;
42 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
43 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
44 import org.opendaylight.controller.md.sal.common.api.data.OptimisticLockFailedException;
45 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
46 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
47 import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
48 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
49 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
50 import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult;
51 import org.opendaylight.controller.sal.rest.api.Draft02;
52 import org.opendaylight.controller.sal.rest.api.RestconfService;
53 import org.opendaylight.controller.sal.restconf.impl.RestconfError.ErrorTag;
54 import org.opendaylight.controller.sal.restconf.impl.RestconfError.ErrorType;
55 import org.opendaylight.controller.sal.streams.listeners.ListenerAdapter;
56 import org.opendaylight.controller.sal.streams.listeners.Notificator;
57 import org.opendaylight.controller.sal.streams.websockets.WebSocketServer;
58 import org.opendaylight.yangtools.yang.common.QName;
59 import org.opendaylight.yangtools.yang.common.QNameModule;
60 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
61 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
62 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
63 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
64 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
65 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
66 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
67 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
68 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
69 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
70 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
71 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModifiedNodeDoesNotExistException;
72 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
73 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
74 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
75 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
76 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
77 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
78 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
79 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
80 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
81 import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
82 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
83 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
84 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
85 import org.opendaylight.yangtools.yang.model.api.Module;
86 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
87 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
88 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
89 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
90 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
91 import org.slf4j.Logger;
92 import org.slf4j.LoggerFactory;
93
94 public class RestconfImpl implements RestconfService {
95
96     private enum UriParameters {
97         PRETTY_PRINT("prettyPrint"),
98         DEPTH("depth");
99
100         private String uriParameterName;
101
102         UriParameters(final String uriParameterName) {
103             this.uriParameterName = uriParameterName;
104         }
105
106         @Override
107         public String toString() {
108             return uriParameterName;
109         }
110     }
111
112     private static final RestconfImpl INSTANCE = new RestconfImpl();
113
114     private static final int NOTIFICATION_PORT = 8181;
115
116     private static final int CHAR_NOT_FOUND = -1;
117
118     private static final String MOUNT_POINT_MODULE_NAME = "ietf-netconf";
119
120     private static final SimpleDateFormat REVISION_FORMAT = new SimpleDateFormat("yyyy-MM-dd");
121
122     private static final String SAL_REMOTE_NAMESPACE = "urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote";
123
124     private static final String SAL_REMOTE_RPC_SUBSRCIBE = "create-data-change-event-subscription";
125
126     private BrokerFacade broker;
127
128     private ControllerContext controllerContext;
129
130     private static final Logger LOG = LoggerFactory.getLogger(RestconfImpl.class);
131
132     private static final DataChangeScope DEFAULT_SCOPE = DataChangeScope.BASE;
133
134     private static final LogicalDatastoreType DEFAULT_DATASTORE = LogicalDatastoreType.CONFIGURATION;
135
136     private static final URI NAMESPACE_EVENT_SUBSCRIPTION_AUGMENT = URI.create("urn:sal:restconf:event:subscription");
137
138     private static final String DATASTORE_PARAM_NAME = "datastore";
139
140     private static final String SCOPE_PARAM_NAME = "scope";
141
142     private static final String NETCONF_BASE = "urn:ietf:params:xml:ns:netconf:base:1.0";
143
144     private static final String NETCONF_BASE_PAYLOAD_NAME = "data";
145
146     private static final QName NETCONF_BASE_QNAME;
147
148     private static final QNameModule SAL_REMOTE_AUGMENT;
149
150     private static final YangInstanceIdentifier.AugmentationIdentifier SAL_REMOTE_AUG_IDENTIFIER;
151
152     static {
153         try {
154             final Date eventSubscriptionAugRevision = new SimpleDateFormat("yyyy-MM-dd").parse("2014-07-08");
155             NETCONF_BASE_QNAME = QName.create(QNameModule.create(new URI(NETCONF_BASE), null), NETCONF_BASE_PAYLOAD_NAME );
156             SAL_REMOTE_AUGMENT = QNameModule.create(NAMESPACE_EVENT_SUBSCRIPTION_AUGMENT,
157                     eventSubscriptionAugRevision);
158             SAL_REMOTE_AUG_IDENTIFIER = new YangInstanceIdentifier.AugmentationIdentifier(Sets.newHashSet(QName.create(SAL_REMOTE_AUGMENT, "scope"),
159                     QName.create(SAL_REMOTE_AUGMENT, "datastore")));
160         } catch (final ParseException e) {
161             throw new RestconfDocumentedException(
162                     "It wasn't possible to convert revision date of sal-remote-augment to date", ErrorType.APPLICATION,
163                     ErrorTag.OPERATION_FAILED);
164         } catch (final URISyntaxException e) {
165             throw new RestconfDocumentedException(
166                     "It wasn't possible to create instance of URI class with "+NETCONF_BASE+" URI", ErrorType.APPLICATION,
167                     ErrorTag.OPERATION_FAILED);
168         }
169     }
170
171     public void setBroker(final BrokerFacade broker) {
172         this.broker = broker;
173     }
174
175     public void setControllerContext(final ControllerContext controllerContext) {
176         this.controllerContext = controllerContext;
177     }
178
179     private RestconfImpl() {
180     }
181
182     public static RestconfImpl getInstance() {
183         return INSTANCE;
184     }
185
186     @Override
187     public NormalizedNodeContext getModules(final UriInfo uriInfo) {
188         final Set<Module> allModules = controllerContext.getAllModules();
189         final MapNode allModuleMap = makeModuleMapNode(allModules);
190
191         final SchemaContext schemaContext = controllerContext.getGlobalSchema();
192
193         final Module restconfModule = getRestconfModule();
194         final DataSchemaNode modulesSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(
195                 restconfModule, Draft02.RestConfModule.MODULES_CONTAINER_SCHEMA_NODE);
196         Preconditions.checkState(modulesSchemaNode instanceof ContainerSchemaNode);
197
198         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> moduleContainerBuilder =
199                 Builders.containerBuilder((ContainerSchemaNode) modulesSchemaNode);
200         moduleContainerBuilder.withChild(allModuleMap);
201
202         return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, modulesSchemaNode,
203                 null, schemaContext), moduleContainerBuilder.build());
204     }
205
206     /**
207      * Valid only for mount point
208      */
209     @Override
210     public NormalizedNodeContext getModules(final String identifier, final UriInfo uriInfo) {
211         Preconditions.checkNotNull(identifier);
212         if ( ! identifier.contains(ControllerContext.MOUNT)) {
213             final String errMsg = "URI has bad format. If modules behind mount point should be showed,"
214                     + " URI has to end with " + ControllerContext.MOUNT;
215             throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
216         }
217
218         final InstanceIdentifierContext<?> mountPointIdentifier = controllerContext.toMountPointIdentifier(identifier);
219         final DOMMountPoint mountPoint = mountPointIdentifier.getMountPoint();
220         final Set<Module> modules = controllerContext.getAllModules(mountPoint);
221         final MapNode mountPointModulesMap = makeModuleMapNode(modules);
222
223         final Module restconfModule = getRestconfModule();
224         final DataSchemaNode modulesSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(
225                 restconfModule, Draft02.RestConfModule.MODULES_CONTAINER_SCHEMA_NODE);
226         Preconditions.checkState(modulesSchemaNode instanceof ContainerSchemaNode);
227
228         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> moduleContainerBuilder =
229                 Builders.containerBuilder((ContainerSchemaNode) modulesSchemaNode);
230         moduleContainerBuilder.withChild(mountPointModulesMap);
231
232         return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, modulesSchemaNode,
233                 mountPoint, controllerContext.getGlobalSchema()), moduleContainerBuilder.build());
234     }
235
236     @Override
237     public NormalizedNodeContext getModule(final String identifier, final UriInfo uriInfo) {
238         Preconditions.checkNotNull(identifier);
239         final QName moduleNameAndRevision = getModuleNameAndRevision(identifier);
240         Module module = null;
241         DOMMountPoint mountPoint = null;
242         final SchemaContext schemaContext;
243         if (identifier.contains(ControllerContext.MOUNT)) {
244             final InstanceIdentifierContext<?> mountPointIdentifier = controllerContext.toMountPointIdentifier(identifier);
245             mountPoint = mountPointIdentifier.getMountPoint();
246             module = controllerContext.findModuleByNameAndRevision(mountPoint, moduleNameAndRevision);
247             schemaContext = mountPoint.getSchemaContext();
248         } else {
249             module = controllerContext.findModuleByNameAndRevision(moduleNameAndRevision);
250             schemaContext = controllerContext.getGlobalSchema();
251         }
252
253         if (module == null) {
254             final String errMsg = "Module with name '" + moduleNameAndRevision.getLocalName()
255                     + "' and revision '" + moduleNameAndRevision.getRevision() + "' was not found.";
256             throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT);
257         }
258
259         final Module restconfModule = getRestconfModule();
260         final Set<Module> modules = Collections.singleton(module);
261         final MapNode moduleMap = makeModuleMapNode(modules);
262
263         final DataSchemaNode moduleSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(
264                 restconfModule, Draft02.RestConfModule.MODULE_LIST_SCHEMA_NODE);
265         Preconditions.checkState(moduleSchemaNode instanceof ListSchemaNode);
266
267         return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, moduleSchemaNode, mountPoint,
268                 schemaContext), moduleMap);
269     }
270
271     @Override
272     public NormalizedNodeContext getAvailableStreams(final UriInfo uriInfo) {
273         final SchemaContext schemaContext = controllerContext.getGlobalSchema();
274         final Set<String> availableStreams = Notificator.getStreamNames();
275         final Module restconfModule = getRestconfModule();
276         final DataSchemaNode streamSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(restconfModule,
277                 Draft02.RestConfModule.STREAM_LIST_SCHEMA_NODE);
278         Preconditions.checkState(streamSchemaNode instanceof ListSchemaNode);
279
280         final CollectionNodeBuilder<MapEntryNode, MapNode> listStreamsBuilder = Builders
281                 .mapBuilder((ListSchemaNode) streamSchemaNode);
282
283         for (final String streamName : availableStreams) {
284             listStreamsBuilder.withChild(toStreamEntryNode(streamName, streamSchemaNode));
285         }
286
287         final DataSchemaNode streamsContainerSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(
288                 restconfModule, Draft02.RestConfModule.STREAMS_CONTAINER_SCHEMA_NODE);
289         Preconditions.checkState(streamsContainerSchemaNode instanceof ContainerSchemaNode);
290
291         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> streamsContainerBuilder =
292                 Builders.containerBuilder((ContainerSchemaNode) streamsContainerSchemaNode);
293         streamsContainerBuilder.withChild(listStreamsBuilder.build());
294
295
296         return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, streamsContainerSchemaNode, null,
297                 schemaContext), streamsContainerBuilder.build());
298     }
299
300     @Override
301     public NormalizedNodeContext getOperations(final UriInfo uriInfo) {
302         final Set<Module> allModules = controllerContext.getAllModules();
303         return operationsFromModulesToNormalizedContext(allModules, null);
304     }
305
306     @Override
307     public NormalizedNodeContext getOperations(final String identifier, final UriInfo uriInfo) {
308         Set<Module> modules = null;
309         DOMMountPoint mountPoint = null;
310         if (identifier.contains(ControllerContext.MOUNT)) {
311             final InstanceIdentifierContext<?> mountPointIdentifier = controllerContext.toMountPointIdentifier(identifier);
312             mountPoint = mountPointIdentifier.getMountPoint();
313             modules = controllerContext.getAllModules(mountPoint);
314
315         } else {
316             final String errMsg = "URI has bad format. If operations behind mount point should be showed, URI has to end with ";
317             throw new RestconfDocumentedException(errMsg + ControllerContext.MOUNT, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
318         }
319
320         return operationsFromModulesToNormalizedContext(modules, mountPoint);
321     }
322
323     private NormalizedNodeContext operationsFromModulesToNormalizedContext(final Set<Module> modules,
324             final DOMMountPoint mountPoint) {
325
326         // FIXME find best way to change restconf-netconf yang schema for provide this functionality
327         final String errMsg = "We are not able support view operations functionality yet.";
328         throw new RestconfDocumentedException(errMsg, ErrorType.APPLICATION, ErrorTag.OPERATION_NOT_SUPPORTED);
329     }
330
331     private Module getRestconfModule() {
332         final Module restconfModule = controllerContext.getRestconfModule();
333         if (restconfModule == null) {
334             throw new RestconfDocumentedException("ietf-restconf module was not found.", ErrorType.APPLICATION,
335                     ErrorTag.OPERATION_NOT_SUPPORTED);
336         }
337
338         return restconfModule;
339     }
340
341     private QName getModuleNameAndRevision(final String identifier) {
342         final int mountIndex = identifier.indexOf(ControllerContext.MOUNT);
343         String moduleNameAndRevision = "";
344         if (mountIndex >= 0) {
345             moduleNameAndRevision = identifier.substring(mountIndex + ControllerContext.MOUNT.length());
346         } else {
347             moduleNameAndRevision = identifier;
348         }
349
350         final Splitter splitter = Splitter.on("/").omitEmptyStrings();
351         final Iterable<String> split = splitter.split(moduleNameAndRevision);
352         final List<String> pathArgs = Lists.<String> newArrayList(split);
353         if (pathArgs.size() < 2) {
354             throw new RestconfDocumentedException(
355                     "URI has bad format. End of URI should be in format \'moduleName/yyyy-MM-dd\'", ErrorType.PROTOCOL,
356                     ErrorTag.INVALID_VALUE);
357         }
358
359         try {
360             final String moduleName = pathArgs.get(0);
361             final String revision = pathArgs.get(1);
362             final Date moduleRevision = REVISION_FORMAT.parse(revision);
363             return QName.create(null, moduleRevision, moduleName);
364         } catch (final ParseException e) {
365             throw new RestconfDocumentedException("URI has bad format. It should be \'moduleName/yyyy-MM-dd\'",
366                     ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
367         }
368     }
369
370     @Override
371     public Object getRoot() {
372         return null;
373     }
374
375     @Override
376     public NormalizedNodeContext invokeRpc(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
377         final SchemaPath type = payload.getInstanceIdentifierContext().getSchemaNode().getPath();
378         final URI namespace = payload.getInstanceIdentifierContext().getSchemaNode().getQName().getNamespace();
379         final CheckedFuture<DOMRpcResult, DOMRpcException> response;
380         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
381         final SchemaContext schemaContext;
382         if (identifier.contains(MOUNT_POINT_MODULE_NAME) && mountPoint != null) {
383             final Optional<DOMRpcService> mountRpcServices = mountPoint.getService(DOMRpcService.class);
384             if ( ! mountRpcServices.isPresent()) {
385                 throw new RestconfDocumentedException("Rpc service is missing.");
386             }
387             schemaContext = mountPoint.getSchemaContext();
388             response = mountRpcServices.get().invokeRpc(type, payload.getData());
389         } else {
390             if (namespace.toString().equals(SAL_REMOTE_NAMESPACE)) {
391                 response = invokeSalRemoteRpcSubscribeRPC(payload);
392             } else {
393                 response = broker.invokeRpc(type, payload.getData());
394             }
395             schemaContext = controllerContext.getGlobalSchema();
396         }
397
398         final DOMRpcResult result = checkRpcResponse(response);
399
400         RpcDefinition resultNodeSchema = null;
401         final NormalizedNode<?, ?> resultData = result.getResult();
402         if (result != null && result.getResult() != null) {
403             resultNodeSchema = (RpcDefinition) payload.getInstanceIdentifierContext().getSchemaNode();
404         }
405
406         return new NormalizedNodeContext(new InstanceIdentifierContext<RpcDefinition>(null,
407                 resultNodeSchema, mountPoint, schemaContext), resultData);
408     }
409
410     private DOMRpcResult checkRpcResponse(final CheckedFuture<DOMRpcResult, DOMRpcException> response) {
411         if (response == null) {
412             return null;
413         }
414         try {
415             final DOMRpcResult retValue = response.get();
416             if (retValue.getErrors() == null || retValue.getErrors().isEmpty()) {
417                 return retValue;
418             }
419             throw new RestconfDocumentedException("RpcError message", null, retValue.getErrors());
420         }
421         catch (final InterruptedException e) {
422             throw new RestconfDocumentedException(
423                     "The operation was interrupted while executing and did not complete.", ErrorType.RPC,
424                     ErrorTag.PARTIAL_OPERATION);
425         }
426         catch (final ExecutionException e) {
427             Throwable cause = e.getCause();
428             if (cause instanceof CancellationException) {
429                 throw new RestconfDocumentedException("The operation was cancelled while executing.", ErrorType.RPC,
430                         ErrorTag.PARTIAL_OPERATION);
431             } else if (cause != null) {
432                 while (cause.getCause() != null) {
433                     cause = cause.getCause();
434                 }
435
436                 if (cause instanceof IllegalArgumentException) {
437                     throw new RestconfDocumentedException(cause.getMessage(), ErrorType.PROTOCOL,
438                             ErrorTag.INVALID_VALUE);
439                 }
440
441                 throw new RestconfDocumentedException("The operation encountered an unexpected error while executing.",
442                         cause);
443             } else {
444                 throw new RestconfDocumentedException("The operation encountered an unexpected error while executing.",
445                         e);
446             }
447         }
448     }
449
450     private void validateInput(final SchemaNode inputSchema, final NormalizedNodeContext payload) {
451         if (inputSchema != null && payload.getData() == null) {
452             // expected a non null payload
453             throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
454         } else if (inputSchema == null && payload.getData() != null) {
455             // did not expect any input
456             throw new RestconfDocumentedException("No input expected.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
457         }
458         // else
459         // {
460         // TODO: Validate "mandatory" and "config" values here??? Or should those be
461         // those be
462         // validate in a more central location inside MD-SAL core.
463         // }
464     }
465
466     private CheckedFuture<DOMRpcResult, DOMRpcException> invokeSalRemoteRpcSubscribeRPC(final NormalizedNodeContext payload) {
467         final ContainerNode value = (ContainerNode) payload.getData();
468         final QName rpcQName = payload.getInstanceIdentifierContext().getSchemaNode().getQName();
469         final Optional<DataContainerChild<? extends PathArgument, ?>> path = value.getChild(new NodeIdentifier(
470                 QName.create(payload.getInstanceIdentifierContext().getSchemaNode().getQName(), "path")));
471         final Object pathValue = path.isPresent() ? path.get().getValue() : null;
472
473         if (!(pathValue instanceof YangInstanceIdentifier)) {
474             throw new RestconfDocumentedException("Instance identifier was not normalized correctly.",
475                     ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED);
476         }
477
478         final YangInstanceIdentifier pathIdentifier = ((YangInstanceIdentifier) pathValue);
479         String streamName = null;
480         if (!Iterables.isEmpty(pathIdentifier.getPathArguments())) {
481             final String fullRestconfIdentifier = controllerContext.toFullRestconfIdentifier(pathIdentifier, null);
482
483             LogicalDatastoreType datastore = parseEnumTypeParameter(value, LogicalDatastoreType.class,
484                     DATASTORE_PARAM_NAME);
485             datastore = datastore == null ? DEFAULT_DATASTORE : datastore;
486
487             DataChangeScope scope = parseEnumTypeParameter(value, DataChangeScope.class, SCOPE_PARAM_NAME);
488             scope = scope == null ? DEFAULT_SCOPE : scope;
489
490             streamName = Notificator.createStreamNameFromUri(fullRestconfIdentifier + "/datastore=" + datastore
491                     + "/scope=" + scope);
492         }
493
494         if (Strings.isNullOrEmpty(streamName)) {
495             throw new RestconfDocumentedException(
496                     "Path is empty or contains value node which is not Container or List build-in type.",
497                     ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
498         }
499
500         final QName outputQname = QName.create(rpcQName, "output");
501         final QName streamNameQname = QName.create(rpcQName, "stream-name");
502
503         final ContainerNode output = ImmutableContainerNodeBuilder.create().withNodeIdentifier(new NodeIdentifier(outputQname))
504                 .withChild(ImmutableNodes.leafNode(streamNameQname, streamName)).build();
505
506         if (!Notificator.existListenerFor(streamName)) {
507             final YangInstanceIdentifier normalizedPathIdentifier = controllerContext.toNormalized(pathIdentifier);
508             Notificator.createListener(normalizedPathIdentifier, streamName);
509         }
510
511         final DOMRpcResult defaultDOMRpcResult = new DefaultDOMRpcResult(output);
512
513         return Futures.immediateCheckedFuture(defaultDOMRpcResult);
514     }
515
516     @Override
517     public NormalizedNodeContext invokeRpc(final String identifier, final String noPayload, final UriInfo uriInfo) {
518         if (StringUtils.isNotBlank(noPayload)) {
519             throw new RestconfDocumentedException("Content must be empty.", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
520         }
521
522         String identifierEncoded = null;
523         DOMMountPoint mountPoint = null;
524         final SchemaContext schemaContext;
525         if (identifier.contains(ControllerContext.MOUNT)) {
526             // mounted RPC call - look up mount instance.
527             final InstanceIdentifierContext<?> mountPointId = controllerContext.toMountPointIdentifier(identifier);
528             mountPoint = mountPointId.getMountPoint();
529             schemaContext = mountPoint.getSchemaContext();
530             final int startOfRemoteRpcName = identifier.lastIndexOf(ControllerContext.MOUNT)
531                     + ControllerContext.MOUNT.length() + 1;
532             final String remoteRpcName = identifier.substring(startOfRemoteRpcName);
533             identifierEncoded = remoteRpcName;
534
535         } else if (identifier.indexOf("/") != CHAR_NOT_FOUND) {
536             final String slashErrorMsg = String.format("Identifier %n%s%ncan\'t contain slash "
537                     + "character (/).%nIf slash is part of identifier name then use %%2F placeholder.", identifier);
538             throw new RestconfDocumentedException(slashErrorMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
539         } else {
540             identifierEncoded = identifier;
541             schemaContext = controllerContext.getGlobalSchema();
542         }
543
544         final String identifierDecoded = controllerContext.urlPathArgDecode(identifierEncoded);
545
546         RpcDefinition rpc = null;
547         if (mountPoint == null) {
548             rpc = controllerContext.getRpcDefinition(identifierDecoded);
549         } else {
550             rpc = findRpc(mountPoint.getSchemaContext(), identifierDecoded);
551         }
552
553         if (rpc == null) {
554             throw new RestconfDocumentedException("RPC does not exist.", ErrorType.RPC, ErrorTag.UNKNOWN_ELEMENT);
555         }
556
557         if (rpc.getInput() != null) {
558             // FIXME : find a correct Error from specification
559             throw new IllegalStateException("RPC " + rpc + " does'n need input value!");
560         }
561
562         final CheckedFuture<DOMRpcResult, DOMRpcException> response;
563         if (mountPoint != null) {
564             final Optional<DOMRpcService> mountRpcServices = mountPoint.getService(DOMRpcService.class);
565             if ( ! mountRpcServices.isPresent()) {
566                 throw new RestconfDocumentedException("Rpc service is missing.");
567             }
568             response = mountRpcServices.get().invokeRpc(rpc.getPath(), null);
569         } else {
570             response = broker.invokeRpc(rpc.getPath(), null);
571         }
572
573         final DOMRpcResult result = checkRpcResponse(response);
574
575         DataSchemaNode resultNodeSchema = null;
576         NormalizedNode<?, ?> resultData = null;
577         if (result != null && result.getResult() != null) {
578             resultData = result.getResult();
579             final ContainerSchemaNode rpcDataSchemaNode =
580                     SchemaContextUtil.getRpcDataSchema(schemaContext, rpc.getOutput().getPath());
581             resultNodeSchema = rpcDataSchemaNode.getDataChildByName(result.getResult().getNodeType());
582         }
583
584         return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, resultNodeSchema, mountPoint,
585                 schemaContext), resultData);
586     }
587
588     private RpcDefinition findRpc(final SchemaContext schemaContext, final String identifierDecoded) {
589         final String[] splittedIdentifier = identifierDecoded.split(":");
590         if (splittedIdentifier.length != 2) {
591             throw new RestconfDocumentedException(identifierDecoded
592                     + " couldn't be splitted to 2 parts (module:rpc name)", ErrorType.APPLICATION,
593                     ErrorTag.INVALID_VALUE);
594         }
595         for (final Module module : schemaContext.getModules()) {
596             if (module.getName().equals(splittedIdentifier[0])) {
597                 for (final RpcDefinition rpcDefinition : module.getRpcs()) {
598                     if (rpcDefinition.getQName().getLocalName().equals(splittedIdentifier[1])) {
599                         return rpcDefinition;
600                     }
601                 }
602             }
603         }
604         return null;
605     }
606
607     @Override
608     public NormalizedNodeContext readConfigurationData(final String identifier, final UriInfo uriInfo) {
609         final InstanceIdentifierContext<?> iiWithData = controllerContext.toInstanceIdentifier(identifier);
610         final DOMMountPoint mountPoint = iiWithData.getMountPoint();
611         NormalizedNode<?, ?> data = null;
612         final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
613         if (mountPoint != null) {
614             data = broker.readConfigurationData(mountPoint, normalizedII);
615         } else {
616             data = broker.readConfigurationData(normalizedII);
617         }
618         if(data == null) {
619             throw new RestconfDocumentedException(
620                 "Request could not be completed because the relevant data model content does not exist.",
621                 ErrorType.APPLICATION, ErrorTag.DATA_MISSING);
622         }
623         return new NormalizedNodeContext(iiWithData, data);
624     }
625
626     // FIXME: Move this to proper place
627     @SuppressWarnings("unused")
628     private Integer parseDepthParameter(final UriInfo info) {
629         final String param = info.getQueryParameters(false).getFirst(UriParameters.DEPTH.toString());
630         if (Strings.isNullOrEmpty(param) || "unbounded".equals(param)) {
631             return null;
632         }
633
634         try {
635             final Integer depth = Integer.valueOf(param);
636             if (depth < 1) {
637                 throw new RestconfDocumentedException(new RestconfError(ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE,
638                         "Invalid depth parameter: " + depth, null,
639                         "The depth parameter must be an integer > 1 or \"unbounded\""));
640             }
641
642             return depth;
643         } catch (final NumberFormatException e) {
644             throw new RestconfDocumentedException(new RestconfError(ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE,
645                     "Invalid depth parameter: " + e.getMessage(), null,
646                     "The depth parameter must be an integer > 1 or \"unbounded\""));
647         }
648     }
649
650     @Override
651     public NormalizedNodeContext readOperationalData(final String identifier, final UriInfo info) {
652         final InstanceIdentifierContext<?> iiWithData = controllerContext.toInstanceIdentifier(identifier);
653         final DOMMountPoint mountPoint = iiWithData.getMountPoint();
654         NormalizedNode<?, ?> data = null;
655         final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
656         if (mountPoint != null) {
657             data = broker.readOperationalData(mountPoint, normalizedII);
658         } else {
659             data = broker.readOperationalData(normalizedII);
660         }
661         if(data == null) {
662             throw new RestconfDocumentedException(
663                 "Request could not be completed because the relevant data model content does not exist.",
664                 ErrorType.APPLICATION, ErrorTag.DATA_MISSING);
665         }
666         return new NormalizedNodeContext(iiWithData, data);
667     }
668
669     @Override
670     public Response updateConfigurationData(final String identifier, final NormalizedNodeContext payload) {
671         Preconditions.checkNotNull(identifier);
672         final InstanceIdentifierContext<?> iiWithData = payload.getInstanceIdentifierContext();
673
674         validateInput(iiWithData.getSchemaNode(), payload);
675         validateTopLevelNodeName(payload, iiWithData.getInstanceIdentifier());
676         validateListKeysEqualityInPayloadAndUri(iiWithData, payload.getData());
677
678         final DOMMountPoint mountPoint = iiWithData.getMountPoint();
679         final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
680
681         /*
682          * There is a small window where another write transaction could be updating the same data
683          * simultaneously and we get an OptimisticLockFailedException. This error is likely
684          * transient and The WriteTransaction#submit API docs state that a retry will likely
685          * succeed. So we'll try again if that scenario occurs. If it fails a third time then it
686          * probably will never succeed so we'll fail in that case.
687          *
688          * By retrying we're attempting to hide the internal implementation of the data store and
689          * how it handles concurrent updates from the restconf client. The client has instructed us
690          * to put the data and we should make every effort to do so without pushing optimistic lock
691          * failures back to the client and forcing them to handle it via retry (and having to
692          * document the behavior).
693          */
694         int tries = 2;
695         while(true) {
696             try {
697                 if (mountPoint != null) {
698                     broker.commitConfigurationDataPut(mountPoint, normalizedII, payload.getData()).checkedGet();
699                 } else {
700                     broker.commitConfigurationDataPut(normalizedII, payload.getData()).checkedGet();
701                 }
702
703                 break;
704             } catch (final TransactionCommitFailedException e) {
705                 if(e instanceof OptimisticLockFailedException) {
706                     if(--tries <= 0) {
707                         LOG.debug("Got OptimisticLockFailedException on last try - failing");
708                         throw new RestconfDocumentedException(e.getMessage(), e, e.getErrorList());
709                     }
710
711                     LOG.debug("Got OptimisticLockFailedException - trying again");
712                 } else {
713                     throw new RestconfDocumentedException(e.getMessage(), e, e.getErrorList());
714                 }
715             }
716         }
717
718         return Response.status(Status.OK).build();
719     }
720
721     private void validateTopLevelNodeName(final NormalizedNodeContext node,
722             final YangInstanceIdentifier identifier) {
723
724         final String payloadName = node.getData().getNodeType().getLocalName();
725         final Iterator<PathArgument> pathArguments = identifier.getReversePathArguments().iterator();
726
727         //no arguments
728         if ( ! pathArguments.hasNext()) {
729             //no "data" payload
730             if ( ! node.getData().getNodeType().equals(NETCONF_BASE_QNAME)) {
731                 throw new RestconfDocumentedException("Instance identifier has to contain at least one path argument",
732                         ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
733             }
734         //any arguments
735         } else {
736             final String identifierName = pathArguments.next().getNodeType().getLocalName();
737             if ( ! payloadName.equals(identifierName)) {
738                 throw new RestconfDocumentedException("Payload name (" + payloadName
739                         + ") is different from identifier name (" + identifierName + ")", ErrorType.PROTOCOL,
740                         ErrorTag.MALFORMED_MESSAGE);
741             }
742         }
743     }
744
745     /**
746      * Validates whether keys in {@code payload} are equal to values of keys in {@code iiWithData} for list schema node
747      *
748      * @throws RestconfDocumentedException
749      *             if key values or key count in payload and URI isn't equal
750      *
751      */
752     private void validateListKeysEqualityInPayloadAndUri(final InstanceIdentifierContext<?> iiWithData,
753             final NormalizedNode<?, ?> payload) {
754         if (iiWithData.getSchemaNode() instanceof ListSchemaNode) {
755             final List<QName> keyDefinitions = ((ListSchemaNode) iiWithData.getSchemaNode()).getKeyDefinition();
756             final PathArgument lastPathArgument = iiWithData.getInstanceIdentifier().getLastPathArgument();
757             if (lastPathArgument instanceof NodeIdentifierWithPredicates) {
758                 final Map<QName, Object> uriKeyValues = ((NodeIdentifierWithPredicates) lastPathArgument)
759                         .getKeyValues();
760                 isEqualUriAndPayloadKeyValues(uriKeyValues, payload, keyDefinitions);
761             }
762         }
763     }
764
765     private void isEqualUriAndPayloadKeyValues(final Map<QName, Object> uriKeyValues, final NormalizedNode<?, ?> payload,
766             final List<QName> keyDefinitions) {
767         for (final QName keyDefinition : keyDefinitions) {
768             final Object uriKeyValue = uriKeyValues.get(keyDefinition);
769             // should be caught during parsing URI to InstanceIdentifier
770             if (uriKeyValue == null) {
771                 final String errMsg = "Missing key " + keyDefinition + " in URI.";
772                 throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.DATA_MISSING);
773             }
774             // TODO thing about the possibility to fix
775 //            final List<SimpleNode<?>> payloadKeyValues = payload.getSimpleNodesByName(keyDefinition.getLocalName());
776 //            if (payloadKeyValues.isEmpty()) {
777 //                final String errMsg = "Missing key " + keyDefinition.getLocalName() + " in the message body.";
778 //                throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.DATA_MISSING);
779 //            }
780 //
781 //            final Object payloadKeyValue = payloadKeyValues.iterator().next().getValue();
782 //            if (!uriKeyValue.equals(payloadKeyValue)) {
783 //                final String errMsg = "The value '" + uriKeyValue + "' for key '" + keyDefinition.getLocalName() +
784 //                        "' specified in the URI doesn't match the value '" + payloadKeyValue + "' specified in the message body. ";
785 //                throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
786 //            }
787         }
788     }
789
790     @Override
791     public Response createConfigurationData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
792        return createConfigurationData(payload, uriInfo);
793     }
794
795     // FIXME create RestconfIdetifierHelper and move this method there
796     private YangInstanceIdentifier checkConsistencyOfNormalizedNodeContext(final NormalizedNodeContext payload) {
797         Preconditions.checkArgument(payload != null);
798         Preconditions.checkArgument(payload.getData() != null);
799         Preconditions.checkArgument(payload.getData().getNodeType() != null);
800         Preconditions.checkArgument(payload.getInstanceIdentifierContext() != null);
801         Preconditions.checkArgument(payload.getInstanceIdentifierContext().getInstanceIdentifier() != null);
802
803         final QName payloadNodeQname = payload.getData().getNodeType();
804         final YangInstanceIdentifier yangIdent = payload.getInstanceIdentifierContext().getInstanceIdentifier();
805         if (payloadNodeQname.compareTo(yangIdent.getLastPathArgument().getNodeType()) > 0) {
806             return yangIdent;
807         }
808         final InstanceIdentifierContext<?> parentContext = payload.getInstanceIdentifierContext();
809         final SchemaNode parentSchemaNode = parentContext.getSchemaNode();
810         if(parentSchemaNode instanceof DataNodeContainer) {
811             final DataNodeContainer cast = (DataNodeContainer) parentSchemaNode;
812             for (final DataSchemaNode child : cast.getChildNodes()) {
813                 if (payloadNodeQname.compareTo(child.getQName()) == 0) {
814                     return YangInstanceIdentifier.builder(yangIdent).node(child.getQName()).build();
815                 }
816             }
817         }
818         if (parentSchemaNode instanceof RpcDefinition) {
819             return yangIdent;
820         }
821         final String errMsg = "Error parsing input: DataSchemaNode has not children";
822         throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
823     }
824
825     @Override
826     public Response createConfigurationData(final NormalizedNodeContext payload, final UriInfo uriInfo) {
827         if (payload == null) {
828             throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
829         }
830
831         final URI payloadNS = payload.getData().getNodeType().getNamespace();
832         if (payloadNS == null) {
833             throw new RestconfDocumentedException(
834                     "Data has bad format. Root element node must have namespace (XML format) or module name(JSON format)",
835                     ErrorType.PROTOCOL, ErrorTag.UNKNOWN_NAMESPACE);
836         }
837
838         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
839         final InstanceIdentifierContext<?> iiWithData = payload.getInstanceIdentifierContext();
840         final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
841         try {
842             if (mountPoint != null) {
843                 broker.commitConfigurationDataPost(mountPoint, normalizedII, payload.getData()).checkedGet();
844             } else {
845                 broker.commitConfigurationDataPost(normalizedII, payload.getData()).checkedGet();
846             }
847         } catch(final RestconfDocumentedException e) {
848             throw e;
849         } catch (final Exception e) {
850             throw new RestconfDocumentedException("Error creating data", e);
851         }
852
853         final ResponseBuilder responseBuilder = Response.status(Status.NO_CONTENT);
854         // FIXME: Provide path to result.
855         final URI location = resolveLocation(uriInfo, "", mountPoint, normalizedII);
856         if (location != null) {
857             responseBuilder.location(location);
858         }
859         return responseBuilder.build();
860     }
861
862     private URI resolveLocation(final UriInfo uriInfo, final String uriBehindBase, final DOMMountPoint mountPoint, final YangInstanceIdentifier normalizedII) {
863         final UriBuilder uriBuilder = uriInfo.getBaseUriBuilder();
864         uriBuilder.path("config");
865         try {
866             uriBuilder.path(controllerContext.toFullRestconfIdentifier(normalizedII, mountPoint));
867         } catch (final Exception e) {
868             LOG.debug("Location for instance identifier"+normalizedII+"wasn't created", e);
869             return null;
870         }
871         return uriBuilder.build();
872     }
873
874     @Override
875     public Response deleteConfigurationData(final String identifier) {
876         final InstanceIdentifierContext<?> iiWithData = controllerContext.toInstanceIdentifier(identifier);
877         final DOMMountPoint mountPoint = iiWithData.getMountPoint();
878         final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
879
880         try {
881             if (mountPoint != null) {
882                 broker.commitConfigurationDataDelete(mountPoint, normalizedII);
883             } else {
884                 broker.commitConfigurationDataDelete(normalizedII).get();
885             }
886         } catch (final Exception e) {
887             final Optional<Throwable> searchedException = Iterables.tryFind(Throwables.getCausalChain(e),
888                     Predicates.instanceOf(ModifiedNodeDoesNotExistException.class));
889             if (searchedException.isPresent()) {
890                 throw new RestconfDocumentedException("Data specified for deleting doesn't exist.", ErrorType.APPLICATION, ErrorTag.DATA_MISSING);
891             }
892             throw new RestconfDocumentedException("Error while deleting data", e);
893         }
894         return Response.status(Status.OK).build();
895     }
896
897     /**
898      * Subscribes to some path in schema context (stream) to listen on changes on this stream.
899      *
900      * Additional parameters for subscribing to stream are loaded via rpc input parameters:
901      * <ul>
902      * <li>datastore</li> - default CONFIGURATION (other values of {@link LogicalDatastoreType} enum type)
903      * <li>scope</li> - default BASE (other values of {@link DataChangeScope})
904      * </ul>
905      */
906     @Override
907     public Response subscribeToStream(final String identifier, final UriInfo uriInfo) {
908         final String streamName = Notificator.createStreamNameFromUri(identifier);
909         if (Strings.isNullOrEmpty(streamName)) {
910             throw new RestconfDocumentedException("Stream name is empty.", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
911         }
912
913         final ListenerAdapter listener = Notificator.getListenerFor(streamName);
914         if (listener == null) {
915             throw new RestconfDocumentedException("Stream was not found.", ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT);
916         }
917
918         final Map<String, String> paramToValues = resolveValuesFromUri(identifier);
919         final LogicalDatastoreType datastore = parserURIEnumParameter(LogicalDatastoreType.class,
920                 paramToValues.get(DATASTORE_PARAM_NAME));
921         if (datastore == null) {
922             throw new RestconfDocumentedException("Stream name doesn't contains datastore value (pattern /datastore=)",
923                     ErrorType.APPLICATION, ErrorTag.MISSING_ATTRIBUTE);
924         }
925         final DataChangeScope scope = parserURIEnumParameter(DataChangeScope.class, paramToValues.get(SCOPE_PARAM_NAME));
926         if (scope == null) {
927             throw new RestconfDocumentedException("Stream name doesn't contains datastore value (pattern /scope=)",
928                     ErrorType.APPLICATION, ErrorTag.MISSING_ATTRIBUTE);
929         }
930
931         broker.registerToListenDataChanges(datastore, scope, listener);
932
933         final UriBuilder uriBuilder = uriInfo.getAbsolutePathBuilder();
934         int notificationPort = NOTIFICATION_PORT;
935         try {
936             final WebSocketServer webSocketServerInstance = WebSocketServer.getInstance();
937             notificationPort = webSocketServerInstance.getPort();
938         } catch (final NullPointerException e) {
939             WebSocketServer.createInstance(NOTIFICATION_PORT);
940         }
941         final UriBuilder uriToWebsocketServerBuilder = uriBuilder.port(notificationPort).scheme("ws");
942         final URI uriToWebsocketServer = uriToWebsocketServerBuilder.replacePath(streamName).build();
943
944         return Response.status(Status.OK).location(uriToWebsocketServer).build();
945     }
946
947     /**
948      * Load parameter for subscribing to stream from input composite node
949      *
950      * @param compNode
951      *            contains value
952      * @return enum object if its string value is equal to {@code paramName}. In other cases null.
953      */
954     private <T> T parseEnumTypeParameter(final ContainerNode value, final Class<T> classDescriptor,
955             final String paramName) {
956         final Optional<DataContainerChild<? extends PathArgument, ?>> augNode = value.getChild(SAL_REMOTE_AUG_IDENTIFIER);
957         if (!augNode.isPresent() && !(augNode instanceof AugmentationNode)) {
958             return null;
959         }
960         final Optional<DataContainerChild<? extends PathArgument, ?>> enumNode =
961                 ((AugmentationNode) augNode.get()).getChild(new NodeIdentifier(QName.create(SAL_REMOTE_AUGMENT, paramName)));
962         if (!enumNode.isPresent()) {
963             return null;
964         }
965         final Object rawValue = enumNode.get().getValue();
966         if (!(rawValue instanceof String)) {
967             return null;
968         }
969
970         return resolveAsEnum(classDescriptor, (String) rawValue);
971     }
972
973     /**
974      * Checks whether {@code value} is one of the string representation of enumeration {@code classDescriptor}
975      *
976      * @return enum object if string value of {@code classDescriptor} enumeration is equal to {@code value}. Other cases
977      *         null.
978      */
979     private <T> T parserURIEnumParameter(final Class<T> classDescriptor, final String value) {
980         if (Strings.isNullOrEmpty(value)) {
981             return null;
982         }
983         return resolveAsEnum(classDescriptor, value);
984     }
985
986     private <T> T resolveAsEnum(final Class<T> classDescriptor, final String value) {
987         final T[] enumConstants = classDescriptor.getEnumConstants();
988         if (enumConstants != null) {
989             for (final T enm : classDescriptor.getEnumConstants()) {
990                 if (((Enum<?>) enm).name().equals(value)) {
991                     return enm;
992                 }
993             }
994         }
995         return null;
996     }
997
998     private Map<String, String> resolveValuesFromUri(final String uri) {
999         final Map<String, String> result = new HashMap<>();
1000         final String[] tokens = uri.split("/");
1001         for (int i = 1; i < tokens.length; i++) {
1002             final String[] parameterTokens = tokens[i].split("=");
1003             if (parameterTokens.length == 2) {
1004                 result.put(parameterTokens[0], parameterTokens[1]);
1005             }
1006         }
1007         return result;
1008     }
1009
1010     public BigInteger getOperationalReceived() {
1011         // TODO Auto-generated method stub
1012         return null;
1013     }
1014
1015     private MapNode makeModuleMapNode(final Set<Module> modules) {
1016         Preconditions.checkNotNull(modules);
1017         final Module restconfModule = getRestconfModule();
1018         final DataSchemaNode moduleSchemaNode = controllerContext.getRestconfModuleRestConfSchemaNode(
1019                 restconfModule, Draft02.RestConfModule.MODULE_LIST_SCHEMA_NODE);
1020         Preconditions.checkState(moduleSchemaNode instanceof ListSchemaNode);
1021
1022         final CollectionNodeBuilder<MapEntryNode, MapNode> listModuleBuilder = Builders
1023                 .mapBuilder((ListSchemaNode) moduleSchemaNode);
1024
1025         for (final Module module : modules) {
1026             listModuleBuilder.withChild(toModuleEntryNode(module, moduleSchemaNode));
1027         }
1028         return listModuleBuilder.build();
1029     }
1030
1031     protected MapEntryNode toModuleEntryNode(final Module module, final DataSchemaNode moduleSchemaNode) {
1032         Preconditions.checkArgument(moduleSchemaNode instanceof ListSchemaNode,
1033                 "moduleSchemaNode has to be of type ListSchemaNode");
1034         final ListSchemaNode listModuleSchemaNode = (ListSchemaNode) moduleSchemaNode;
1035         final DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> moduleNodeValues = Builders
1036                 .mapEntryBuilder(listModuleSchemaNode);
1037
1038         List<DataSchemaNode> instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1039                 (listModuleSchemaNode), "name");
1040         final DataSchemaNode nameSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1041         Preconditions.checkState(nameSchemaNode instanceof LeafSchemaNode);
1042         moduleNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) nameSchemaNode).withValue(module.getName())
1043                 .build());
1044
1045         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1046                 (listModuleSchemaNode), "revision");
1047         final DataSchemaNode revisionSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1048         Preconditions.checkState(revisionSchemaNode instanceof LeafSchemaNode);
1049         final String revision = REVISION_FORMAT.format(module.getRevision());
1050         moduleNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) revisionSchemaNode).withValue(revision)
1051                 .build());
1052
1053         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1054                 (listModuleSchemaNode), "namespace");
1055         final DataSchemaNode namespaceSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1056         Preconditions.checkState(namespaceSchemaNode instanceof LeafSchemaNode);
1057         moduleNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) namespaceSchemaNode)
1058                 .withValue(module.getNamespace().toString()).build());
1059
1060         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1061                 (listModuleSchemaNode), "feature");
1062         final DataSchemaNode featureSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1063         Preconditions.checkState(featureSchemaNode instanceof LeafListSchemaNode);
1064         final ListNodeBuilder<Object, LeafSetEntryNode<Object>> featuresBuilder = Builders
1065                 .leafSetBuilder((LeafListSchemaNode) featureSchemaNode);
1066         for (final FeatureDefinition feature : module.getFeatures()) {
1067             featuresBuilder.withChild(Builders.leafSetEntryBuilder(((LeafListSchemaNode) featureSchemaNode))
1068                     .withValue(feature.getQName().getLocalName()).build());
1069         }
1070         moduleNodeValues.withChild(featuresBuilder.build());
1071
1072         return moduleNodeValues.build();
1073     }
1074
1075     protected MapEntryNode toStreamEntryNode(final String streamName, final DataSchemaNode streamSchemaNode) {
1076         Preconditions.checkArgument(streamSchemaNode instanceof ListSchemaNode,
1077                 "streamSchemaNode has to be of type ListSchemaNode");
1078         final ListSchemaNode listStreamSchemaNode = (ListSchemaNode) streamSchemaNode;
1079         final DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> streamNodeValues = Builders
1080                 .mapEntryBuilder(listStreamSchemaNode);
1081
1082         List<DataSchemaNode> instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1083                 (listStreamSchemaNode), "name");
1084         final DataSchemaNode nameSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1085         Preconditions.checkState(nameSchemaNode instanceof LeafSchemaNode);
1086         streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) nameSchemaNode).withValue(streamName)
1087                 .build());
1088
1089         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1090                 (listStreamSchemaNode), "description");
1091         final DataSchemaNode descriptionSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1092         Preconditions.checkState(descriptionSchemaNode instanceof LeafSchemaNode);
1093         streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) nameSchemaNode)
1094                 .withValue("DESCRIPTION_PLACEHOLDER").build());
1095
1096         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1097                 (listStreamSchemaNode), "replay-support");
1098         final DataSchemaNode replaySupportSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1099         Preconditions.checkState(replaySupportSchemaNode instanceof LeafSchemaNode);
1100         streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) replaySupportSchemaNode)
1101                 .withValue(Boolean.valueOf(true)).build());
1102
1103         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1104                 (listStreamSchemaNode), "replay-log-creation-time");
1105         final DataSchemaNode replayLogCreationTimeSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1106         Preconditions.checkState(replayLogCreationTimeSchemaNode instanceof LeafSchemaNode);
1107         streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) replayLogCreationTimeSchemaNode)
1108                 .withValue("").build());
1109
1110         instanceDataChildrenByName = ControllerContext.findInstanceDataChildrenByName(
1111                 (listStreamSchemaNode), "events");
1112         final DataSchemaNode eventsSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
1113         Preconditions.checkState(eventsSchemaNode instanceof LeafSchemaNode);
1114         streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) eventsSchemaNode)
1115                 .withValue("").build());
1116
1117         return streamNodeValues.build();
1118     }
1119 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.