Reduce preliferation of TransactionChainHandler
[netconf.git] / restconf / restconf-nb-rfc8040 / src / main / java / org / opendaylight / restconf / nb / rfc8040 / rests / services / impl / RestconfDataServiceImpl.java
1 /*
2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
3  *
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
7  */
8 package org.opendaylight.restconf.nb.rfc8040.rests.services.impl;
9
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;
19
20 import com.google.common.collect.ImmutableList;
21 import java.net.URI;
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.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.MapEntryNode;
78 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
79 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
80 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
81 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
82 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
83 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
84 import org.slf4j.Logger;
85 import org.slf4j.LoggerFactory;
86
87 /**
88  * Implementation of {@link RestconfDataService}.
89  */
90 @Path("/")
91 public class RestconfDataServiceImpl implements RestconfDataService {
92     // FIXME: we should be able to interpret 'point' and refactor this class into a behavior
93     private static final class QueryParams implements Immutable {
94         final @Nullable String point;
95         final @Nullable Insert insert;
96
97         QueryParams(final @Nullable Insert insert, final @Nullable String point) {
98             this.insert = insert;
99             this.point = point;
100         }
101     }
102
103     private static final Logger LOG = LoggerFactory.getLogger(RestconfDataServiceImpl.class);
104     private static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("yyyy-MMM-dd HH:mm:ss");
105
106     private final RestconfStreamsSubscriptionService delegRestconfSubscrService;
107     private final SubscribeToStreamUtil streamUtils;
108
109     private final SchemaContextHandler schemaContextHandler;
110     private final DOMMountPointService mountPointService;
111     private final DOMActionService actionService;
112     private final DOMDataBroker dataBroker;
113
114     public RestconfDataServiceImpl(final SchemaContextHandler schemaContextHandler,
115             final DOMDataBroker dataBroker, final DOMMountPointService  mountPointService,
116             final RestconfStreamsSubscriptionService delegRestconfSubscrService,
117             final DOMActionService actionService, final Configuration configuration) {
118         this.schemaContextHandler = requireNonNull(schemaContextHandler);
119         this.dataBroker = requireNonNull(dataBroker);
120         this.mountPointService = requireNonNull(mountPointService);
121         this.delegRestconfSubscrService = requireNonNull(delegRestconfSubscrService);
122         this.actionService = requireNonNull(actionService);
123         streamUtils = configuration.isUseSSE() ? SubscribeToStreamUtil.serverSentEvents()
124                 : SubscribeToStreamUtil.webSockets();
125     }
126
127     @Override
128     public Response readData(final UriInfo uriInfo) {
129         return readData(null, uriInfo);
130     }
131
132     @Override
133     public Response readData(final String identifier, final UriInfo uriInfo) {
134         final EffectiveModelContext schemaContextRef = this.schemaContextHandler.get();
135         final InstanceIdentifierContext<?> instanceIdentifier = ParserIdentifier.toInstanceIdentifier(
136                 identifier, schemaContextRef, Optional.of(mountPointService));
137         final WriterParameters parameters = ReadDataTransactionUtil.parseUriParameters(instanceIdentifier, uriInfo);
138
139         final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
140         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
141         final NormalizedNode<?, ?> node;
142         if (parameters.getFieldPaths() != null && !parameters.getFieldPaths().isEmpty()) {
143             node = ReadDataTransactionUtil.readData(parameters.getContent(), instanceIdentifier.getInstanceIdentifier(),
144                     strategy, parameters.getWithDefault(), schemaContextRef, parameters.getFieldPaths());
145         } else {
146             node = readData(identifier, parameters.getContent(), instanceIdentifier.getInstanceIdentifier(), strategy,
147                     parameters.getWithDefault(), schemaContextRef, uriInfo);
148         }
149         if (identifier != null && identifier.contains(STREAM_PATH) && identifier.contains(STREAM_ACCESS_PATH_PART)
150                 && identifier.contains(STREAM_LOCATION_PATH_PART)) {
151             final String value = (String) node.getValue();
152             final String streamName = value.substring(value.indexOf(NOTIFICATION_STREAM + '/'));
153             this.delegRestconfSubscrService.subscribeToStream(streamName, uriInfo);
154         }
155         if (node == null) {
156             throw new RestconfDocumentedException(
157                     "Request could not be completed because the relevant data model content does not exist",
158                     RestconfError.ErrorType.PROTOCOL,
159                     RestconfError.ErrorTag.DATA_MISSING);
160         }
161
162         if (parameters.getContent().equals(RestconfDataServiceConstant.ReadData.ALL)
163                     || parameters.getContent().equals(RestconfDataServiceConstant.ReadData.CONFIG)) {
164             final QName type = node.getNodeType();
165             return Response.status(200)
166                     .entity(new NormalizedNodeContext(instanceIdentifier, node, parameters))
167                     .header("ETag", '"' + type.getModule().getRevision().map(Revision::toString).orElse(null)
168                         + "-" + type.getLocalName() + '"')
169                     .header("Last-Modified", FORMATTER.format(LocalDateTime.now(Clock.systemUTC())))
170                     .build();
171         }
172
173         return Response.status(200).entity(new NormalizedNodeContext(instanceIdentifier, node, parameters)).build();
174     }
175
176     /**
177      * Read specific type of data from data store via transaction and if identifier read data from
178      * streams then put streams from actual schema context to datastore.
179      *
180      * @param identifier    identifier of data to read
181      * @param content       type of data to read (config, state, all)
182      * @param strategy      {@link RestconfStrategy} - object that perform the actual DS operations
183      * @param withDefa      value of with-defaults parameter
184      * @param schemaContext schema context
185      * @param uriInfo       uri info
186      * @return {@link NormalizedNode}
187      */
188     private NormalizedNode<?, ?> readData(final String identifier, final String content,
189             final YangInstanceIdentifier path, final RestconfStrategy strategy, final String withDefa,
190             final EffectiveModelContext schemaContext, final UriInfo uriInfo) {
191         if (identifier != null && identifier.contains(STREAMS_PATH) && !identifier.contains(STREAM_PATH_PART)) {
192             createAllYangNotificationStreams(strategy, schemaContext, uriInfo);
193         }
194         return ReadDataTransactionUtil.readData(content, path, strategy, withDefa, schemaContext);
195     }
196
197     private void createAllYangNotificationStreams(final RestconfStrategy strategy,
198             final EffectiveModelContext schemaContext, final UriInfo uriInfo) {
199         final RestconfTransaction transaction = strategy.prepareWriteExecution();
200
201         for (final NotificationDefinition notificationDefinition : schemaContext.getNotifications()) {
202             final NotificationListenerAdapter notifiStreamXML =
203                 CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext,
204                     NotificationOutputType.XML);
205             final NotificationListenerAdapter notifiStreamJSON =
206                 CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext,
207                     NotificationOutputType.JSON);
208             writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction, notifiStreamXML);
209             writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction, notifiStreamJSON);
210         }
211         try {
212             transaction.commit().get();
213         } catch (final InterruptedException | ExecutionException e) {
214             throw new RestconfDocumentedException("Problem while putting data to DS.", e);
215         }
216     }
217
218     private void writeNotificationStreamToDatastore(final EffectiveModelContext schemaContext,
219             final UriInfo uriInfo, final RestconfTransaction transaction, final NotificationListenerAdapter listener) {
220         final URI uri = streamUtils.prepareUriByStreamName(uriInfo, listener.getStreamName());
221         final MapEntryNode mapToStreams = RestconfMappingNodeUtil.mapYangNotificationStreamByIetfRestconfMonitoring(
222                 listener.getSchemaPath().lastNodeIdentifier(), schemaContext.getNotifications(), null,
223                 listener.getOutputType(), uri);
224
225         final String name = listener.getSchemaPath().lastNodeIdentifier().getLocalName();
226         transaction.merge(LogicalDatastoreType.OPERATIONAL,
227             IdentifierCodec.deserialize(Rfc8040.MonitoringModule.PATH_TO_STREAM_WITHOUT_KEY + name, schemaContext),
228             mapToStreams);
229     }
230
231     @Override
232     public Response putData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
233         requireNonNull(payload);
234
235         final QueryParams checkedParms = checkQueryParameters(uriInfo);
236
237         final InstanceIdentifierContext<? extends SchemaNode> iid = payload.getInstanceIdentifierContext();
238
239         PutDataTransactionUtil.validInputData(iid.getSchemaNode(), payload);
240         PutDataTransactionUtil.validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
241         PutDataTransactionUtil.validateListKeysEqualityInPayloadAndUri(payload);
242
243         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
244         final EffectiveModelContext ref = mountPoint == null
245                 ? this.schemaContextHandler.get() : modelContext(mountPoint);
246
247         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
248         return PutDataTransactionUtil.putData(payload, ref, strategy, checkedParms.insert, checkedParms.point);
249     }
250
251     private static QueryParams checkQueryParameters(final UriInfo uriInfo) {
252         boolean insertUsed = false;
253         boolean pointUsed = false;
254         Insert insert = null;
255         String point = null;
256
257         for (final Entry<String, List<String>> entry : uriInfo.getQueryParameters().entrySet()) {
258             switch (entry.getKey()) {
259                 case INSERT:
260                     if (insertUsed) {
261                         throw new RestconfDocumentedException("Insert parameter can be used only once.",
262                             RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
263                     }
264
265                     insertUsed = true;
266                     final String str = entry.getValue().get(0);
267                     insert = Insert.forValue(str);
268                     if (insert == null) {
269                         throw new RestconfDocumentedException("Unrecognized insert parameter value '" + str + "'",
270                             RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
271                     }
272                     break;
273                 case POINT:
274                     if (pointUsed) {
275                         throw new RestconfDocumentedException("Point parameter can be used only once.",
276                             RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
277                     }
278
279                     pointUsed = true;
280                     point = entry.getValue().get(0);
281                     break;
282                 default:
283                     throw new RestconfDocumentedException("Bad parameter for post: " + entry.getKey(),
284                             RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
285             }
286         }
287
288         checkQueryParams(insertUsed, pointUsed, insert);
289         return new QueryParams(insert, point);
290     }
291
292     private static void checkQueryParams(final boolean insertUsed, final boolean pointUsed, final Insert insert) {
293         if (pointUsed) {
294             if (!insertUsed) {
295                 throw new RestconfDocumentedException("Point parameter can't be used without Insert parameter.",
296                     RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
297             }
298
299             if (insert != Insert.BEFORE && insert != Insert.AFTER) {
300                 throw new RestconfDocumentedException(
301                     "Point parameter can be used only with 'after' or 'before' values of Insert parameter.",
302                     RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
303             }
304         }
305     }
306
307     @Override
308     public Response postData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
309         return postData(payload, uriInfo);
310     }
311
312     @Override
313     public Response postData(final NormalizedNodeContext payload, final UriInfo uriInfo) {
314         requireNonNull(payload);
315         if (payload.getInstanceIdentifierContext().getSchemaNode() instanceof ActionDefinition) {
316             return invokeAction(payload);
317         }
318
319         final QueryParams checkedParms = checkQueryParameters(uriInfo);
320         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
321         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
322         return PostDataTransactionUtil.postData(uriInfo, payload, strategy,
323                 getSchemaContext(mountPoint), checkedParms.insert, checkedParms.point);
324     }
325
326     @Override
327     public Response deleteData(final String identifier) {
328         final InstanceIdentifierContext<?> instanceIdentifier = ParserIdentifier.toInstanceIdentifier(
329                 identifier, this.schemaContextHandler.get(), Optional.of(mountPointService));
330
331         final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
332         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
333         return DeleteDataTransactionUtil.deleteData(strategy, instanceIdentifier.getInstanceIdentifier());
334     }
335
336     @Override
337     public PatchStatusContext patchData(final String identifier, final PatchContext context, final UriInfo uriInfo) {
338         return patchData(context, uriInfo);
339     }
340
341     @Override
342     public PatchStatusContext patchData(final PatchContext context, final UriInfo uriInfo) {
343         final DOMMountPoint mountPoint = requireNonNull(context).getInstanceIdentifierContext().getMountPoint();
344         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
345         return PatchDataTransactionUtil.patchData(context, strategy, getSchemaContext(mountPoint));
346     }
347
348     @Override
349     public Response patchData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
350         requireNonNull(payload);
351
352         final InstanceIdentifierContext<? extends SchemaNode> iid = payload
353                 .getInstanceIdentifierContext();
354
355         PutDataTransactionUtil.validInputData(iid.getSchemaNode(), payload);
356         PutDataTransactionUtil.validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
357         PutDataTransactionUtil.validateListKeysEqualityInPayloadAndUri(payload);
358
359         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
360         final EffectiveModelContext ref = mountPoint == null
361                 ? this.schemaContextHandler.get() : modelContext(mountPoint);
362         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
363
364         return PlainPatchDataTransactionUtil.patchData(payload, strategy, ref);
365     }
366
367     private EffectiveModelContext getSchemaContext(final DOMMountPoint mountPoint) {
368         return mountPoint == null ? schemaContextHandler.get() : modelContext(mountPoint);
369     }
370
371     // FIXME: why is this synchronized?
372     public synchronized RestconfStrategy getRestconfStrategy(final DOMMountPoint mountPoint) {
373         if (mountPoint == null) {
374             return new MdsalRestconfStrategy(dataBroker);
375         }
376
377         return RestconfStrategy.forMountPoint(mountPoint).orElseThrow(() -> {
378             LOG.warn("Mount point {} does not expose a suitable access interface", mountPoint.getIdentifier());
379             return new RestconfDocumentedException("Could not find a supported access interface in mount point "
380                 + mountPoint.getIdentifier());
381         });
382     }
383
384     /**
385      * Invoke Action operation.
386      *
387      * @param payload {@link NormalizedNodeContext} - the body of the operation
388      * @return {@link NormalizedNodeContext} wrapped in {@link Response}
389      */
390     public Response invokeAction(final NormalizedNodeContext payload) {
391         final InstanceIdentifierContext<?> context = payload.getInstanceIdentifierContext();
392         final DOMMountPoint mountPoint = context.getMountPoint();
393         final Absolute schemaPath = Absolute.of(ImmutableList.copyOf(context.getSchemaNode().getPath()
394             .getPathFromRoot()));
395         final YangInstanceIdentifier yangIIdContext = context.getInstanceIdentifier();
396         final NormalizedNode<?, ?> data = payload.getData();
397
398         if (yangIIdContext.isEmpty() && !RestconfDataServiceConstant.NETCONF_BASE_QNAME.equals(data.getNodeType())) {
399             throw new RestconfDocumentedException("Instance identifier need to contain at least one path argument",
400                 ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
401         }
402
403         final DOMActionResult response;
404         final EffectiveModelContext schemaContextRef;
405         if (mountPoint != null) {
406             response = RestconfInvokeOperationsUtil.invokeActionViaMountPoint(mountPoint, (ContainerNode) data,
407                 schemaPath, yangIIdContext);
408             schemaContextRef = modelContext(mountPoint);
409         } else {
410             response = RestconfInvokeOperationsUtil.invokeAction((ContainerNode) data, schemaPath,
411                 this.actionService, yangIIdContext);
412             schemaContextRef = this.schemaContextHandler.get();
413         }
414         final DOMActionResult result = RestconfInvokeOperationsUtil.checkActionResponse(response);
415
416         ActionDefinition resultNodeSchema = null;
417         ContainerNode resultData = null;
418         if (result != null) {
419             final Optional<ContainerNode> optOutput = result.getOutput();
420             if (optOutput.isPresent()) {
421                 resultData = optOutput.get();
422                 resultNodeSchema = (ActionDefinition) context.getSchemaNode();
423             }
424         }
425
426         if (resultData != null && resultData.getValue().isEmpty()) {
427             throw new WebApplicationException(Response.Status.NO_CONTENT);
428         }
429
430         return Response.status(200).entity(new NormalizedNodeContext(new InstanceIdentifierContext<>(yangIIdContext,
431                 resultNodeSchema, mountPoint, schemaContextRef), resultData)).build();
432     }
433
434     private static EffectiveModelContext modelContext(final DOMMountPoint mountPoint) {
435         return mountPoint.getService(DOMSchemaService.class)
436             .flatMap(svc -> Optional.ofNullable(svc.getGlobalContext()))
437             .orElse(null);
438     }
439 }