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.Configuration;
67 import org.opendaylight.restconf.nb.rfc8040.streams.listeners.NotificationListenerAdapter;
68 import org.opendaylight.restconf.nb.rfc8040.utils.mapping.RestconfMappingNodeUtil;
69 import org.opendaylight.restconf.nb.rfc8040.utils.parser.IdentifierCodec;
70 import org.opendaylight.restconf.nb.rfc8040.utils.parser.ParserIdentifier;
71 import org.opendaylight.yang.gen.v1.urn.sal.restconf.event.subscription.rev140708.NotificationOutputTypeGrouping.NotificationOutputType;
72 import org.opendaylight.yangtools.concepts.Immutable;
73 import org.opendaylight.yangtools.yang.common.QName;
74 import org.opendaylight.yangtools.yang.common.Revision;
75 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
76 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
77 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
78 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
79 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
80 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
81 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
82 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
83 import org.slf4j.Logger;
84 import org.slf4j.LoggerFactory;
87 * Implementation of {@link RestconfDataService}.
90 public class RestconfDataServiceImpl implements RestconfDataService {
91 private static final class QueryParams implements Immutable {
92 final @Nullable String point;
93 final @Nullable String insert;
95 QueryParams(final @Nullable String insert, final @Nullable String point) {
101 private static final Logger LOG = LoggerFactory.getLogger(RestconfDataServiceImpl.class);
102 private static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("yyyy-MMM-dd HH:mm:ss");
104 private final RestconfStreamsSubscriptionService delegRestconfSubscrService;
105 private final SubscribeToStreamUtil streamUtils;
107 // FIXME: evaluate thread-safety of updates (synchronized) vs. access (mostly unsynchronized) here
108 private SchemaContextHandler schemaContextHandler;
109 private TransactionChainHandler transactionChainHandler;
110 private DOMMountPointServiceHandler mountPointServiceHandler;
111 private volatile ActionServiceHandler actionServiceHandler;
113 public RestconfDataServiceImpl(final SchemaContextHandler schemaContextHandler,
114 final TransactionChainHandler transactionChainHandler,
115 final DOMMountPointServiceHandler mountPointServiceHandler,
116 final RestconfStreamsSubscriptionService delegRestconfSubscrService,
117 final ActionServiceHandler actionServiceHandler,
118 final Configuration configuration) {
119 this.actionServiceHandler = requireNonNull(actionServiceHandler);
120 this.schemaContextHandler = requireNonNull(schemaContextHandler);
121 this.transactionChainHandler = requireNonNull(transactionChainHandler);
122 this.mountPointServiceHandler = requireNonNull(mountPointServiceHandler);
123 this.delegRestconfSubscrService = requireNonNull(delegRestconfSubscrService);
124 streamUtils = configuration.isUseSSE() ? SubscribeToStreamUtil.serverSentEvents()
125 : SubscribeToStreamUtil.webSockets();
129 public synchronized void updateHandlers(final Object... handlers) {
130 for (final Object object : handlers) {
131 if (object instanceof SchemaContextHandler) {
132 schemaContextHandler = (SchemaContextHandler) object;
133 } else if (object instanceof ActionServiceHandler) {
134 actionServiceHandler = (ActionServiceHandler) object;
135 } else if (object instanceof DOMMountPointServiceHandler) {
136 mountPointServiceHandler = (DOMMountPointServiceHandler) object;
137 } else if (object instanceof TransactionChainHandler) {
138 transactionChainHandler = (TransactionChainHandler) object;
144 public Response readData(final UriInfo uriInfo) {
145 return readData(null, uriInfo);
149 public Response readData(final String identifier, final UriInfo uriInfo) {
150 final EffectiveModelContext schemaContextRef = this.schemaContextHandler.get();
151 final InstanceIdentifierContext<?> instanceIdentifier = ParserIdentifier.toInstanceIdentifier(
152 identifier, schemaContextRef, Optional.of(this.mountPointServiceHandler.get()));
153 final WriterParameters parameters = ReadDataTransactionUtil.parseUriParameters(instanceIdentifier, uriInfo);
155 final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
156 final RestconfStrategy strategy = getRestconfStrategy(instanceIdentifier, mountPoint);
157 final NormalizedNode<?, ?> node = readData(identifier, parameters.getContent(),
158 strategy, parameters.getWithDefault(), schemaContextRef, uriInfo);
159 if (identifier != null && identifier.contains(STREAM_PATH) && identifier.contains(STREAM_ACCESS_PATH_PART)
160 && identifier.contains(STREAM_LOCATION_PATH_PART)) {
161 final String value = (String) node.getValue();
162 final String streamName = value.substring(value.indexOf(NOTIFICATION_STREAM + '/'));
163 this.delegRestconfSubscrService.subscribeToStream(streamName, uriInfo);
166 throw new RestconfDocumentedException(
167 "Request could not be completed because the relevant data model content does not exist",
168 RestconfError.ErrorType.PROTOCOL,
169 RestconfError.ErrorTag.DATA_MISSING);
172 if (parameters.getContent().equals(RestconfDataServiceConstant.ReadData.ALL)
173 || parameters.getContent().equals(RestconfDataServiceConstant.ReadData.CONFIG)) {
174 final QName type = node.getNodeType();
175 return Response.status(200)
176 .entity(new NormalizedNodeContext(instanceIdentifier, node, parameters))
177 .header("ETag", '"' + type.getModule().getRevision().map(Revision::toString).orElse(null)
178 + "-" + type.getLocalName() + '"')
179 .header("Last-Modified", FORMATTER.format(LocalDateTime.now(Clock.systemUTC())))
183 return Response.status(200).entity(new NormalizedNodeContext(instanceIdentifier, node, parameters)).build();
187 * Read specific type of data from data store via transaction and if identifier read data from
188 * streams then put streams from actual schema context to datastore.
190 * @param identifier identifier of data to read
191 * @param content type of data to read (config, state, all)
192 * @param strategy {@link RestconfStrategy} - object that perform the actual DS operations
193 * @param withDefa value of with-defaults parameter
194 * @param schemaContext schema context
195 * @param uriInfo uri info
196 * @return {@link NormalizedNode}
198 private NormalizedNode<?, ?> readData(final String identifier, final String content,
199 final RestconfStrategy strategy, final String withDefa, final EffectiveModelContext schemaContext,
200 final UriInfo uriInfo) {
201 if (identifier != null && identifier.contains(STREAMS_PATH) && !identifier.contains(STREAM_PATH_PART)) {
202 createAllYangNotificationStreams(strategy, schemaContext, uriInfo);
204 return ReadDataTransactionUtil.readData(content, strategy, withDefa, schemaContext);
207 private void createAllYangNotificationStreams(final RestconfStrategy strategy,
208 final EffectiveModelContext schemaContext, final UriInfo uriInfo) {
209 strategy.prepareReadWriteExecution();
210 final boolean exist = checkExist(schemaContext, strategy);
212 for (final NotificationDefinition notificationDefinition : schemaContext.getNotifications()) {
213 final NotificationListenerAdapter notifiStreamXML =
214 CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext,
215 NotificationOutputType.XML);
216 final NotificationListenerAdapter notifiStreamJSON =
217 CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext,
218 NotificationOutputType.JSON);
219 writeNotificationStreamToDatastore(schemaContext, uriInfo, strategy, exist, notifiStreamXML);
220 writeNotificationStreamToDatastore(schemaContext, uriInfo, strategy, exist, notifiStreamJSON);
223 strategy.commit().get();
224 } catch (final InterruptedException | ExecutionException e) {
225 throw new RestconfDocumentedException("Problem while putting data to DS.", e);
229 private void writeNotificationStreamToDatastore(final EffectiveModelContext schemaContext,
230 final UriInfo uriInfo, final RestconfStrategy strategy, final boolean exist,
231 final NotificationListenerAdapter listener) {
232 final URI uri = streamUtils.prepareUriByStreamName(uriInfo, listener.getStreamName());
233 final NormalizedNode<?, ?> mapToStreams =
234 RestconfMappingNodeUtil.mapYangNotificationStreamByIetfRestconfMonitoring(
235 listener.getSchemaPath().getLastComponent(), schemaContext.getNotifications(), null,
236 listener.getOutputType(), uri, SubscribeToStreamUtil.getMonitoringModule(schemaContext), exist);
237 writeDataToDS(schemaContext,
238 listener.getSchemaPath().getLastComponent().getLocalName(), strategy, exist, mapToStreams);
241 private static boolean checkExist(final EffectiveModelContext schemaContext, final RestconfStrategy strategy) {
243 return strategy.exists(LogicalDatastoreType.OPERATIONAL,
244 IdentifierCodec.deserialize(Rfc8040.MonitoringModule.PATH_TO_STREAMS, schemaContext)).get();
245 } catch (final InterruptedException | ExecutionException exception) {
246 throw new RestconfDocumentedException("Problem while checking data if exists", exception);
250 private static void writeDataToDS(final EffectiveModelContext schemaContext, final String name,
251 final RestconfStrategy strategy, final boolean exist,
252 final NormalizedNode<?, ?> mapToStreams) {
255 pathId = Rfc8040.MonitoringModule.PATH_TO_STREAM_WITHOUT_KEY + name;
257 pathId = Rfc8040.MonitoringModule.PATH_TO_STREAMS;
259 strategy.merge(LogicalDatastoreType.OPERATIONAL, IdentifierCodec.deserialize(pathId, schemaContext),
264 public Response putData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
265 requireNonNull(payload);
267 final QueryParams checkedParms = checkQueryParameters(uriInfo);
269 final InstanceIdentifierContext<? extends SchemaNode> iid = payload.getInstanceIdentifierContext();
271 PutDataTransactionUtil.validInputData(iid.getSchemaNode(), payload);
272 PutDataTransactionUtil.validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
273 PutDataTransactionUtil.validateListKeysEqualityInPayloadAndUri(payload);
275 final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
276 final EffectiveModelContext ref = mountPoint == null
277 ? this.schemaContextHandler.get()
278 : mountPoint.getEffectiveModelContext();
280 final RestconfStrategy strategy = getRestconfStrategy(payload.getInstanceIdentifierContext(), mountPoint);
281 return PutDataTransactionUtil.putData(payload, ref, strategy, checkedParms.insert, checkedParms.point);
284 private static QueryParams checkQueryParameters(final UriInfo uriInfo) {
285 boolean insertUsed = false;
286 boolean pointUsed = false;
287 String insert = null;
290 for (final Entry<String, List<String>> entry : uriInfo.getQueryParameters().entrySet()) {
291 switch (entry.getKey()) {
295 insert = entry.getValue().get(0);
297 throw new RestconfDocumentedException("Insert parameter can be used only once.",
298 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
304 point = entry.getValue().get(0);
306 throw new RestconfDocumentedException("Point parameter can be used only once.",
307 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
311 throw new RestconfDocumentedException("Bad parameter for post: " + entry.getKey(),
312 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
316 checkQueryParams(insertUsed, pointUsed, insert);
317 return new QueryParams(insert, point);
320 private static void checkQueryParams(final boolean insertUsed, final boolean pointUsed, final String insert) {
321 if (pointUsed && !insertUsed) {
322 throw new RestconfDocumentedException("Point parameter can't be used without Insert parameter.",
323 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
325 if (pointUsed && (insert.equals("first") || insert.equals("last"))) {
326 throw new RestconfDocumentedException(
327 "Point parameter can be used only with 'after' or 'before' values of Insert parameter.",
328 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
333 public Response postData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
334 return postData(payload, uriInfo);
338 public Response postData(final NormalizedNodeContext payload, final UriInfo uriInfo) {
339 requireNonNull(payload);
340 if (payload.getInstanceIdentifierContext().getSchemaNode() instanceof ActionDefinition) {
341 return invokeAction(payload);
344 final QueryParams checkedParms = checkQueryParameters(uriInfo);
345 final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
346 final RestconfStrategy strategy = getRestconfStrategy(payload.getInstanceIdentifierContext(),
347 payload.getInstanceIdentifierContext().getMountPoint());
348 return PostDataTransactionUtil.postData(uriInfo, payload, strategy,
349 getSchemaContext(mountPoint), checkedParms.insert, checkedParms.point);
353 public Response deleteData(final String identifier) {
354 final InstanceIdentifierContext<?> instanceIdentifier = ParserIdentifier.toInstanceIdentifier(
355 identifier, this.schemaContextHandler.get(), Optional.of(this.mountPointServiceHandler.get()));
357 final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
358 final RestconfStrategy strategy = getRestconfStrategy(instanceIdentifier, mountPoint);
359 return DeleteDataTransactionUtil.deleteData(strategy);
363 public PatchStatusContext patchData(final String identifier, final PatchContext context, final UriInfo uriInfo) {
364 return patchData(context, uriInfo);
368 public PatchStatusContext patchData(final PatchContext context, final UriInfo uriInfo) {
369 final DOMMountPoint mountPoint = requireNonNull(context).getInstanceIdentifierContext().getMountPoint();
370 final RestconfStrategy strategy = getRestconfStrategy(context.getInstanceIdentifierContext(), mountPoint);
371 return PatchDataTransactionUtil.patchData(context, strategy, getSchemaContext(mountPoint));
375 public Response patchData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
376 requireNonNull(payload);
378 final InstanceIdentifierContext<? extends SchemaNode> iid = payload
379 .getInstanceIdentifierContext();
381 PutDataTransactionUtil.validInputData(iid.getSchemaNode(), payload);
382 PutDataTransactionUtil.validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
383 PutDataTransactionUtil.validateListKeysEqualityInPayloadAndUri(payload);
385 final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
386 final EffectiveModelContext ref = mountPoint == null
387 ? this.schemaContextHandler.get()
388 : mountPoint.getEffectiveModelContext();
389 final RestconfStrategy strategy = getRestconfStrategy(payload.getInstanceIdentifierContext(), mountPoint);
391 return PlainPatchDataTransactionUtil.patchData(payload, strategy, ref);
394 private EffectiveModelContext getSchemaContext(final DOMMountPoint mountPoint) {
395 return mountPoint == null ? schemaContextHandler.get() : mountPoint.getEffectiveModelContext();
398 public synchronized RestconfStrategy getRestconfStrategy(final InstanceIdentifierContext<?> instanceIdentifier,
399 final DOMMountPoint mountPoint) {
400 if (mountPoint != null) {
401 final Optional<NetconfDataTreeService> service = mountPoint.getService(NetconfDataTreeService.class);
402 if (service.isPresent()) {
403 return new NetconfRestconfStrategy(service.get(), instanceIdentifier);
406 final TransactionChainHandler transactionChain = mountPoint == null
407 ? transactionChainHandler : transactionChainOfMountPoint(mountPoint);
408 return new MdsalRestconfStrategy(instanceIdentifier, transactionChain);
412 * Prepare transaction chain to access data of mount point.
414 * @param mountPoint mount point reference
415 * @return {@link TransactionChainHandler}
417 private static TransactionChainHandler transactionChainOfMountPoint(final @NonNull DOMMountPoint mountPoint) {
418 final Optional<DOMDataBroker> domDataBrokerService = mountPoint.getService(DOMDataBroker.class);
419 if (domDataBrokerService.isPresent()) {
420 return new TransactionChainHandler(domDataBrokerService.get());
423 final String errMsg = "DOM data broker service isn't available for mount point " + mountPoint.getIdentifier();
425 throw new RestconfDocumentedException(errMsg);
429 * Invoke Action operation.
431 * @param payload {@link NormalizedNodeContext} - the body of the operation
432 * @return {@link NormalizedNodeContext} wrapped in {@link Response}
434 public Response invokeAction(final NormalizedNodeContext payload) {
435 final InstanceIdentifierContext<?> context = payload.getInstanceIdentifierContext();
436 final DOMMountPoint mountPoint = context.getMountPoint();
437 final SchemaPath schemaPath = context.getSchemaNode().getPath();
438 final YangInstanceIdentifier yangIIdContext = context.getInstanceIdentifier();
439 final NormalizedNode<?, ?> data = payload.getData();
441 if (yangIIdContext.isEmpty() && !RestconfDataServiceConstant.NETCONF_BASE_QNAME.equals(data.getNodeType())) {
442 throw new RestconfDocumentedException("Instance identifier need to contain at least one path argument",
443 ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
446 final DOMActionResult response;
447 final EffectiveModelContext schemaContextRef;
448 if (mountPoint != null) {
449 response = RestconfInvokeOperationsUtil.invokeActionViaMountPoint(mountPoint, (ContainerNode) data,
450 schemaPath, yangIIdContext);
451 schemaContextRef = mountPoint.getEffectiveModelContext();
453 response = RestconfInvokeOperationsUtil.invokeAction((ContainerNode) data, schemaPath,
454 this.actionServiceHandler, yangIIdContext);
455 schemaContextRef = this.schemaContextHandler.get();
457 final DOMActionResult result = RestconfInvokeOperationsUtil.checkActionResponse(response);
459 ActionDefinition resultNodeSchema = null;
460 ContainerNode resultData = null;
461 if (result != null) {
462 final Optional<ContainerNode> optOutput = result.getOutput();
463 if (optOutput.isPresent()) {
464 resultData = optOutput.get();
465 resultNodeSchema = (ActionDefinition) context.getSchemaNode();
469 if (resultData != null && resultData.getValue().isEmpty()) {
470 throw new WebApplicationException(Response.Status.NO_CONTENT);
473 return Response.status(200).entity(new NormalizedNodeContext(new InstanceIdentifierContext<>(yangIIdContext,
474 resultNodeSchema, mountPoint, schemaContextRef), resultData)).build();