2 * Copyright (c) 2016 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
8 package org.opendaylight.restconf.nb.rfc8040.rests.services.impl;
10 import static java.util.Objects.requireNonNull;
11 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant.PostPutQueryParameters.INSERT;
12 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant.PostPutQueryParameters.POINT;
13 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.NOTIFICATION_STREAM;
14 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAMS_PATH;
15 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_ACCESS_PATH_PART;
16 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_LOCATION_PATH_PART;
17 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_PATH;
18 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_PATH_PART;
21 import java.time.Clock;
22 import java.time.LocalDateTime;
23 import java.time.format.DateTimeFormatter;
24 import java.util.List;
25 import java.util.Map.Entry;
26 import java.util.Optional;
27 import java.util.concurrent.ExecutionException;
28 import javax.ws.rs.Path;
29 import javax.ws.rs.WebApplicationException;
30 import javax.ws.rs.core.Response;
31 import javax.ws.rs.core.UriInfo;
32 import org.eclipse.jdt.annotation.NonNull;
33 import org.eclipse.jdt.annotation.Nullable;
34 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
35 import org.opendaylight.mdsal.dom.api.DOMActionResult;
36 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
37 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
38 import org.opendaylight.netconf.dom.api.NetconfDataTreeService;
39 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
40 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
41 import org.opendaylight.restconf.common.context.WriterParameters;
42 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
43 import org.opendaylight.restconf.common.errors.RestconfError;
44 import org.opendaylight.restconf.common.errors.RestconfError.ErrorTag;
45 import org.opendaylight.restconf.common.errors.RestconfError.ErrorType;
46 import org.opendaylight.restconf.common.patch.PatchContext;
47 import org.opendaylight.restconf.common.patch.PatchStatusContext;
48 import org.opendaylight.restconf.nb.rfc8040.Rfc8040;
49 import org.opendaylight.restconf.nb.rfc8040.handlers.ActionServiceHandler;
50 import org.opendaylight.restconf.nb.rfc8040.handlers.DOMMountPointServiceHandler;
51 import org.opendaylight.restconf.nb.rfc8040.handlers.SchemaContextHandler;
52 import org.opendaylight.restconf.nb.rfc8040.handlers.TransactionChainHandler;
53 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfDataService;
54 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfStreamsSubscriptionService;
55 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.MdsalRestconfStrategy;
56 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.NetconfRestconfStrategy;
57 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfStrategy;
58 import org.opendaylight.restconf.nb.rfc8040.rests.utils.DeleteDataTransactionUtil;
59 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PatchDataTransactionUtil;
60 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PlainPatchDataTransactionUtil;
61 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PostDataTransactionUtil;
62 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PutDataTransactionUtil;
63 import org.opendaylight.restconf.nb.rfc8040.rests.utils.ReadDataTransactionUtil;
64 import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant;
65 import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfInvokeOperationsUtil;
66 import org.opendaylight.restconf.nb.rfc8040.streams.listeners.NotificationListenerAdapter;
67 import org.opendaylight.restconf.nb.rfc8040.utils.mapping.RestconfMappingNodeUtil;
68 import org.opendaylight.restconf.nb.rfc8040.utils.parser.IdentifierCodec;
69 import org.opendaylight.restconf.nb.rfc8040.utils.parser.ParserIdentifier;
70 import org.opendaylight.yang.gen.v1.urn.sal.restconf.event.subscription.rev140708.NotificationOutputTypeGrouping.NotificationOutputType;
71 import org.opendaylight.yangtools.concepts.Immutable;
72 import org.opendaylight.yangtools.yang.common.QName;
73 import org.opendaylight.yangtools.yang.common.Revision;
74 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
75 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
76 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
77 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
78 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
79 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
80 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
81 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
82 import org.slf4j.Logger;
83 import org.slf4j.LoggerFactory;
86 * Implementation of {@link RestconfDataService}.
89 public class RestconfDataServiceImpl implements RestconfDataService {
90 private static final class QueryParams implements Immutable {
91 final @Nullable String point;
92 final @Nullable String insert;
94 QueryParams(final @Nullable String insert, final @Nullable String point) {
100 private static final Logger LOG = LoggerFactory.getLogger(RestconfDataServiceImpl.class);
101 private static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("yyyy-MMM-dd HH:mm:ss");
103 private final RestconfStreamsSubscriptionService delegRestconfSubscrService;
105 // FIXME: evaluate thread-safety of updates (synchronized) vs. access (mostly unsynchronized) here
106 private SchemaContextHandler schemaContextHandler;
107 private TransactionChainHandler transactionChainHandler;
108 private DOMMountPointServiceHandler mountPointServiceHandler;
109 private volatile ActionServiceHandler actionServiceHandler;
111 public RestconfDataServiceImpl(final SchemaContextHandler schemaContextHandler,
112 final TransactionChainHandler transactionChainHandler,
113 final DOMMountPointServiceHandler mountPointServiceHandler,
114 final RestconfStreamsSubscriptionService delegRestconfSubscrService,
115 final ActionServiceHandler actionServiceHandler) {
116 this.actionServiceHandler = requireNonNull(actionServiceHandler);
117 this.schemaContextHandler = requireNonNull(schemaContextHandler);
118 this.transactionChainHandler = requireNonNull(transactionChainHandler);
119 this.mountPointServiceHandler = requireNonNull(mountPointServiceHandler);
120 this.delegRestconfSubscrService = requireNonNull(delegRestconfSubscrService);
124 public synchronized void updateHandlers(final Object... handlers) {
125 for (final Object object : handlers) {
126 if (object instanceof SchemaContextHandler) {
127 schemaContextHandler = (SchemaContextHandler) object;
128 } else if (object instanceof ActionServiceHandler) {
129 actionServiceHandler = (ActionServiceHandler) object;
130 } else if (object instanceof DOMMountPointServiceHandler) {
131 mountPointServiceHandler = (DOMMountPointServiceHandler) object;
132 } else if (object instanceof TransactionChainHandler) {
133 transactionChainHandler = (TransactionChainHandler) object;
139 public Response readData(final UriInfo uriInfo) {
140 return readData(null, uriInfo);
144 public Response readData(final String identifier, final UriInfo uriInfo) {
145 final EffectiveModelContext schemaContextRef = this.schemaContextHandler.get();
146 final InstanceIdentifierContext<?> instanceIdentifier = ParserIdentifier.toInstanceIdentifier(
147 identifier, schemaContextRef, Optional.of(this.mountPointServiceHandler.get()));
148 final WriterParameters parameters = ReadDataTransactionUtil.parseUriParameters(instanceIdentifier, uriInfo);
150 final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
151 final RestconfStrategy strategy = getRestconfStrategy(instanceIdentifier, mountPoint);
152 final NormalizedNode<?, ?> node = readData(identifier, parameters.getContent(),
153 strategy, parameters.getWithDefault(), schemaContextRef, uriInfo);
154 if (identifier != null && identifier.contains(STREAM_PATH) && identifier.contains(STREAM_ACCESS_PATH_PART)
155 && identifier.contains(STREAM_LOCATION_PATH_PART)) {
156 final String value = (String) node.getValue();
157 final String streamName = value.substring(value.indexOf(NOTIFICATION_STREAM + '/'));
158 this.delegRestconfSubscrService.subscribeToStream(streamName, uriInfo);
161 throw new RestconfDocumentedException(
162 "Request could not be completed because the relevant data model content does not exist",
163 RestconfError.ErrorType.PROTOCOL,
164 RestconfError.ErrorTag.DATA_MISSING);
167 if (parameters.getContent().equals(RestconfDataServiceConstant.ReadData.ALL)
168 || parameters.getContent().equals(RestconfDataServiceConstant.ReadData.CONFIG)) {
169 final QName type = node.getNodeType();
170 return Response.status(200)
171 .entity(new NormalizedNodeContext(instanceIdentifier, node, parameters))
172 .header("ETag", '"' + type.getModule().getRevision().map(Revision::toString).orElse(null)
173 + "-" + type.getLocalName() + '"')
174 .header("Last-Modified", FORMATTER.format(LocalDateTime.now(Clock.systemUTC())))
178 return Response.status(200).entity(new NormalizedNodeContext(instanceIdentifier, node, parameters)).build();
182 * Read specific type of data from data store via transaction and if identifier read data from
183 * streams then put streams from actual schema context to datastore.
185 * @param identifier identifier of data to read
186 * @param content type of data to read (config, state, all)
187 * @param strategy {@link RestconfStrategy} - object that perform the actual DS operations
188 * @param withDefa vaule of with-defaults parameter
189 * @param schemaContext schema context
190 * @param uriInfo uri info
191 * @return {@link NormalizedNode}
193 public static NormalizedNode<?, ?> readData(final String identifier, final String content,
194 final RestconfStrategy strategy, final String withDefa,
195 final EffectiveModelContext schemaContext, final UriInfo uriInfo) {
196 if (identifier != null && identifier.contains(STREAMS_PATH) && !identifier.contains(STREAM_PATH_PART)) {
197 createAllYangNotificationStreams(strategy, schemaContext, uriInfo);
199 return ReadDataTransactionUtil.readData(content, strategy, withDefa, schemaContext);
202 private static void createAllYangNotificationStreams(final RestconfStrategy strategy,
203 final EffectiveModelContext schemaContext,
204 final UriInfo uriInfo) {
205 strategy.prepareReadWriteExecution();
206 final boolean exist = checkExist(schemaContext, strategy);
208 for (final NotificationDefinition notificationDefinition : schemaContext.getNotifications()) {
209 final NotificationListenerAdapter notifiStreamXML =
210 CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext,
211 NotificationOutputType.XML);
212 final NotificationListenerAdapter notifiStreamJSON =
213 CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext,
214 NotificationOutputType.JSON);
215 writeNotificationStreamToDatastore(schemaContext, uriInfo, strategy, exist, notifiStreamXML);
216 writeNotificationStreamToDatastore(schemaContext, uriInfo, strategy, exist, notifiStreamJSON);
219 strategy.commit().get();
220 } catch (final InterruptedException | ExecutionException e) {
221 throw new RestconfDocumentedException("Problem while putting data to DS.", e);
225 private static void writeNotificationStreamToDatastore(final EffectiveModelContext schemaContext,
226 final UriInfo uriInfo, final RestconfStrategy strategy,
228 final NotificationListenerAdapter listener) {
229 final URI uri = SubscribeToStreamUtil.prepareUriByStreamName(uriInfo, listener.getStreamName());
230 final NormalizedNode<?, ?> mapToStreams =
231 RestconfMappingNodeUtil.mapYangNotificationStreamByIetfRestconfMonitoring(
232 listener.getSchemaPath().getLastComponent(), schemaContext.getNotifications(), null,
233 listener.getOutputType(), uri, SubscribeToStreamUtil.getMonitoringModule(schemaContext), exist);
234 writeDataToDS(schemaContext,
235 listener.getSchemaPath().getLastComponent().getLocalName(), strategy, exist, mapToStreams);
238 private static boolean checkExist(final EffectiveModelContext schemaContext, final RestconfStrategy strategy) {
240 return strategy.exists(LogicalDatastoreType.OPERATIONAL,
241 IdentifierCodec.deserialize(Rfc8040.MonitoringModule.PATH_TO_STREAMS, schemaContext)).get();
242 } catch (final InterruptedException | ExecutionException exception) {
243 throw new RestconfDocumentedException("Problem while checking data if exists", exception);
247 private static void writeDataToDS(final EffectiveModelContext schemaContext, final String name,
248 final RestconfStrategy strategy, final boolean exist,
249 final NormalizedNode mapToStreams) {
252 pathId = Rfc8040.MonitoringModule.PATH_TO_STREAM_WITHOUT_KEY + name;
254 pathId = Rfc8040.MonitoringModule.PATH_TO_STREAMS;
256 strategy.merge(LogicalDatastoreType.OPERATIONAL,
257 IdentifierCodec.deserialize(pathId, schemaContext), mapToStreams);
261 public Response putData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
262 requireNonNull(payload);
264 final QueryParams checkedParms = checkQueryParameters(uriInfo);
266 final InstanceIdentifierContext<? extends SchemaNode> iid = payload
267 .getInstanceIdentifierContext();
269 PutDataTransactionUtil.validInputData(iid.getSchemaNode(), payload);
270 PutDataTransactionUtil.validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
271 PutDataTransactionUtil.validateListKeysEqualityInPayloadAndUri(payload);
273 final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
274 final EffectiveModelContext ref = mountPoint == null
275 ? this.schemaContextHandler.get()
276 : mountPoint.getEffectiveModelContext();
278 final RestconfStrategy strategy = getRestconfStrategy(payload.getInstanceIdentifierContext(), mountPoint);
279 return PutDataTransactionUtil.putData(payload, ref, strategy, checkedParms.insert, checkedParms.point);
282 private static QueryParams checkQueryParameters(final UriInfo uriInfo) {
283 boolean insertUsed = false;
284 boolean pointUsed = false;
285 String insert = null;
288 for (final Entry<String, List<String>> entry : uriInfo.getQueryParameters().entrySet()) {
289 switch (entry.getKey()) {
293 insert = entry.getValue().get(0);
295 throw new RestconfDocumentedException("Insert parameter can be used only once.",
296 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
302 point = entry.getValue().get(0);
304 throw new RestconfDocumentedException("Point parameter can be used only once.",
305 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
309 throw new RestconfDocumentedException("Bad parameter for post: " + entry.getKey(),
310 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
314 checkQueryParams(insertUsed, pointUsed, insert);
315 return new QueryParams(insert, point);
318 private static void checkQueryParams(final boolean insertUsed, final boolean pointUsed, final String insert) {
319 if (pointUsed && !insertUsed) {
320 throw new RestconfDocumentedException("Point parameter can't be used without Insert parameter.",
321 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
323 if (pointUsed && (insert.equals("first") || insert.equals("last"))) {
324 throw new RestconfDocumentedException(
325 "Point parameter can be used only with 'after' or 'before' values of Insert parameter.",
326 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
331 public Response postData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
332 return postData(payload, uriInfo);
336 public Response postData(final NormalizedNodeContext payload, final UriInfo uriInfo) {
337 requireNonNull(payload);
338 if (payload.getInstanceIdentifierContext().getSchemaNode() instanceof ActionDefinition) {
339 return invokeAction(payload);
342 final QueryParams checkedParms = checkQueryParameters(uriInfo);
343 final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
344 final RestconfStrategy strategy = getRestconfStrategy(payload.getInstanceIdentifierContext(),
345 payload.getInstanceIdentifierContext().getMountPoint());
346 return PostDataTransactionUtil.postData(uriInfo, payload, strategy,
347 getSchemaContext(mountPoint), checkedParms.insert, checkedParms.point);
351 public Response deleteData(final String identifier) {
352 final InstanceIdentifierContext<?> instanceIdentifier = ParserIdentifier.toInstanceIdentifier(
353 identifier, this.schemaContextHandler.get(), Optional.of(this.mountPointServiceHandler.get()));
355 final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
356 final RestconfStrategy strategy = getRestconfStrategy(instanceIdentifier, mountPoint);
357 return DeleteDataTransactionUtil.deleteData(strategy);
361 public PatchStatusContext patchData(final String identifier, final PatchContext context, final UriInfo uriInfo) {
362 return patchData(context, uriInfo);
366 public PatchStatusContext patchData(final PatchContext context, final UriInfo uriInfo) {
367 final DOMMountPoint mountPoint = requireNonNull(context).getInstanceIdentifierContext().getMountPoint();
368 final RestconfStrategy strategy = getRestconfStrategy(context.getInstanceIdentifierContext(), mountPoint);
369 return PatchDataTransactionUtil.patchData(context, strategy, getSchemaContext(mountPoint));
373 public Response patchData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
374 requireNonNull(payload);
376 final InstanceIdentifierContext<? extends SchemaNode> iid = payload
377 .getInstanceIdentifierContext();
379 PutDataTransactionUtil.validInputData(iid.getSchemaNode(), payload);
380 PutDataTransactionUtil.validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
381 PutDataTransactionUtil.validateListKeysEqualityInPayloadAndUri(payload);
383 final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
384 final EffectiveModelContext ref = mountPoint == null
385 ? this.schemaContextHandler.get()
386 : mountPoint.getEffectiveModelContext();
387 final RestconfStrategy strategy = getRestconfStrategy(payload.getInstanceIdentifierContext(), mountPoint);
389 return PlainPatchDataTransactionUtil.patchData(payload, strategy, ref);
392 private EffectiveModelContext getSchemaContext(final DOMMountPoint mountPoint) {
393 return mountPoint == null ? schemaContextHandler.get() : mountPoint.getEffectiveModelContext();
396 public synchronized RestconfStrategy getRestconfStrategy(final InstanceIdentifierContext<?> instanceIdentifier,
397 final DOMMountPoint mountPoint) {
398 if (mountPoint != null) {
399 final Optional<NetconfDataTreeService> service = mountPoint.getService(NetconfDataTreeService.class);
400 if (service.isPresent()) {
401 return new NetconfRestconfStrategy(service.get(), instanceIdentifier);
404 final TransactionChainHandler transactionChain = mountPoint == null
405 ? transactionChainHandler : transactionChainOfMountPoint(mountPoint);
406 return new MdsalRestconfStrategy(instanceIdentifier, transactionChain);
410 * Prepare transaction chain to access data of mount point.
412 * @param mountPoint mount point reference
413 * @return {@link TransactionChainHandler}
415 private static TransactionChainHandler transactionChainOfMountPoint(final @NonNull DOMMountPoint mountPoint) {
416 final Optional<DOMDataBroker> domDataBrokerService = mountPoint.getService(DOMDataBroker.class);
417 if (domDataBrokerService.isPresent()) {
418 return new TransactionChainHandler(domDataBrokerService.get());
421 final String errMsg = "DOM data broker service isn't available for mount point " + mountPoint.getIdentifier();
423 throw new RestconfDocumentedException(errMsg);
427 * Invoke Action operation.
429 * @param payload {@link NormalizedNodeContext} - the body of the operation
430 * @return {@link NormalizedNodeContext} wrapped in {@link Response}
432 public Response invokeAction(final NormalizedNodeContext payload) {
433 final InstanceIdentifierContext<?> context = payload.getInstanceIdentifierContext();
434 final DOMMountPoint mountPoint = context.getMountPoint();
435 final SchemaPath schemaPath = context.getSchemaNode().getPath();
436 final YangInstanceIdentifier yangIIdContext = context.getInstanceIdentifier();
437 final NormalizedNode<?, ?> data = payload.getData();
439 if (yangIIdContext.isEmpty() && !RestconfDataServiceConstant.NETCONF_BASE_QNAME.equals(data.getNodeType())) {
440 throw new RestconfDocumentedException("Instance identifier need to contain at least one path argument",
441 ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
444 final DOMActionResult response;
445 final EffectiveModelContext schemaContextRef;
446 if (mountPoint != null) {
447 response = RestconfInvokeOperationsUtil.invokeActionViaMountPoint(mountPoint, (ContainerNode) data,
448 schemaPath, yangIIdContext);
449 schemaContextRef = mountPoint.getEffectiveModelContext();
451 response = RestconfInvokeOperationsUtil.invokeAction((ContainerNode) data, schemaPath,
452 this.actionServiceHandler, yangIIdContext);
453 schemaContextRef = this.schemaContextHandler.get();
455 final DOMActionResult result = RestconfInvokeOperationsUtil.checkActionResponse(response);
457 ActionDefinition resultNodeSchema = null;
458 ContainerNode resultData = null;
459 if (result != null) {
460 final Optional<ContainerNode> optOutput = result.getOutput();
461 if (optOutput.isPresent()) {
462 resultData = optOutput.get();
463 resultNodeSchema = (ActionDefinition) context.getSchemaNode();
467 if (resultData != null && resultData.getValue().isEmpty()) {
468 throw new WebApplicationException(Response.Status.NO_CONTENT);
471 return Response.status(200).entity(new NormalizedNodeContext(new InstanceIdentifierContext<>(yangIIdContext,
472 resultNodeSchema, mountPoint, schemaContextRef), resultData)).build();