X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=restconf%2Frestconf-nb-rfc8040%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Frestconf%2Fnb%2Frfc8040%2Frests%2Fservices%2Fimpl%2FRestconfDataServiceImpl.java;h=a2454ceb3ee66854d8bad96c68e2fcbecb4f8aa6;hb=f15a2465d554d7de583eebd3d07027d4bf8cf31f;hp=0e8971ff4cac835b7619d96b3c104b87a59b0197;hpb=6b8e4f7ee09ed344969ddad8017a7f41ad89f2d0;p=netconf.git diff --git a/restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/rests/services/impl/RestconfDataServiceImpl.java b/restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/rests/services/impl/RestconfDataServiceImpl.java index 0e8971ff4c..a2454ceb3e 100644 --- a/restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/rests/services/impl/RestconfDataServiceImpl.java +++ b/restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/rests/services/impl/RestconfDataServiceImpl.java @@ -7,87 +7,134 @@ */ package org.opendaylight.restconf.nb.rfc8040.rests.services.impl; -import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.CREATE_NOTIFICATION_STREAM; +import static java.util.Objects.requireNonNull; +import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant.PostPutQueryParameters.INSERT; +import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant.PostPutQueryParameters.POINT; +import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.NOTIFICATION_STREAM; +import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAMS_PATH; import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_ACCESS_PATH_PART; import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_LOCATION_PATH_PART; import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_PATH; +import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_PATH_PART; -import com.google.common.base.Optional; -import com.google.common.base.Preconditions; +import com.google.common.annotations.VisibleForTesting; +import com.google.common.collect.ImmutableList; +import com.google.common.util.concurrent.Futures; +import com.google.common.util.concurrent.MoreExecutors; +import java.net.URI; import java.time.Clock; import java.time.LocalDateTime; import java.time.format.DateTimeFormatter; +import java.util.HashMap; import java.util.List; +import java.util.Map; import java.util.Map.Entry; -import javax.annotation.Nonnull; +import java.util.Optional; +import java.util.concurrent.CancellationException; +import java.util.concurrent.ExecutionException; +import javax.ws.rs.Path; import javax.ws.rs.core.Response; +import javax.ws.rs.core.Response.Status; import javax.ws.rs.core.UriInfo; -import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker; -import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint; -import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain; +import org.eclipse.jdt.annotation.Nullable; +import org.opendaylight.mdsal.common.api.LogicalDatastoreType; +import org.opendaylight.mdsal.dom.api.DOMActionException; +import org.opendaylight.mdsal.dom.api.DOMActionResult; +import org.opendaylight.mdsal.dom.api.DOMActionService; +import org.opendaylight.mdsal.dom.api.DOMDataBroker; +import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier; +import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteOperations; +import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction; +import org.opendaylight.mdsal.dom.api.DOMMountPoint; +import org.opendaylight.mdsal.dom.api.DOMMountPointService; +import org.opendaylight.mdsal.dom.api.DOMSchemaService; +import org.opendaylight.mdsal.dom.spi.SimpleDOMActionResult; import org.opendaylight.restconf.common.context.InstanceIdentifierContext; import org.opendaylight.restconf.common.context.NormalizedNodeContext; import org.opendaylight.restconf.common.context.WriterParameters; import org.opendaylight.restconf.common.errors.RestconfDocumentedException; -import org.opendaylight.restconf.common.errors.RestconfError; import org.opendaylight.restconf.common.patch.PatchContext; import org.opendaylight.restconf.common.patch.PatchStatusContext; -import org.opendaylight.restconf.nb.rfc8040.RestConnectorProvider; -import org.opendaylight.restconf.nb.rfc8040.handlers.DOMMountPointServiceHandler; +import org.opendaylight.restconf.nb.rfc8040.Rfc8040; import org.opendaylight.restconf.nb.rfc8040.handlers.SchemaContextHandler; -import org.opendaylight.restconf.nb.rfc8040.handlers.TransactionChainHandler; -import org.opendaylight.restconf.nb.rfc8040.references.SchemaContextRef; import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfDataService; import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfStreamsSubscriptionService; -import org.opendaylight.restconf.nb.rfc8040.rests.transactions.TransactionVarsWrapper; +import org.opendaylight.restconf.nb.rfc8040.rests.transactions.MdsalRestconfStrategy; +import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfStrategy; import org.opendaylight.restconf.nb.rfc8040.rests.utils.DeleteDataTransactionUtil; import org.opendaylight.restconf.nb.rfc8040.rests.utils.PatchDataTransactionUtil; +import org.opendaylight.restconf.nb.rfc8040.rests.utils.PlainPatchDataTransactionUtil; import org.opendaylight.restconf.nb.rfc8040.rests.utils.PostDataTransactionUtil; import org.opendaylight.restconf.nb.rfc8040.rests.utils.PutDataTransactionUtil; import org.opendaylight.restconf.nb.rfc8040.rests.utils.ReadDataTransactionUtil; import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant; -import org.opendaylight.restconf.nb.rfc8040.utils.RestconfConstants; +import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant.PostPutQueryParameters.Insert; +import org.opendaylight.restconf.nb.rfc8040.streams.Configuration; +import org.opendaylight.restconf.nb.rfc8040.streams.listeners.NotificationListenerAdapter; +import org.opendaylight.restconf.nb.rfc8040.utils.mapping.RestconfMappingNodeUtil; import org.opendaylight.restconf.nb.rfc8040.utils.parser.ParserIdentifier; +import org.opendaylight.yang.gen.v1.urn.sal.restconf.event.subscription.rev140708.NotificationOutputTypeGrouping.NotificationOutputType; +import org.opendaylight.yangtools.concepts.Immutable; +import org.opendaylight.yangtools.yang.common.ErrorTag; +import org.opendaylight.yangtools.yang.common.ErrorType; +import org.opendaylight.yangtools.yang.common.QName; +import org.opendaylight.yangtools.yang.common.Revision; +import org.opendaylight.yangtools.yang.common.RpcError; +import org.opendaylight.yangtools.yang.common.RpcResultBuilder; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument; +import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode; +import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; +import org.opendaylight.yangtools.yang.model.api.ActionDefinition; +import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext; +import org.opendaylight.yangtools.yang.model.api.ListSchemaNode; +import org.opendaylight.yangtools.yang.model.api.NotificationDefinition; import org.opendaylight.yangtools.yang.model.api.SchemaNode; +import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Implementation of {@link RestconfDataService}. */ +@Path("/") public class RestconfDataServiceImpl implements RestconfDataService { + // FIXME: we should be able to interpret 'point' and refactor this class into a behavior + private static final class QueryParams implements Immutable { + final @Nullable String point; + final @Nullable Insert insert; + + QueryParams(final @Nullable Insert insert, final @Nullable String point) { + this.insert = insert; + this.point = point; + } + } private static final Logger LOG = LoggerFactory.getLogger(RestconfDataServiceImpl.class); private static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("yyyy-MMM-dd HH:mm:ss"); - private SchemaContextHandler schemaContextHandler; - private TransactionChainHandler transactionChainHandler; - private DOMMountPointServiceHandler mountPointServiceHandler; - private final RestconfStreamsSubscriptionService delegRestconfSubscrService; + private final SchemaContextHandler schemaContextHandler; + private final MdsalRestconfStrategy restconfStrategy; + private final DOMMountPointService mountPointService; + private final SubscribeToStreamUtil streamUtils; + private final DOMActionService actionService; + private final DOMDataBroker dataBroker; public RestconfDataServiceImpl(final SchemaContextHandler schemaContextHandler, - final TransactionChainHandler transactionChainHandler, - final DOMMountPointServiceHandler mountPointServiceHandler, - final RestconfStreamsSubscriptionService delegRestconfSubscrService) { - this.schemaContextHandler = schemaContextHandler; - this.transactionChainHandler = transactionChainHandler; - this.mountPointServiceHandler = mountPointServiceHandler; - this.delegRestconfSubscrService = delegRestconfSubscrService; - } - - @Override - public synchronized void updateHandlers(final Object... handlers) { - for (final Object object : handlers) { - if (object instanceof SchemaContextHandler) { - schemaContextHandler = (SchemaContextHandler) object; - } else if (object instanceof DOMMountPointServiceHandler) { - mountPointServiceHandler = (DOMMountPointServiceHandler) object; - } else if (object instanceof TransactionChainHandler) { - transactionChainHandler = (TransactionChainHandler) object; - } - } + final DOMDataBroker dataBroker, final DOMMountPointService mountPointService, + final RestconfStreamsSubscriptionService delegRestconfSubscrService, + final DOMActionService actionService, final Configuration configuration) { + this.schemaContextHandler = requireNonNull(schemaContextHandler); + this.dataBroker = requireNonNull(dataBroker); + this.restconfStrategy = new MdsalRestconfStrategy(dataBroker); + this.mountPointService = requireNonNull(mountPointService); + this.delegRestconfSubscrService = requireNonNull(delegRestconfSubscrService); + this.actionService = requireNonNull(actionService); + streamUtils = configuration.isUseSSE() ? SubscribeToStreamUtil.serverSentEvents() + : SubscribeToStreamUtil.webSockets(); } @Override @@ -97,147 +144,159 @@ public class RestconfDataServiceImpl implements RestconfDataService { @Override public Response readData(final String identifier, final UriInfo uriInfo) { - final SchemaContextRef schemaContextRef = new SchemaContextRef(this.schemaContextHandler.get()); + final EffectiveModelContext schemaContextRef = this.schemaContextHandler.get(); final InstanceIdentifierContext instanceIdentifier = ParserIdentifier.toInstanceIdentifier( - identifier, schemaContextRef.get(), Optional.of(this.mountPointServiceHandler.get())); + identifier, schemaContextRef, Optional.of(mountPointService)); + final WriterParameters parameters = ReadDataTransactionUtil.parseUriParameters(instanceIdentifier, uriInfo); - boolean withDefaUsed = false; - String withDefa = null; + final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint(); - for (final Entry> entry : uriInfo.getQueryParameters().entrySet()) { - switch (entry.getKey()) { - case "with-defaults": - if (!withDefaUsed) { - withDefaUsed = true; - withDefa = entry.getValue().iterator().next(); - } else { - throw new RestconfDocumentedException("With-defaults parameter can be used only once."); - } - break; - default: - LOG.info("Unknown key : {}.", entry.getKey()); - break; - } - } - boolean tagged = false; - if (withDefaUsed) { - if ("report-all-tagged".equals(withDefa)) { - tagged = true; - withDefa = null; - } - if ("report-all".equals(withDefa)) { - withDefa = null; - } + // FIXME: this looks quite crazy, why do we even have it? + if (mountPoint == null && identifier != null && identifier.contains(STREAMS_PATH) + && !identifier.contains(STREAM_PATH_PART)) { + createAllYangNotificationStreams(schemaContextRef, uriInfo); } - final WriterParameters parameters = ReadDataTransactionUtil.parseUriParameters( - instanceIdentifier, uriInfo, tagged); - - final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint(); - final DOMTransactionChain transactionChain; - if (mountPoint == null) { - transactionChain = this.transactionChainHandler.get(); + final RestconfStrategy strategy = getRestconfStrategy(mountPoint); + final NormalizedNode node; + if (parameters.getFieldPaths() != null && !parameters.getFieldPaths().isEmpty()) { + node = ReadDataTransactionUtil.readData(parameters.getContent(), instanceIdentifier.getInstanceIdentifier(), + strategy, parameters.getWithDefault(), schemaContextRef, parameters.getFieldPaths()); } else { - transactionChain = transactionChainOfMountPoint(mountPoint); + node = ReadDataTransactionUtil.readData(parameters.getContent(), instanceIdentifier.getInstanceIdentifier(), + strategy, parameters.getWithDefault(), schemaContextRef); } - final TransactionVarsWrapper transactionNode = new TransactionVarsWrapper( - instanceIdentifier, mountPoint, transactionChain); - final NormalizedNode node = - ReadDataTransactionUtil.readData(identifier, parameters.getContent(), transactionNode, withDefa, - schemaContextRef, uriInfo); - if (identifier.contains(STREAM_PATH) && identifier.contains(STREAM_ACCESS_PATH_PART) + // FIXME: this is utter craziness, refactor it properly! + if (identifier != null && identifier.contains(STREAM_PATH) && identifier.contains(STREAM_ACCESS_PATH_PART) && identifier.contains(STREAM_LOCATION_PATH_PART)) { - final String value = (String) node.getValue(); - final String streamName = value.substring( - value.indexOf(CREATE_NOTIFICATION_STREAM.toString() + RestconfConstants.SLASH), - value.length()); + final String value = (String) node.body(); + final String streamName = value.substring(value.indexOf(NOTIFICATION_STREAM + '/')); this.delegRestconfSubscrService.subscribeToStream(streamName, uriInfo); } if (node == null) { throw new RestconfDocumentedException( "Request could not be completed because the relevant data model content does not exist", - RestconfError.ErrorType.PROTOCOL, - RestconfError.ErrorTag.DATA_MISSING); + ErrorType.PROTOCOL, ErrorTag.DATA_MISSING); } - if ((parameters.getContent().equals(RestconfDataServiceConstant.ReadData.ALL)) + if (parameters.getContent().equals(RestconfDataServiceConstant.ReadData.ALL) || parameters.getContent().equals(RestconfDataServiceConstant.ReadData.CONFIG)) { - return Response.status(200) + final QName type = node.getIdentifier().getNodeType(); + return Response.status(Status.OK) .entity(new NormalizedNodeContext(instanceIdentifier, node, parameters)) - .header("ETag", '"' + node.getNodeType().getModule().getFormattedRevision() - + node.getNodeType().getLocalName() + '"') + .header("ETag", '"' + type.getModule().getRevision().map(Revision::toString).orElse(null) + + "-" + type.getLocalName() + '"') .header("Last-Modified", FORMATTER.format(LocalDateTime.now(Clock.systemUTC()))) .build(); } - return Response.status(200).entity(new NormalizedNodeContext(instanceIdentifier, node, parameters)).build(); + return Response.status(Status.OK) + .entity(new NormalizedNodeContext(instanceIdentifier, node, parameters)) + .build(); + } + + private void createAllYangNotificationStreams(final EffectiveModelContext schemaContext, final UriInfo uriInfo) { + final DOMDataTreeWriteTransaction transaction = dataBroker.newWriteOnlyTransaction(); + for (final NotificationDefinition notificationDefinition : schemaContext.getNotifications()) { + writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction, + CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext, + NotificationOutputType.XML)); + writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction, + CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext, + NotificationOutputType.JSON)); + } + try { + transaction.commit().get(); + } catch (final InterruptedException | ExecutionException e) { + throw new RestconfDocumentedException("Problem while putting data to DS.", e); + } + } + + private void writeNotificationStreamToDatastore(final EffectiveModelContext schemaContext, + final UriInfo uriInfo, final DOMDataTreeWriteOperations tx, final NotificationListenerAdapter listener) { + final URI uri = streamUtils.prepareUriByStreamName(uriInfo, listener.getStreamName()); + final MapEntryNode mapToStreams = RestconfMappingNodeUtil.mapYangNotificationStreamByIetfRestconfMonitoring( + listener.getSchemaPath().lastNodeIdentifier(), schemaContext.getNotifications(), null, + listener.getOutputType(), uri); + + tx.merge(LogicalDatastoreType.OPERATIONAL, + Rfc8040.restconfStateStreamPath(mapToStreams.getIdentifier()), mapToStreams); } @Override public Response putData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) { - Preconditions.checkNotNull(payload); + requireNonNull(payload); + + final QueryParams checkedParms = checkQueryParameters(uriInfo); + + final InstanceIdentifierContext iid = payload.getInstanceIdentifierContext(); + + validInputData(iid.getSchemaNode(), payload); + validTopLevelNodeName(iid.getInstanceIdentifier(), payload); + validateListKeysEqualityInPayloadAndUri(payload); + + final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint(); + final EffectiveModelContext ref = mountPoint == null + ? this.schemaContextHandler.get() : modelContext(mountPoint); + + final RestconfStrategy strategy = getRestconfStrategy(mountPoint); + return PutDataTransactionUtil.putData(payload, ref, strategy, checkedParms.insert, checkedParms.point); + } + private static QueryParams checkQueryParameters(final UriInfo uriInfo) { boolean insertUsed = false; boolean pointUsed = false; - String insert = null; + Insert insert = null; String point = null; for (final Entry> entry : uriInfo.getQueryParameters().entrySet()) { switch (entry.getKey()) { - case "insert": - if (!insertUsed) { - insertUsed = true; - insert = entry.getValue().iterator().next(); - } else { - throw new RestconfDocumentedException("Insert parameter can be used only once."); + case INSERT: + if (insertUsed) { + throw new RestconfDocumentedException("Insert parameter can be used only once.", + ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT); + } + + insertUsed = true; + final String str = entry.getValue().get(0); + insert = Insert.forValue(str); + if (insert == null) { + throw new RestconfDocumentedException("Unrecognized insert parameter value '" + str + "'", + ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT); } break; - case "point": - if (!pointUsed) { - pointUsed = true; - point = entry.getValue().iterator().next(); - } else { - throw new RestconfDocumentedException("Point parameter can be used only once."); + case POINT: + if (pointUsed) { + throw new RestconfDocumentedException("Point parameter can be used only once.", + ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT); } + + pointUsed = true; + point = entry.getValue().get(0); break; default: - throw new RestconfDocumentedException("Bad parameter for post: " + entry.getKey()); + throw new RestconfDocumentedException("Bad parameter for post: " + entry.getKey(), + ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT); } } checkQueryParams(insertUsed, pointUsed, insert); - - final InstanceIdentifierContext iid = payload - .getInstanceIdentifierContext(); - - PutDataTransactionUtil.validInputData(iid.getSchemaNode(), payload); - PutDataTransactionUtil.validTopLevelNodeName(iid.getInstanceIdentifier(), payload); - PutDataTransactionUtil.validateListKeysEqualityInPayloadAndUri(payload); - - final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint(); - final DOMTransactionChain transactionChain; - final SchemaContextRef ref; - if (mountPoint == null) { - transactionChain = this.transactionChainHandler.get(); - ref = new SchemaContextRef(this.schemaContextHandler.get()); - } else { - transactionChain = transactionChainOfMountPoint(mountPoint); - ref = new SchemaContextRef(mountPoint.getSchemaContext()); - } - - final TransactionVarsWrapper transactionNode = new TransactionVarsWrapper( - payload.getInstanceIdentifierContext(), mountPoint, transactionChain); - return PutDataTransactionUtil.putData(payload, ref, transactionNode, insert, point); + return new QueryParams(insert, point); } - private static void checkQueryParams(final boolean insertUsed, final boolean pointUsed, final String insert) { - if (pointUsed && !insertUsed) { - throw new RestconfDocumentedException("Point parameter can't be used without Insert parameter."); - } - if (pointUsed && (insert.equals("first") || insert.equals("last"))) { - throw new RestconfDocumentedException( - "Point parameter can be used only with 'after' or 'before' values of Insert parameter."); + private static void checkQueryParams(final boolean insertUsed, final boolean pointUsed, final Insert insert) { + if (pointUsed) { + if (!insertUsed) { + throw new RestconfDocumentedException("Point parameter can't be used without Insert parameter.", + ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT); + } + + if (insert != Insert.BEFORE && insert != Insert.AFTER) { + throw new RestconfDocumentedException( + "Point parameter can be used only with 'after' or 'before' values of Insert parameter.", + ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT); + } } } @@ -248,70 +307,26 @@ public class RestconfDataServiceImpl implements RestconfDataService { @Override public Response postData(final NormalizedNodeContext payload, final UriInfo uriInfo) { - Preconditions.checkNotNull(payload); - - boolean insertUsed = false; - boolean pointUsed = false; - String insert = null; - String point = null; - - for (final Entry> entry : uriInfo.getQueryParameters().entrySet()) { - switch (entry.getKey()) { - case "insert": - if (!insertUsed) { - insertUsed = true; - insert = entry.getValue().iterator().next(); - } else { - throw new RestconfDocumentedException("Insert parameter can be used only once."); - } - break; - case "point": - if (!pointUsed) { - pointUsed = true; - point = entry.getValue().iterator().next(); - } else { - throw new RestconfDocumentedException("Point parameter can be used only once."); - } - break; - default: - throw new RestconfDocumentedException("Bad parameter for post: " + entry.getKey()); - } + requireNonNull(payload); + if (payload.getInstanceIdentifierContext().getSchemaNode() instanceof ActionDefinition) { + return invokeAction(payload); } - checkQueryParams(insertUsed, pointUsed, insert); - + final QueryParams checkedParms = checkQueryParameters(uriInfo); final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint(); - final DOMTransactionChain transactionChain; - final SchemaContextRef ref; - if (mountPoint == null) { - transactionChain = this.transactionChainHandler.get(); - ref = new SchemaContextRef(this.schemaContextHandler.get()); - } else { - transactionChain = transactionChainOfMountPoint(mountPoint); - ref = new SchemaContextRef(mountPoint.getSchemaContext()); - } - final TransactionVarsWrapper transactionNode = new TransactionVarsWrapper( - payload.getInstanceIdentifierContext(), mountPoint, transactionChain); - return PostDataTransactionUtil.postData(uriInfo, payload, transactionNode, ref, insert, point); + final RestconfStrategy strategy = getRestconfStrategy(mountPoint); + return PostDataTransactionUtil.postData(uriInfo, payload, strategy, + getSchemaContext(mountPoint), checkedParms.insert, checkedParms.point); } @Override public Response deleteData(final String identifier) { - final SchemaContextRef schemaContextRef = new SchemaContextRef(this.schemaContextHandler.get()); final InstanceIdentifierContext instanceIdentifier = ParserIdentifier.toInstanceIdentifier( - identifier, schemaContextRef.get(), Optional.of(this.mountPointServiceHandler.get())); + identifier, this.schemaContextHandler.get(), Optional.of(mountPointService)); final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint(); - final DOMTransactionChain transactionChain; - if (mountPoint == null) { - transactionChain = this.transactionChainHandler.get(); - } else { - transactionChain = transactionChainOfMountPoint(mountPoint); - } - - final TransactionVarsWrapper transactionNode = new TransactionVarsWrapper(instanceIdentifier, mountPoint, - transactionChain); - return DeleteDataTransactionUtil.deleteData(transactionNode); + final RestconfStrategy strategy = getRestconfStrategy(mountPoint); + return DeleteDataTransactionUtil.deleteData(strategy, instanceIdentifier.getInstanceIdentifier()); } @Override @@ -321,39 +336,243 @@ public class RestconfDataServiceImpl implements RestconfDataService { @Override public PatchStatusContext patchData(final PatchContext context, final UriInfo uriInfo) { - Preconditions.checkNotNull(context); - final DOMMountPoint mountPoint = context.getInstanceIdentifierContext().getMountPoint(); + final DOMMountPoint mountPoint = RestconfDocumentedException.throwIfNull(context, + ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE, "No patch documented provided") + .getInstanceIdentifierContext().getMountPoint(); + final RestconfStrategy strategy = getRestconfStrategy(mountPoint); + return PatchDataTransactionUtil.patchData(context, strategy, getSchemaContext(mountPoint)); + } - final DOMTransactionChain transactionChain; - final SchemaContextRef ref; + @Override + public Response patchData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) { + requireNonNull(payload); + + final InstanceIdentifierContext iid = payload.getInstanceIdentifierContext(); + validInputData(iid.getSchemaNode(), payload); + validTopLevelNodeName(iid.getInstanceIdentifier(), payload); + validateListKeysEqualityInPayloadAndUri(payload); + + final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint(); + final EffectiveModelContext ref = mountPoint == null + ? this.schemaContextHandler.get() : modelContext(mountPoint); + final RestconfStrategy strategy = getRestconfStrategy(mountPoint); + + return PlainPatchDataTransactionUtil.patchData(payload, strategy, ref); + } + + private EffectiveModelContext getSchemaContext(final DOMMountPoint mountPoint) { + return mountPoint == null ? schemaContextHandler.get() : modelContext(mountPoint); + } + + // FIXME: why is this synchronized? + public synchronized RestconfStrategy getRestconfStrategy(final DOMMountPoint mountPoint) { if (mountPoint == null) { - transactionChain = this.transactionChainHandler.get(); - ref = new SchemaContextRef(this.schemaContextHandler.get()); + return restconfStrategy; + } + + return RestconfStrategy.forMountPoint(mountPoint).orElseThrow(() -> { + LOG.warn("Mount point {} does not expose a suitable access interface", mountPoint.getIdentifier()); + return new RestconfDocumentedException("Could not find a supported access interface in mount point " + + mountPoint.getIdentifier()); + }); + } + + /** + * Invoke Action operation. + * + * @param payload {@link NormalizedNodeContext} - the body of the operation + * @return {@link NormalizedNodeContext} wrapped in {@link Response} + */ + public Response invokeAction(final NormalizedNodeContext payload) { + final InstanceIdentifierContext context = payload.getInstanceIdentifierContext(); + final DOMMountPoint mountPoint = context.getMountPoint(); + final Absolute schemaPath = Absolute.of(ImmutableList.copyOf(context.getSchemaNode().getPath() + .getPathFromRoot())); + final YangInstanceIdentifier yangIIdContext = context.getInstanceIdentifier(); + final NormalizedNode data = payload.getData(); + + if (yangIIdContext.isEmpty() + && !RestconfDataServiceConstant.NETCONF_BASE_QNAME.equals(data.getIdentifier().getNodeType())) { + throw new RestconfDocumentedException("Instance identifier need to contain at least one path argument", + ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE); + } + + final DOMActionResult response; + final EffectiveModelContext schemaContextRef; + if (mountPoint != null) { + response = invokeAction((ContainerNode) data, schemaPath, yangIIdContext, mountPoint); + schemaContextRef = modelContext(mountPoint); } else { - transactionChain = transactionChainOfMountPoint(mountPoint); - ref = new SchemaContextRef(mountPoint.getSchemaContext()); + response = invokeAction((ContainerNode) data, schemaPath, yangIIdContext, actionService); + schemaContextRef = schemaContextHandler.get(); + } + final DOMActionResult result = checkActionResponse(response); + + ActionDefinition resultNodeSchema = null; + ContainerNode resultData = null; + if (result != null) { + final Optional optOutput = result.getOutput(); + if (optOutput.isPresent()) { + resultData = optOutput.get(); + resultNodeSchema = (ActionDefinition) context.getSchemaNode(); + } + } + + if (resultData != null && resultData.isEmpty()) { + return Response.status(Status.NO_CONTENT).build(); + } + + return Response.status(Status.OK) + .entity(new NormalizedNodeContext( + new InstanceIdentifierContext<>(yangIIdContext, resultNodeSchema, mountPoint, schemaContextRef), + resultData)) + .build(); + } + + + /** + * Invoking Action via mount point. + * + * @param mountPoint mount point + * @param data input data + * @param schemaPath schema path of data + * @return {@link DOMActionResult} + */ + private static DOMActionResult invokeAction(final ContainerNode data, + final Absolute schemaPath, final YangInstanceIdentifier yangIId, final DOMMountPoint mountPoint) { + return invokeAction(data, schemaPath, yangIId, mountPoint.getService(DOMActionService.class) + .orElseThrow(() -> new RestconfDocumentedException("DomAction service is missing."))); + } + + /** + * Invoke Action via ActionServiceHandler. + * + * @param data input data + * @param yangIId invocation context + * @param schemaPath schema path of data + * @param actionService action service to invoke action + * @return {@link DOMActionResult} + */ + // FIXME: NETCONF-718: we should be returning a future here + private static DOMActionResult invokeAction(final ContainerNode data, final Absolute schemaPath, + final YangInstanceIdentifier yangIId, final DOMActionService actionService) { + return RestconfInvokeOperationsServiceImpl.checkedGet(Futures.catching(actionService.invokeAction( + schemaPath, new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL, yangIId.getParent()), data), + DOMActionException.class, + cause -> new SimpleDOMActionResult(ImmutableList.of(RpcResultBuilder.newError( + RpcError.ErrorType.RPC, "operation-failed", cause.getMessage()))), + MoreExecutors.directExecutor())); + } + + /** + * Check the validity of the result. + * + * @param response response of Action + * @return {@link DOMActionResult} result + */ + private static DOMActionResult checkActionResponse(final DOMActionResult response) { + if (response == null) { + return null; } - final TransactionVarsWrapper transactionNode = new TransactionVarsWrapper( - context.getInstanceIdentifierContext(), mountPoint, transactionChain); + try { + if (response.getErrors().isEmpty()) { + return response; + } + LOG.debug("InvokeAction Error Message {}", response.getErrors()); + throw new RestconfDocumentedException("InvokeAction Error Message ", null, response.getErrors()); + } catch (final CancellationException e) { + final String errMsg = "The Action Operation was cancelled while executing."; + LOG.debug("Cancel Execution: {}", errMsg, e); + throw new RestconfDocumentedException(errMsg, ErrorType.RPC, ErrorTag.PARTIAL_OPERATION, e); + } + } - return PatchDataTransactionUtil.patchData(context, transactionNode, ref); + /** + * Valid input data with {@link SchemaNode}. + * + * @param schemaNode {@link SchemaNode} + * @param payload input data + */ + @VisibleForTesting + public static void validInputData(final SchemaNode schemaNode, final NormalizedNodeContext payload) { + if (schemaNode != null && payload.getData() == null) { + throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE); + } else if (schemaNode == null && payload.getData() != null) { + throw new RestconfDocumentedException("No input expected.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE); + } + } + + /** + * Valid top level node name. + * + * @param path path of node + * @param payload data + */ + @VisibleForTesting + public static void validTopLevelNodeName(final YangInstanceIdentifier path, final NormalizedNodeContext payload) { + final String payloadName = payload.getData().getIdentifier().getNodeType().getLocalName(); + + if (path.isEmpty()) { + if (!payload.getData().getIdentifier().getNodeType().equals( + RestconfDataServiceConstant.NETCONF_BASE_QNAME)) { + throw new RestconfDocumentedException("Instance identifier has to contain at least one path argument", + ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE); + } + } else { + final String identifierName = path.getLastPathArgument().getNodeType().getLocalName(); + if (!payloadName.equals(identifierName)) { + throw new RestconfDocumentedException( + "Payload name (" + payloadName + ") is different from identifier name (" + identifierName + ")", + ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE); + } + } } + /** - * Prepare transaction chain to access data of mount point. - * @param mountPoint - * mount point reference - * @return {@link DOMTransactionChain} + * Validates whether keys in {@code payload} are equal to values of keys in + * {@code iiWithData} for list schema node. + * + * @throws RestconfDocumentedException if key values or key count in payload and URI isn't equal */ - private static DOMTransactionChain transactionChainOfMountPoint(@Nonnull final DOMMountPoint mountPoint) { - final Optional domDataBrokerService = mountPoint.getService(DOMDataBroker.class); - if (domDataBrokerService.isPresent()) { - return domDataBrokerService.get().createTransactionChain(RestConnectorProvider.TRANSACTION_CHAIN_LISTENER); + @VisibleForTesting + public static void validateListKeysEqualityInPayloadAndUri(final NormalizedNodeContext payload) { + final InstanceIdentifierContext iiWithData = payload.getInstanceIdentifierContext(); + final PathArgument lastPathArgument = iiWithData.getInstanceIdentifier().getLastPathArgument(); + final SchemaNode schemaNode = iiWithData.getSchemaNode(); + final NormalizedNode data = payload.getData(); + if (schemaNode instanceof ListSchemaNode) { + final List keyDefinitions = ((ListSchemaNode) schemaNode).getKeyDefinition(); + if (lastPathArgument instanceof NodeIdentifierWithPredicates && data instanceof MapEntryNode) { + final Map uriKeyValues = ((NodeIdentifierWithPredicates) lastPathArgument).asMap(); + isEqualUriAndPayloadKeyValues(uriKeyValues, (MapEntryNode) data, keyDefinitions); + } + } + } + + private static void isEqualUriAndPayloadKeyValues(final Map uriKeyValues, final MapEntryNode payload, + final List keyDefinitions) { + final Map mutableCopyUriKeyValues = new HashMap<>(uriKeyValues); + for (final QName keyDefinition : keyDefinitions) { + final Object uriKeyValue = RestconfDocumentedException.throwIfNull( + mutableCopyUriKeyValues.remove(keyDefinition), ErrorType.PROTOCOL, ErrorTag.DATA_MISSING, + "Missing key %s in URI.", keyDefinition); + + final Object dataKeyValue = payload.getIdentifier().getValue(keyDefinition); + + if (!uriKeyValue.equals(dataKeyValue)) { + final String errMsg = "The value '" + uriKeyValue + "' for key '" + keyDefinition.getLocalName() + + "' specified in the URI doesn't match the value '" + dataKeyValue + + "' specified in the message body. "; + throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); + } } + } - final String errMsg = "DOM data broker service isn't available for mount point " + mountPoint.getIdentifier(); - LOG.warn(errMsg); - throw new RestconfDocumentedException(errMsg); + private static EffectiveModelContext modelContext(final DOMMountPoint mountPoint) { + return mountPoint.getService(DOMSchemaService.class) + .flatMap(svc -> Optional.ofNullable(svc.getGlobalContext())) + .orElse(null); } }