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.STREAM_ACCESS_PATH_PART;
15 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_LOCATION_PATH_PART;
16 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_PATH;
18 import java.time.Clock;
19 import java.time.LocalDateTime;
20 import java.time.format.DateTimeFormatter;
21 import java.util.List;
22 import java.util.Map.Entry;
23 import java.util.Optional;
24 import javax.ws.rs.Path;
25 import javax.ws.rs.WebApplicationException;
26 import javax.ws.rs.core.Response;
27 import javax.ws.rs.core.UriInfo;
28 import org.eclipse.jdt.annotation.NonNull;
29 import org.eclipse.jdt.annotation.Nullable;
30 import org.opendaylight.mdsal.dom.api.DOMActionResult;
31 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
32 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
33 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
34 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
35 import org.opendaylight.restconf.common.context.WriterParameters;
36 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
37 import org.opendaylight.restconf.common.errors.RestconfError;
38 import org.opendaylight.restconf.common.errors.RestconfError.ErrorTag;
39 import org.opendaylight.restconf.common.errors.RestconfError.ErrorType;
40 import org.opendaylight.restconf.common.patch.PatchContext;
41 import org.opendaylight.restconf.common.patch.PatchStatusContext;
42 import org.opendaylight.restconf.nb.rfc8040.handlers.ActionServiceHandler;
43 import org.opendaylight.restconf.nb.rfc8040.handlers.DOMMountPointServiceHandler;
44 import org.opendaylight.restconf.nb.rfc8040.handlers.SchemaContextHandler;
45 import org.opendaylight.restconf.nb.rfc8040.handlers.TransactionChainHandler;
46 import org.opendaylight.restconf.nb.rfc8040.references.SchemaContextRef;
47 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfDataService;
48 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfStreamsSubscriptionService;
49 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.TransactionVarsWrapper;
50 import org.opendaylight.restconf.nb.rfc8040.rests.utils.DeleteDataTransactionUtil;
51 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PatchDataTransactionUtil;
52 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PlainPatchDataTransactionUtil;
53 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PostDataTransactionUtil;
54 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PutDataTransactionUtil;
55 import org.opendaylight.restconf.nb.rfc8040.rests.utils.ReadDataTransactionUtil;
56 import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant;
57 import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfInvokeOperationsUtil;
58 import org.opendaylight.restconf.nb.rfc8040.utils.RestconfConstants;
59 import org.opendaylight.restconf.nb.rfc8040.utils.parser.ParserIdentifier;
60 import org.opendaylight.yangtools.concepts.Immutable;
61 import org.opendaylight.yangtools.yang.common.QName;
62 import org.opendaylight.yangtools.yang.common.Revision;
63 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
64 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
65 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
66 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
67 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
68 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
69 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
70 import org.slf4j.Logger;
71 import org.slf4j.LoggerFactory;
74 * Implementation of {@link RestconfDataService}.
77 public class RestconfDataServiceImpl implements RestconfDataService {
78 private static final class QueryParams implements Immutable {
79 final @Nullable String point;
80 final @Nullable String insert;
82 QueryParams(final @Nullable String insert, final @Nullable String point) {
88 private static final Logger LOG = LoggerFactory.getLogger(RestconfDataServiceImpl.class);
89 private static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("yyyy-MMM-dd HH:mm:ss");
91 private final RestconfStreamsSubscriptionService delegRestconfSubscrService;
93 // FIXME: evaluate thread-safety of updates (synchronized) vs. access (mostly unsynchronized) here
94 private SchemaContextHandler schemaContextHandler;
95 private TransactionChainHandler transactionChainHandler;
96 private DOMMountPointServiceHandler mountPointServiceHandler;
97 private volatile ActionServiceHandler actionServiceHandler;
99 public RestconfDataServiceImpl(final SchemaContextHandler schemaContextHandler,
100 final TransactionChainHandler transactionChainHandler,
101 final DOMMountPointServiceHandler mountPointServiceHandler,
102 final RestconfStreamsSubscriptionService delegRestconfSubscrService,
103 final ActionServiceHandler actionServiceHandler) {
104 this.actionServiceHandler = requireNonNull(actionServiceHandler);
105 this.schemaContextHandler = requireNonNull(schemaContextHandler);
106 this.transactionChainHandler = requireNonNull(transactionChainHandler);
107 this.mountPointServiceHandler = requireNonNull(mountPointServiceHandler);
108 this.delegRestconfSubscrService = requireNonNull(delegRestconfSubscrService);
112 public synchronized void updateHandlers(final Object... handlers) {
113 for (final Object object : handlers) {
114 if (object instanceof SchemaContextHandler) {
115 schemaContextHandler = (SchemaContextHandler) object;
116 } else if (object instanceof ActionServiceHandler) {
117 actionServiceHandler = (ActionServiceHandler) object;
118 } else if (object instanceof DOMMountPointServiceHandler) {
119 mountPointServiceHandler = (DOMMountPointServiceHandler) object;
120 } else if (object instanceof TransactionChainHandler) {
121 transactionChainHandler = (TransactionChainHandler) object;
127 public Response readData(final UriInfo uriInfo) {
128 return readData(null, uriInfo);
132 public Response readData(final String identifier, final UriInfo uriInfo) {
133 final SchemaContextRef schemaContextRef = new SchemaContextRef(this.schemaContextHandler.get());
134 final InstanceIdentifierContext<?> instanceIdentifier = ParserIdentifier.toInstanceIdentifier(
135 identifier, schemaContextRef.get(), Optional.of(this.mountPointServiceHandler.get()));
136 final WriterParameters parameters = ReadDataTransactionUtil.parseUriParameters(instanceIdentifier, uriInfo);
138 final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
139 final TransactionVarsWrapper transactionNode = new TransactionVarsWrapper(
140 instanceIdentifier, mountPoint, getTransactionChainHandler(mountPoint));
141 final NormalizedNode<?, ?> node = ReadDataTransactionUtil.readData(identifier, parameters.getContent(),
142 transactionNode, parameters.getWithDefault(), schemaContextRef, uriInfo);
143 if (identifier != null && identifier.contains(STREAM_PATH) && identifier.contains(STREAM_ACCESS_PATH_PART)
144 && identifier.contains(STREAM_LOCATION_PATH_PART)) {
145 final String value = (String) node.getValue();
146 final String streamName = value.substring(
147 value.indexOf(NOTIFICATION_STREAM + RestconfConstants.SLASH));
148 this.delegRestconfSubscrService.subscribeToStream(streamName, uriInfo);
151 throw new RestconfDocumentedException(
152 "Request could not be completed because the relevant data model content does not exist",
153 RestconfError.ErrorType.PROTOCOL,
154 RestconfError.ErrorTag.DATA_MISSING);
157 if (parameters.getContent().equals(RestconfDataServiceConstant.ReadData.ALL)
158 || parameters.getContent().equals(RestconfDataServiceConstant.ReadData.CONFIG)) {
159 final QName type = node.getNodeType();
160 return Response.status(200)
161 .entity(new NormalizedNodeContext(instanceIdentifier, node, parameters))
162 .header("ETag", '"' + type.getModule().getRevision().map(Revision::toString).orElse(null)
163 + type.getLocalName() + '"')
164 .header("Last-Modified", FORMATTER.format(LocalDateTime.now(Clock.systemUTC())))
168 return Response.status(200).entity(new NormalizedNodeContext(instanceIdentifier, node, parameters)).build();
172 public Response putData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
173 requireNonNull(payload);
175 final QueryParams checkedParms = checkQueryParameters(uriInfo);
177 final InstanceIdentifierContext<? extends SchemaNode> iid = payload
178 .getInstanceIdentifierContext();
180 PutDataTransactionUtil.validInputData(iid.getSchemaNode(), payload);
181 PutDataTransactionUtil.validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
182 PutDataTransactionUtil.validateListKeysEqualityInPayloadAndUri(payload);
184 final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
185 final TransactionChainHandler localTransactionChainHandler;
186 final SchemaContextRef ref;
187 if (mountPoint == null) {
188 localTransactionChainHandler = this.transactionChainHandler;
189 ref = new SchemaContextRef(this.schemaContextHandler.get());
191 localTransactionChainHandler = transactionChainOfMountPoint(mountPoint);
192 ref = new SchemaContextRef(mountPoint.getEffectiveModelContext());
195 final TransactionVarsWrapper transactionNode = new TransactionVarsWrapper(
196 payload.getInstanceIdentifierContext(), mountPoint, localTransactionChainHandler);
197 return PutDataTransactionUtil.putData(payload, ref, transactionNode, checkedParms.insert, checkedParms.point);
200 private static QueryParams checkQueryParameters(final UriInfo uriInfo) {
201 boolean insertUsed = false;
202 boolean pointUsed = false;
203 String insert = null;
206 for (final Entry<String, List<String>> entry : uriInfo.getQueryParameters().entrySet()) {
207 switch (entry.getKey()) {
211 insert = entry.getValue().get(0);
213 throw new RestconfDocumentedException("Insert parameter can be used only once.",
214 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
220 point = entry.getValue().get(0);
222 throw new RestconfDocumentedException("Point parameter can be used only once.",
223 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
227 throw new RestconfDocumentedException("Bad parameter for post: " + entry.getKey(),
228 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
232 checkQueryParams(insertUsed, pointUsed, insert);
233 return new QueryParams(insert, point);
236 private static void checkQueryParams(final boolean insertUsed, final boolean pointUsed, final String insert) {
237 if (pointUsed && !insertUsed) {
238 throw new RestconfDocumentedException("Point parameter can't be used without Insert parameter.",
239 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
241 if (pointUsed && (insert.equals("first") || insert.equals("last"))) {
242 throw new RestconfDocumentedException(
243 "Point parameter can be used only with 'after' or 'before' values of Insert parameter.",
244 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
249 public Response postData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
250 return postData(payload, uriInfo);
254 public Response postData(final NormalizedNodeContext payload, final UriInfo uriInfo) {
255 requireNonNull(payload);
256 if (payload.getInstanceIdentifierContext().getSchemaNode() instanceof ActionDefinition) {
257 return invokeAction(payload, uriInfo);
260 final QueryParams checkedParms = checkQueryParameters(uriInfo);
262 final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
263 final TransactionVarsWrapper transactionNode = new TransactionVarsWrapper(
264 payload.getInstanceIdentifierContext(), mountPoint, getTransactionChainHandler(mountPoint));
265 return PostDataTransactionUtil.postData(uriInfo, payload, transactionNode,
266 getSchemaContext(mountPoint), checkedParms.insert, checkedParms.point);
270 public Response deleteData(final String identifier) {
271 final InstanceIdentifierContext<?> instanceIdentifier = ParserIdentifier.toInstanceIdentifier(
272 identifier, this.schemaContextHandler.get(), Optional.of(this.mountPointServiceHandler.get()));
274 final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
275 final TransactionChainHandler localTransactionChainHandler;
276 if (mountPoint == null) {
277 localTransactionChainHandler = this.transactionChainHandler;
279 localTransactionChainHandler = transactionChainOfMountPoint(mountPoint);
282 final TransactionVarsWrapper transactionNode = new TransactionVarsWrapper(instanceIdentifier, mountPoint,
283 localTransactionChainHandler);
284 return DeleteDataTransactionUtil.deleteData(transactionNode);
288 public PatchStatusContext patchData(final String identifier, final PatchContext context, final UriInfo uriInfo) {
289 return patchData(context, uriInfo);
293 public PatchStatusContext patchData(final PatchContext context, final UriInfo uriInfo) {
294 final DOMMountPoint mountPoint = requireNonNull(context).getInstanceIdentifierContext().getMountPoint();
295 final TransactionVarsWrapper transactionNode = new TransactionVarsWrapper(
296 context.getInstanceIdentifierContext(), mountPoint, getTransactionChainHandler(mountPoint));
297 return PatchDataTransactionUtil.patchData(context, transactionNode, getSchemaContext(mountPoint));
301 public Response patchData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
302 requireNonNull(payload);
304 final InstanceIdentifierContext<? extends SchemaNode> iid = payload
305 .getInstanceIdentifierContext();
307 PutDataTransactionUtil.validInputData(iid.getSchemaNode(), payload);
308 PutDataTransactionUtil.validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
309 PutDataTransactionUtil.validateListKeysEqualityInPayloadAndUri(payload);
311 final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
312 final TransactionChainHandler localTransactionChainHandler;
313 final SchemaContextRef ref;
314 if (mountPoint == null) {
315 localTransactionChainHandler = this.transactionChainHandler;
316 ref = new SchemaContextRef(this.schemaContextHandler.get());
318 localTransactionChainHandler = transactionChainOfMountPoint(mountPoint);
319 ref = new SchemaContextRef(mountPoint.getEffectiveModelContext());
322 final TransactionVarsWrapper transactionNode = new TransactionVarsWrapper(
323 payload.getInstanceIdentifierContext(), mountPoint, localTransactionChainHandler);
325 return PlainPatchDataTransactionUtil.patchData(payload, transactionNode, ref);
328 private TransactionChainHandler getTransactionChainHandler(final DOMMountPoint mountPoint) {
329 return mountPoint == null ? transactionChainHandler : transactionChainOfMountPoint(mountPoint);
332 private SchemaContextRef getSchemaContext(final DOMMountPoint mountPoint) {
333 return mountPoint == null ? new SchemaContextRef(schemaContextHandler.get())
334 : new SchemaContextRef(mountPoint.getEffectiveModelContext());
338 * Prepare transaction chain to access data of mount point.
340 * mount point reference
341 * @return {@link TransactionChainHandler}
343 private static TransactionChainHandler transactionChainOfMountPoint(final @NonNull DOMMountPoint mountPoint) {
344 final Optional<DOMDataBroker> domDataBrokerService = mountPoint.getService(DOMDataBroker.class);
345 if (domDataBrokerService.isPresent()) {
346 return new TransactionChainHandler(domDataBrokerService.get());
349 final String errMsg = "DOM data broker service isn't available for mount point " + mountPoint.getIdentifier();
351 throw new RestconfDocumentedException(errMsg);
355 * Invoke Action operation.
358 * {@link NormalizedNodeContext} - the body of the operation
361 * @return {@link NormalizedNodeContext} wrapped in {@link Response}
363 public Response invokeAction(final NormalizedNodeContext payload, final UriInfo uriInfo) {
364 final InstanceIdentifierContext<?> context = payload.getInstanceIdentifierContext();
365 final DOMMountPoint mountPoint = context.getMountPoint();
366 final SchemaPath schemaPath = context.getSchemaNode().getPath();
367 final YangInstanceIdentifier yangIIdContext = context.getInstanceIdentifier();
368 final NormalizedNode<?, ?> data = payload.getData();
370 if (yangIIdContext.isEmpty() && !RestconfDataServiceConstant.NETCONF_BASE_QNAME.equals(data.getNodeType())) {
371 throw new RestconfDocumentedException("Instance identifier need to contain at least one path argument",
372 ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
375 final DOMActionResult response;
376 final EffectiveModelContext schemaContextRef;
377 if (mountPoint != null) {
378 response = RestconfInvokeOperationsUtil.invokeActionViaMountPoint(mountPoint, (ContainerNode) data,
379 schemaPath, yangIIdContext);
380 schemaContextRef = mountPoint.getEffectiveModelContext();
382 response = RestconfInvokeOperationsUtil.invokeAction((ContainerNode) data, schemaPath,
383 this.actionServiceHandler, yangIIdContext);
384 schemaContextRef = this.schemaContextHandler.get();
386 final DOMActionResult result = RestconfInvokeOperationsUtil.checkActionResponse(response);
388 ActionDefinition resultNodeSchema = null;
389 ContainerNode resultData = null;
390 if (result != null) {
391 final Optional<ContainerNode> optOutput = result.getOutput();
392 if (optOutput.isPresent()) {
393 resultData = optOutput.get();
394 resultNodeSchema = (ActionDefinition) context.getSchemaNode();
398 if (resultData != null && resultData.getValue().isEmpty()) {
399 throw new WebApplicationException(Response.Status.NO_CONTENT);
402 return Response.status(200).entity(new NormalizedNodeContext(new InstanceIdentifierContext<>(yangIIdContext,
403 resultNodeSchema, mountPoint, schemaContextRef), resultData)).build();