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