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 org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.CREATE_NOTIFICATION_STREAM;
11 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_ACCESS_PATH_PART;
12 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_LOCATION_PATH_PART;
13 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_PATH;
15 import com.google.common.base.Preconditions;
16 import java.time.Clock;
17 import java.time.LocalDateTime;
18 import java.time.format.DateTimeFormatter;
19 import java.util.List;
20 import java.util.Map.Entry;
21 import java.util.Objects;
22 import java.util.Optional;
23 import javax.annotation.Nonnull;
24 import javax.ws.rs.Path;
25 import javax.ws.rs.core.Response;
26 import javax.ws.rs.core.UriInfo;
27 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
28 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
29 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
30 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
31 import org.opendaylight.restconf.common.context.WriterParameters;
32 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
33 import org.opendaylight.restconf.common.errors.RestconfError;
34 import org.opendaylight.restconf.common.patch.PatchContext;
35 import org.opendaylight.restconf.common.patch.PatchStatusContext;
36 import org.opendaylight.restconf.nb.rfc8040.handlers.DOMMountPointServiceHandler;
37 import org.opendaylight.restconf.nb.rfc8040.handlers.SchemaContextHandler;
38 import org.opendaylight.restconf.nb.rfc8040.handlers.TransactionChainHandler;
39 import org.opendaylight.restconf.nb.rfc8040.references.SchemaContextRef;
40 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfDataService;
41 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfStreamsSubscriptionService;
42 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.TransactionVarsWrapper;
43 import org.opendaylight.restconf.nb.rfc8040.rests.utils.DeleteDataTransactionUtil;
44 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PatchDataTransactionUtil;
45 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PostDataTransactionUtil;
46 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PutDataTransactionUtil;
47 import org.opendaylight.restconf.nb.rfc8040.rests.utils.ReadDataTransactionUtil;
48 import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant;
49 import org.opendaylight.restconf.nb.rfc8040.utils.RestconfConstants;
50 import org.opendaylight.restconf.nb.rfc8040.utils.parser.ParserIdentifier;
51 import org.opendaylight.yangtools.yang.common.QName;
52 import org.opendaylight.yangtools.yang.common.Revision;
53 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
54 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
55 import org.slf4j.Logger;
56 import org.slf4j.LoggerFactory;
59 * Implementation of {@link RestconfDataService}.
62 public class RestconfDataServiceImpl implements RestconfDataService {
64 private static final Logger LOG = LoggerFactory.getLogger(RestconfDataServiceImpl.class);
65 private static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("yyyy-MMM-dd HH:mm:ss");
67 private SchemaContextHandler schemaContextHandler;
68 private TransactionChainHandler transactionChainHandler;
69 private DOMMountPointServiceHandler mountPointServiceHandler;
71 private final RestconfStreamsSubscriptionService delegRestconfSubscrService;
73 public RestconfDataServiceImpl(final SchemaContextHandler schemaContextHandler,
74 final TransactionChainHandler transactionChainHandler,
75 final DOMMountPointServiceHandler mountPointServiceHandler,
76 final RestconfStreamsSubscriptionService delegRestconfSubscrService) {
77 this.schemaContextHandler = Objects.requireNonNull(schemaContextHandler);
78 this.transactionChainHandler = Objects.requireNonNull(transactionChainHandler);
79 this.mountPointServiceHandler = Objects.requireNonNull(mountPointServiceHandler);
80 this.delegRestconfSubscrService = Objects.requireNonNull(delegRestconfSubscrService);
84 public synchronized void updateHandlers(final Object... handlers) {
85 for (final Object object : handlers) {
86 if (object instanceof SchemaContextHandler) {
87 schemaContextHandler = (SchemaContextHandler) object;
88 } else if (object instanceof DOMMountPointServiceHandler) {
89 mountPointServiceHandler = (DOMMountPointServiceHandler) object;
90 } else if (object instanceof TransactionChainHandler) {
91 transactionChainHandler = (TransactionChainHandler) object;
97 public Response readData(final UriInfo uriInfo) {
98 return readData(null, uriInfo);
102 public Response readData(final String identifier, final UriInfo uriInfo) {
103 final SchemaContextRef schemaContextRef = new SchemaContextRef(this.schemaContextHandler.get());
104 final InstanceIdentifierContext<?> instanceIdentifier = ParserIdentifier.toInstanceIdentifier(
105 identifier, schemaContextRef.get(), Optional.of(this.mountPointServiceHandler.get()));
107 boolean withDefaUsed = false;
108 String withDefa = null;
110 for (final Entry<String, List<String>> entry : uriInfo.getQueryParameters().entrySet()) {
111 switch (entry.getKey()) {
112 case "with-defaults":
115 withDefa = entry.getValue().iterator().next();
117 throw new RestconfDocumentedException("With-defaults parameter can be used only once.");
121 LOG.info("Unknown key : {}.", entry.getKey());
125 boolean tagged = false;
127 if ("report-all-tagged".equals(withDefa)) {
131 if ("report-all".equals(withDefa)) {
136 final WriterParameters parameters = ReadDataTransactionUtil.parseUriParameters(
137 instanceIdentifier, uriInfo, tagged);
139 final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
140 final TransactionChainHandler localTransactionChainHandler;
141 if (mountPoint == null) {
142 localTransactionChainHandler = this.transactionChainHandler;
144 localTransactionChainHandler = transactionChainOfMountPoint(mountPoint);
147 final TransactionVarsWrapper transactionNode = new TransactionVarsWrapper(
148 instanceIdentifier, mountPoint, localTransactionChainHandler);
149 final NormalizedNode<?, ?> node =
150 ReadDataTransactionUtil.readData(identifier, parameters.getContent(), transactionNode, withDefa,
151 schemaContextRef, uriInfo);
152 if (identifier.contains(STREAM_PATH) && identifier.contains(STREAM_ACCESS_PATH_PART)
153 && identifier.contains(STREAM_LOCATION_PATH_PART)) {
154 final String value = (String) node.getValue();
155 final String streamName = value.substring(
156 value.indexOf(CREATE_NOTIFICATION_STREAM.toString() + RestconfConstants.SLASH),
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 public Response putData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
183 Preconditions.checkNotNull(payload);
185 boolean insertUsed = false;
186 boolean pointUsed = false;
187 String insert = null;
190 for (final Entry<String, List<String>> entry : uriInfo.getQueryParameters().entrySet()) {
191 switch (entry.getKey()) {
195 insert = entry.getValue().iterator().next();
197 throw new RestconfDocumentedException("Insert parameter can be used only once.",
198 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
204 point = entry.getValue().iterator().next();
206 throw new RestconfDocumentedException("Point parameter can be used only once.",
207 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
211 throw new RestconfDocumentedException("Bad parameter for post: " + entry.getKey(),
212 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
216 checkQueryParams(insertUsed, pointUsed, insert);
218 final InstanceIdentifierContext<? extends SchemaNode> iid = payload
219 .getInstanceIdentifierContext();
221 PutDataTransactionUtil.validInputData(iid.getSchemaNode(), payload);
222 PutDataTransactionUtil.validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
223 PutDataTransactionUtil.validateListKeysEqualityInPayloadAndUri(payload);
225 final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
226 final TransactionChainHandler localTransactionChainHandler;
227 final SchemaContextRef ref;
228 if (mountPoint == null) {
229 localTransactionChainHandler = this.transactionChainHandler;
230 ref = new SchemaContextRef(this.schemaContextHandler.get());
232 localTransactionChainHandler = transactionChainOfMountPoint(mountPoint);
233 ref = new SchemaContextRef(mountPoint.getSchemaContext());
236 final TransactionVarsWrapper transactionNode = new TransactionVarsWrapper(
237 payload.getInstanceIdentifierContext(), mountPoint, localTransactionChainHandler);
238 return PutDataTransactionUtil.putData(payload, ref, transactionNode, insert, point);
241 private static void checkQueryParams(final boolean insertUsed, final boolean pointUsed, final String insert) {
242 if (pointUsed && !insertUsed) {
243 throw new RestconfDocumentedException("Point parameter can't be used without Insert parameter.",
244 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
246 if (pointUsed && (insert.equals("first") || insert.equals("last"))) {
247 throw new RestconfDocumentedException(
248 "Point parameter can be used only with 'after' or 'before' values of Insert parameter.",
249 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
254 public Response postData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
255 return postData(payload, uriInfo);
259 public Response postData(final NormalizedNodeContext payload, final UriInfo uriInfo) {
260 Preconditions.checkNotNull(payload);
262 boolean insertUsed = false;
263 boolean pointUsed = false;
264 String insert = null;
267 for (final Entry<String, List<String>> entry : uriInfo.getQueryParameters().entrySet()) {
268 switch (entry.getKey()) {
272 insert = entry.getValue().iterator().next();
274 throw new RestconfDocumentedException("Insert parameter can be used only once.",
275 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
281 point = entry.getValue().iterator().next();
283 throw new RestconfDocumentedException("Point parameter can be used only once.",
284 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
288 throw new RestconfDocumentedException("Bad parameter for post: " + entry.getKey(),
289 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
293 checkQueryParams(insertUsed, pointUsed, insert);
295 final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
296 final TransactionChainHandler localTransactionChainHandler;
297 final SchemaContextRef ref;
298 if (mountPoint == null) {
299 localTransactionChainHandler = this.transactionChainHandler;
300 ref = new SchemaContextRef(this.schemaContextHandler.get());
302 localTransactionChainHandler = transactionChainOfMountPoint(mountPoint);
303 ref = new SchemaContextRef(mountPoint.getSchemaContext());
305 final TransactionVarsWrapper transactionNode = new TransactionVarsWrapper(
306 payload.getInstanceIdentifierContext(), mountPoint, localTransactionChainHandler);
307 return PostDataTransactionUtil.postData(uriInfo, payload, transactionNode, ref, insert, point);
311 public Response deleteData(final String identifier) {
312 final SchemaContextRef schemaContextRef = new SchemaContextRef(this.schemaContextHandler.get());
313 final InstanceIdentifierContext<?> instanceIdentifier = ParserIdentifier.toInstanceIdentifier(
314 identifier, schemaContextRef.get(), Optional.of(this.mountPointServiceHandler.get()));
316 final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
317 final TransactionChainHandler localTransactionChainHandler;
318 if (mountPoint == null) {
319 localTransactionChainHandler = this.transactionChainHandler;
321 localTransactionChainHandler = transactionChainOfMountPoint(mountPoint);
324 final TransactionVarsWrapper transactionNode = new TransactionVarsWrapper(instanceIdentifier, mountPoint,
325 localTransactionChainHandler);
326 return DeleteDataTransactionUtil.deleteData(transactionNode);
330 public PatchStatusContext patchData(final String identifier, final PatchContext context, final UriInfo uriInfo) {
331 return patchData(context, uriInfo);
335 public PatchStatusContext patchData(final PatchContext context, final UriInfo uriInfo) {
336 Preconditions.checkNotNull(context);
337 final DOMMountPoint mountPoint = context.getInstanceIdentifierContext().getMountPoint();
339 final TransactionChainHandler localTransactionChainHandler;
340 final SchemaContextRef ref;
341 if (mountPoint == null) {
342 localTransactionChainHandler = this.transactionChainHandler;
343 ref = new SchemaContextRef(this.schemaContextHandler.get());
345 localTransactionChainHandler = transactionChainOfMountPoint(mountPoint);
346 ref = new SchemaContextRef(mountPoint.getSchemaContext());
349 final TransactionVarsWrapper transactionNode = new TransactionVarsWrapper(
350 context.getInstanceIdentifierContext(), mountPoint, localTransactionChainHandler);
352 return PatchDataTransactionUtil.patchData(context, transactionNode, ref);
356 * Prepare transaction chain to access data of mount point.
358 * mount point reference
359 * @return {@link TransactionChainHandler}
361 private static TransactionChainHandler transactionChainOfMountPoint(@Nonnull final DOMMountPoint mountPoint) {
362 final Optional<DOMDataBroker> domDataBrokerService = mountPoint.getService(DOMDataBroker.class);
363 if (domDataBrokerService.isPresent()) {
364 return new TransactionChainHandler(domDataBrokerService.get());
367 final String errMsg = "DOM data broker service isn't available for mount point " + mountPoint.getIdentifier();
369 throw new RestconfDocumentedException(errMsg);