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;
20 import com.google.common.collect.ImmutableList;
22 import java.time.Clock;
23 import java.time.LocalDateTime;
24 import java.time.format.DateTimeFormatter;
25 import java.util.List;
26 import java.util.Map.Entry;
27 import java.util.Optional;
28 import java.util.concurrent.ExecutionException;
29 import javax.ws.rs.Path;
30 import javax.ws.rs.WebApplicationException;
31 import javax.ws.rs.core.Response;
32 import javax.ws.rs.core.UriInfo;
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.DOMActionService;
37 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
38 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
39 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
40 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
41 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
42 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
43 import org.opendaylight.restconf.common.context.WriterParameters;
44 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
45 import org.opendaylight.restconf.common.errors.RestconfError;
46 import org.opendaylight.restconf.common.errors.RestconfError.ErrorTag;
47 import org.opendaylight.restconf.common.errors.RestconfError.ErrorType;
48 import org.opendaylight.restconf.common.patch.PatchContext;
49 import org.opendaylight.restconf.common.patch.PatchStatusContext;
50 import org.opendaylight.restconf.nb.rfc8040.Rfc8040;
51 import org.opendaylight.restconf.nb.rfc8040.handlers.SchemaContextHandler;
52 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfDataService;
53 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfStreamsSubscriptionService;
54 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.MdsalRestconfStrategy;
55 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfStrategy;
56 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfTransaction;
57 import org.opendaylight.restconf.nb.rfc8040.rests.utils.DeleteDataTransactionUtil;
58 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PatchDataTransactionUtil;
59 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PlainPatchDataTransactionUtil;
60 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PostDataTransactionUtil;
61 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PutDataTransactionUtil;
62 import org.opendaylight.restconf.nb.rfc8040.rests.utils.ReadDataTransactionUtil;
63 import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant;
64 import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant.PostPutQueryParameters.Insert;
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.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.MapEntryNode;
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.stmt.SchemaNodeIdentifier.Absolute;
83 import org.slf4j.Logger;
84 import org.slf4j.LoggerFactory;
87 * Implementation of {@link RestconfDataService}.
90 public class RestconfDataServiceImpl implements RestconfDataService {
91 // FIXME: we should be able to interpret 'point' and refactor this class into a behavior
92 private static final class QueryParams implements Immutable {
93 final @Nullable String point;
94 final @Nullable Insert insert;
96 QueryParams(final @Nullable Insert insert, final @Nullable String point) {
102 private static final Logger LOG = LoggerFactory.getLogger(RestconfDataServiceImpl.class);
103 private static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("yyyy-MMM-dd HH:mm:ss");
105 private final RestconfStreamsSubscriptionService delegRestconfSubscrService;
106 private final SchemaContextHandler schemaContextHandler;
107 private final MdsalRestconfStrategy restconfStrategy;
108 private final DOMMountPointService mountPointService;
109 private final SubscribeToStreamUtil streamUtils;
110 private final DOMActionService actionService;
112 public RestconfDataServiceImpl(final SchemaContextHandler schemaContextHandler,
113 final DOMDataBroker dataBroker, final DOMMountPointService mountPointService,
114 final RestconfStreamsSubscriptionService delegRestconfSubscrService,
115 final DOMActionService actionService, final Configuration configuration) {
116 this.schemaContextHandler = requireNonNull(schemaContextHandler);
117 this.restconfStrategy = new MdsalRestconfStrategy(dataBroker);
118 this.mountPointService = requireNonNull(mountPointService);
119 this.delegRestconfSubscrService = requireNonNull(delegRestconfSubscrService);
120 this.actionService = requireNonNull(actionService);
121 streamUtils = configuration.isUseSSE() ? SubscribeToStreamUtil.serverSentEvents()
122 : SubscribeToStreamUtil.webSockets();
126 public Response readData(final UriInfo uriInfo) {
127 return readData(null, uriInfo);
131 public Response readData(final String identifier, final UriInfo uriInfo) {
132 final EffectiveModelContext schemaContextRef = this.schemaContextHandler.get();
133 final InstanceIdentifierContext<?> instanceIdentifier = ParserIdentifier.toInstanceIdentifier(
134 identifier, schemaContextRef, Optional.of(mountPointService));
135 final WriterParameters parameters = ReadDataTransactionUtil.parseUriParameters(instanceIdentifier, uriInfo);
137 final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
138 final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
139 final NormalizedNode<?, ?> node;
140 if (parameters.getFieldPaths() != null && !parameters.getFieldPaths().isEmpty()) {
141 node = ReadDataTransactionUtil.readData(parameters.getContent(), instanceIdentifier.getInstanceIdentifier(),
142 strategy, parameters.getWithDefault(), schemaContextRef, parameters.getFieldPaths());
144 node = readData(identifier, parameters.getContent(), instanceIdentifier.getInstanceIdentifier(), strategy,
145 parameters.getWithDefault(), schemaContextRef, uriInfo);
147 if (identifier != null && identifier.contains(STREAM_PATH) && identifier.contains(STREAM_ACCESS_PATH_PART)
148 && identifier.contains(STREAM_LOCATION_PATH_PART)) {
149 final String value = (String) node.getValue();
150 final String streamName = value.substring(value.indexOf(NOTIFICATION_STREAM + '/'));
151 this.delegRestconfSubscrService.subscribeToStream(streamName, uriInfo);
154 throw new RestconfDocumentedException(
155 "Request could not be completed because the relevant data model content does not exist",
156 RestconfError.ErrorType.PROTOCOL,
157 RestconfError.ErrorTag.DATA_MISSING);
160 if (parameters.getContent().equals(RestconfDataServiceConstant.ReadData.ALL)
161 || parameters.getContent().equals(RestconfDataServiceConstant.ReadData.CONFIG)) {
162 final QName type = node.getNodeType();
163 return Response.status(200)
164 .entity(new NormalizedNodeContext(instanceIdentifier, node, parameters))
165 .header("ETag", '"' + type.getModule().getRevision().map(Revision::toString).orElse(null)
166 + "-" + type.getLocalName() + '"')
167 .header("Last-Modified", FORMATTER.format(LocalDateTime.now(Clock.systemUTC())))
171 return Response.status(200).entity(new NormalizedNodeContext(instanceIdentifier, node, parameters)).build();
175 * Read specific type of data from data store via transaction and if identifier read data from
176 * streams then put streams from actual schema context to datastore.
178 * @param identifier identifier of data to read
179 * @param content type of data to read (config, state, all)
180 * @param strategy {@link RestconfStrategy} - object that perform the actual DS operations
181 * @param withDefa value of with-defaults parameter
182 * @param schemaContext schema context
183 * @param uriInfo uri info
184 * @return {@link NormalizedNode}
186 private NormalizedNode<?, ?> readData(final String identifier, final String content,
187 final YangInstanceIdentifier path, final RestconfStrategy strategy, final String withDefa,
188 final EffectiveModelContext schemaContext, final UriInfo uriInfo) {
189 if (identifier != null && identifier.contains(STREAMS_PATH) && !identifier.contains(STREAM_PATH_PART)) {
190 createAllYangNotificationStreams(strategy, schemaContext, uriInfo);
192 return ReadDataTransactionUtil.readData(content, path, strategy, withDefa, schemaContext);
195 private void createAllYangNotificationStreams(final RestconfStrategy strategy,
196 final EffectiveModelContext schemaContext, final UriInfo uriInfo) {
197 final RestconfTransaction transaction = strategy.prepareWriteExecution();
199 for (final NotificationDefinition notificationDefinition : schemaContext.getNotifications()) {
200 final NotificationListenerAdapter notifiStreamXML =
201 CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext,
202 NotificationOutputType.XML);
203 final NotificationListenerAdapter notifiStreamJSON =
204 CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext,
205 NotificationOutputType.JSON);
206 writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction, notifiStreamXML);
207 writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction, notifiStreamJSON);
210 transaction.commit().get();
211 } catch (final InterruptedException | ExecutionException e) {
212 throw new RestconfDocumentedException("Problem while putting data to DS.", e);
216 private void writeNotificationStreamToDatastore(final EffectiveModelContext schemaContext,
217 final UriInfo uriInfo, final RestconfTransaction transaction, final NotificationListenerAdapter listener) {
218 final URI uri = streamUtils.prepareUriByStreamName(uriInfo, listener.getStreamName());
219 final MapEntryNode mapToStreams = RestconfMappingNodeUtil.mapYangNotificationStreamByIetfRestconfMonitoring(
220 listener.getSchemaPath().lastNodeIdentifier(), schemaContext.getNotifications(), null,
221 listener.getOutputType(), uri);
223 transaction.merge(LogicalDatastoreType.OPERATIONAL,
224 Rfc8040.restconfStateStreamPath(mapToStreams.getIdentifier()), mapToStreams);
228 public Response putData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
229 requireNonNull(payload);
231 final QueryParams checkedParms = checkQueryParameters(uriInfo);
233 final InstanceIdentifierContext<? extends SchemaNode> iid = payload.getInstanceIdentifierContext();
235 PutDataTransactionUtil.validInputData(iid.getSchemaNode(), payload);
236 PutDataTransactionUtil.validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
237 PutDataTransactionUtil.validateListKeysEqualityInPayloadAndUri(payload);
239 final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
240 final EffectiveModelContext ref = mountPoint == null
241 ? this.schemaContextHandler.get() : modelContext(mountPoint);
243 final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
244 return PutDataTransactionUtil.putData(payload, ref, strategy, checkedParms.insert, checkedParms.point);
247 private static QueryParams checkQueryParameters(final UriInfo uriInfo) {
248 boolean insertUsed = false;
249 boolean pointUsed = false;
250 Insert insert = null;
253 for (final Entry<String, List<String>> entry : uriInfo.getQueryParameters().entrySet()) {
254 switch (entry.getKey()) {
257 throw new RestconfDocumentedException("Insert parameter can be used only once.",
258 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
262 final String str = entry.getValue().get(0);
263 insert = Insert.forValue(str);
264 if (insert == null) {
265 throw new RestconfDocumentedException("Unrecognized insert parameter value '" + str + "'",
266 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
271 throw new RestconfDocumentedException("Point parameter can be used only once.",
272 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
276 point = entry.getValue().get(0);
279 throw new RestconfDocumentedException("Bad parameter for post: " + entry.getKey(),
280 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
284 checkQueryParams(insertUsed, pointUsed, insert);
285 return new QueryParams(insert, point);
288 private static void checkQueryParams(final boolean insertUsed, final boolean pointUsed, final Insert insert) {
291 throw new RestconfDocumentedException("Point parameter can't be used without Insert parameter.",
292 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
295 if (insert != Insert.BEFORE && insert != Insert.AFTER) {
296 throw new RestconfDocumentedException(
297 "Point parameter can be used only with 'after' or 'before' values of Insert parameter.",
298 RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
304 public Response postData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
305 return postData(payload, uriInfo);
309 public Response postData(final NormalizedNodeContext payload, final UriInfo uriInfo) {
310 requireNonNull(payload);
311 if (payload.getInstanceIdentifierContext().getSchemaNode() instanceof ActionDefinition) {
312 return invokeAction(payload);
315 final QueryParams checkedParms = checkQueryParameters(uriInfo);
316 final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
317 final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
318 return PostDataTransactionUtil.postData(uriInfo, payload, strategy,
319 getSchemaContext(mountPoint), checkedParms.insert, checkedParms.point);
323 public Response deleteData(final String identifier) {
324 final InstanceIdentifierContext<?> instanceIdentifier = ParserIdentifier.toInstanceIdentifier(
325 identifier, this.schemaContextHandler.get(), Optional.of(mountPointService));
327 final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
328 final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
329 return DeleteDataTransactionUtil.deleteData(strategy, instanceIdentifier.getInstanceIdentifier());
333 public PatchStatusContext patchData(final String identifier, final PatchContext context, final UriInfo uriInfo) {
334 return patchData(context, uriInfo);
338 public PatchStatusContext patchData(final PatchContext context, final UriInfo uriInfo) {
339 final DOMMountPoint mountPoint = requireNonNull(context).getInstanceIdentifierContext().getMountPoint();
340 final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
341 return PatchDataTransactionUtil.patchData(context, strategy, getSchemaContext(mountPoint));
345 public Response patchData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
346 requireNonNull(payload);
348 final InstanceIdentifierContext<? extends SchemaNode> iid = payload
349 .getInstanceIdentifierContext();
351 PutDataTransactionUtil.validInputData(iid.getSchemaNode(), payload);
352 PutDataTransactionUtil.validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
353 PutDataTransactionUtil.validateListKeysEqualityInPayloadAndUri(payload);
355 final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
356 final EffectiveModelContext ref = mountPoint == null
357 ? this.schemaContextHandler.get() : modelContext(mountPoint);
358 final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
360 return PlainPatchDataTransactionUtil.patchData(payload, strategy, ref);
363 private EffectiveModelContext getSchemaContext(final DOMMountPoint mountPoint) {
364 return mountPoint == null ? schemaContextHandler.get() : modelContext(mountPoint);
367 // FIXME: why is this synchronized?
368 public synchronized RestconfStrategy getRestconfStrategy(final DOMMountPoint mountPoint) {
369 if (mountPoint == null) {
370 return restconfStrategy;
373 return RestconfStrategy.forMountPoint(mountPoint).orElseThrow(() -> {
374 LOG.warn("Mount point {} does not expose a suitable access interface", mountPoint.getIdentifier());
375 return new RestconfDocumentedException("Could not find a supported access interface in mount point "
376 + mountPoint.getIdentifier());
381 * Invoke Action operation.
383 * @param payload {@link NormalizedNodeContext} - the body of the operation
384 * @return {@link NormalizedNodeContext} wrapped in {@link Response}
386 public Response invokeAction(final NormalizedNodeContext payload) {
387 final InstanceIdentifierContext<?> context = payload.getInstanceIdentifierContext();
388 final DOMMountPoint mountPoint = context.getMountPoint();
389 final Absolute schemaPath = Absolute.of(ImmutableList.copyOf(context.getSchemaNode().getPath()
390 .getPathFromRoot()));
391 final YangInstanceIdentifier yangIIdContext = context.getInstanceIdentifier();
392 final NormalizedNode<?, ?> data = payload.getData();
394 if (yangIIdContext.isEmpty() && !RestconfDataServiceConstant.NETCONF_BASE_QNAME.equals(data.getNodeType())) {
395 throw new RestconfDocumentedException("Instance identifier need to contain at least one path argument",
396 ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
399 final DOMActionResult response;
400 final EffectiveModelContext schemaContextRef;
401 if (mountPoint != null) {
402 response = RestconfInvokeOperationsUtil.invokeActionViaMountPoint(mountPoint, (ContainerNode) data,
403 schemaPath, yangIIdContext);
404 schemaContextRef = modelContext(mountPoint);
406 response = RestconfInvokeOperationsUtil.invokeAction((ContainerNode) data, schemaPath,
407 this.actionService, yangIIdContext);
408 schemaContextRef = this.schemaContextHandler.get();
410 final DOMActionResult result = RestconfInvokeOperationsUtil.checkActionResponse(response);
412 ActionDefinition resultNodeSchema = null;
413 ContainerNode resultData = null;
414 if (result != null) {
415 final Optional<ContainerNode> optOutput = result.getOutput();
416 if (optOutput.isPresent()) {
417 resultData = optOutput.get();
418 resultNodeSchema = (ActionDefinition) context.getSchemaNode();
422 if (resultData != null && resultData.getValue().isEmpty()) {
423 throw new WebApplicationException(Response.Status.NO_CONTENT);
426 return Response.status(200).entity(new NormalizedNodeContext(new InstanceIdentifierContext<>(yangIIdContext,
427 resultNodeSchema, mountPoint, schemaContextRef), resultData)).build();
430 private static EffectiveModelContext modelContext(final DOMMountPoint mountPoint) {
431 return mountPoint.getService(DOMSchemaService.class)
432 .flatMap(svc -> Optional.ofNullable(svc.getGlobalContext()))