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