import static com.google.common.base.Verify.verifyNotNull;
import static java.util.Objects.requireNonNull;
-import com.google.common.annotations.VisibleForTesting;
-import com.google.common.base.Splitter;
import com.google.common.collect.ImmutableMap;
-import com.google.common.collect.ImmutableSet;
-import com.google.common.collect.ImmutableSetMultimap;
import com.google.common.collect.Maps;
-import com.google.common.util.concurrent.FutureCallback;
-import com.google.common.util.concurrent.Futures;
-import com.google.common.util.concurrent.MoreExecutors;
-import java.io.IOException;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.lang.invoke.MethodHandles;
import java.lang.invoke.VarHandle;
import java.net.URI;
import java.time.format.DateTimeParseException;
-import java.util.Comparator;
-import java.util.HashMap;
import java.util.List;
import java.util.Locale;
-import java.util.Map;
-import java.util.Map.Entry;
-import java.util.Optional;
-import java.util.concurrent.CancellationException;
import javax.annotation.PreDestroy;
import javax.inject.Inject;
import javax.inject.Singleton;
import org.eclipse.jdt.annotation.NonNull;
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.DOMMountPoint;
import org.opendaylight.mdsal.dom.api.DOMMountPointService;
import org.opendaylight.mdsal.dom.api.DOMRpcService;
-import org.opendaylight.mdsal.dom.api.DOMSchemaService;
-import org.opendaylight.mdsal.dom.api.DOMYangTextSourceProvider;
-import org.opendaylight.mdsal.dom.spi.SimpleDOMActionResult;
import org.opendaylight.restconf.api.ApiPath;
+import org.opendaylight.restconf.api.FormattableBody;
import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
import org.opendaylight.restconf.common.errors.RestconfFuture;
-import org.opendaylight.restconf.common.errors.SettableRestconfFuture;
-import org.opendaylight.restconf.common.patch.PatchContext;
-import org.opendaylight.restconf.common.patch.PatchStatusContext;
-import org.opendaylight.restconf.nb.rfc8040.Insert;
-import org.opendaylight.restconf.nb.rfc8040.ReadDataParams;
-import org.opendaylight.restconf.nb.rfc8040.databind.ChildBody;
-import org.opendaylight.restconf.nb.rfc8040.databind.DataPostBody;
-import org.opendaylight.restconf.nb.rfc8040.databind.OperationInputBody;
-import org.opendaylight.restconf.nb.rfc8040.databind.PatchBody;
-import org.opendaylight.restconf.nb.rfc8040.databind.ResourceBody;
-import org.opendaylight.restconf.nb.rfc8040.legacy.InstanceIdentifierContext;
-import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
-import org.opendaylight.restconf.nb.rfc8040.legacy.QueryParameters;
import org.opendaylight.restconf.nb.rfc8040.rests.transactions.MdsalRestconfStrategy;
import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfStrategy;
-import org.opendaylight.restconf.nb.rfc8040.utils.parser.NetconfFieldsTranslator;
-import org.opendaylight.restconf.nb.rfc8040.utils.parser.WriterFieldsTranslator;
+import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfStrategy.StrategyAndTail;
+import org.opendaylight.restconf.server.api.ChildBody;
+import org.opendaylight.restconf.server.api.CreateResourceResult;
+import org.opendaylight.restconf.server.api.DataGetResult;
+import org.opendaylight.restconf.server.api.DataPatchResult;
+import org.opendaylight.restconf.server.api.DataPostBody;
import org.opendaylight.restconf.server.api.DataPostResult;
-import org.opendaylight.restconf.server.api.DataPostResult.CreateResource;
-import org.opendaylight.restconf.server.api.DataPostResult.InvokeOperation;
import org.opendaylight.restconf.server.api.DataPutResult;
+import org.opendaylight.restconf.server.api.DataYangPatchResult;
import org.opendaylight.restconf.server.api.DatabindContext;
+import org.opendaylight.restconf.server.api.InvokeResult;
import org.opendaylight.restconf.server.api.ModulesGetResult;
-import org.opendaylight.restconf.server.api.OperationsGetResult;
+import org.opendaylight.restconf.server.api.OperationInputBody;
+import org.opendaylight.restconf.server.api.PatchBody;
+import org.opendaylight.restconf.server.api.ResourceBody;
import org.opendaylight.restconf.server.api.RestconfServer;
-import org.opendaylight.restconf.server.spi.DatabindProvider;
-import org.opendaylight.restconf.server.spi.OperationInput;
-import org.opendaylight.restconf.server.spi.OperationOutput;
+import org.opendaylight.restconf.server.api.ServerRequest;
import org.opendaylight.restconf.server.spi.RpcImplementation;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.restconf.rev170126.YangApi;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.restconf.rev170126.restconf.Restconf;
-import org.opendaylight.yangtools.concepts.Registration;
import org.opendaylight.yangtools.yang.common.Empty;
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.QNameModule;
import org.opendaylight.yangtools.yang.common.Revision;
-import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
-import org.opendaylight.yangtools.yang.common.XMLNamespace;
import org.opendaylight.yangtools.yang.common.YangNames;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
-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.NormalizedNode;
-import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
-import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
-import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
-import org.opendaylight.yangtools.yang.model.api.EffectiveModelContextListener;
-import org.opendaylight.yangtools.yang.model.api.stmt.RpcEffectiveStatement;
-import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
-import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceRepresentation;
-import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
-import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
-import org.opendaylight.yangtools.yang.model.repo.api.YinTextSchemaSource;
-import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
+import org.opendaylight.yangtools.yang.model.api.source.SourceIdentifier;
+import org.opendaylight.yangtools.yang.model.api.source.SourceRepresentation;
+import org.opendaylight.yangtools.yang.model.api.source.YangTextSource;
+import org.opendaylight.yangtools.yang.model.api.source.YinTextSource;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Deactivate;
import org.osgi.service.component.annotations.Reference;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.osgi.service.component.annotations.ReferencePolicyOption;
/**
* A RESTCONF server implemented on top of MD-SAL.
*/
@Singleton
-@Component(service = { RestconfServer.class, DatabindProvider.class })
-public final class MdsalRestconfServer
- implements RestconfServer, DatabindProvider, EffectiveModelContextListener, AutoCloseable {
- private static final Logger LOG = LoggerFactory.getLogger(MdsalRestconfServer.class);
- private static final QName YANG_LIBRARY_VERSION = QName.create(Restconf.QNAME, "yang-library-version").intern();
+@Component(service = RestconfServer.class)
+public final class MdsalRestconfServer implements RestconfServer, AutoCloseable {
private static final VarHandle LOCAL_STRATEGY;
static {
}
}
- // FIXME: Remove this constant. All logic relying on this constant should instead rely on YangInstanceIdentifier
- // equivalent coming out of argument parsing. This may require keeping List<YangInstanceIdentifier> as the
- // nested path split on yang-ext:mount. This splitting needs to be based on consulting the
- // EffectiveModelContext and allowing it only where yang-ext:mount is actually used in models.
- @Deprecated(forRemoval = true)
- private static final String MOUNT = "yang-ext:mount";
- @Deprecated(forRemoval = true)
- private static final Splitter SLASH_SPLITTER = Splitter.on('/');
-
private final @NonNull ImmutableMap<QName, RpcImplementation> localRpcs;
private final @NonNull DOMMountPointService mountPointService;
+ private final @NonNull MdsalDatabindProvider databindProvider;
private final @NonNull DOMDataBroker dataBroker;
private final @Nullable DOMRpcService rpcService;
private final @Nullable DOMActionService actionService;
- private final @Nullable DOMYangTextSourceProvider sourceProvider;
-
- private final Registration reg;
- @SuppressWarnings("unused")
+ @SuppressFBWarnings(value = "URF_UNREAD_FIELD", justification = "https://github.com/spotbugs/spotbugs/issues/2749")
private volatile MdsalRestconfStrategy localStrategy;
@Inject
@Activate
- public MdsalRestconfServer(@Reference final DOMSchemaService schemaService,
+ public MdsalRestconfServer(@Reference final MdsalDatabindProvider databindProvider,
@Reference final DOMDataBroker dataBroker, @Reference final DOMRpcService rpcService,
@Reference final DOMActionService actionService,
@Reference final DOMMountPointService mountPointService,
- @Reference final List<RpcImplementation> localRpcs) {
+ @Reference(policyOption = ReferencePolicyOption.GREEDY) final List<RpcImplementation> localRpcs) {
+ this.databindProvider = requireNonNull(databindProvider);
this.dataBroker = requireNonNull(dataBroker);
this.rpcService = requireNonNull(rpcService);
this.actionService = requireNonNull(actionService);
this.mountPointService = requireNonNull(mountPointService);
- this.localRpcs = Maps.uniqueIndex(localRpcs, RpcImplementation::qname);
- sourceProvider = schemaService.getExtensions().getInstance(DOMYangTextSourceProvider.class);
- localStrategy = createLocalStrategy(schemaService.getGlobalContext());
- reg = schemaService.registerSchemaContextListener(this);
+ this.localRpcs = Maps.uniqueIndex(localRpcs, RpcImplementation::qname);
+ localStrategy = createLocalStrategy(databindProvider.currentDatabind());
}
- public MdsalRestconfServer(final DOMSchemaService schemaService, final DOMDataBroker dataBroker,
+ public MdsalRestconfServer(final MdsalDatabindProvider databindProvider, final DOMDataBroker dataBroker,
final DOMRpcService rpcService, final DOMActionService actionService,
final DOMMountPointService mountPointService, final RpcImplementation... localRpcs) {
- this(schemaService, dataBroker, rpcService, actionService, mountPointService, List.of(localRpcs));
- }
-
- @Override
- public DatabindContext currentDatabind() {
- return localStrategy().databind();
+ this(databindProvider, dataBroker, rpcService, actionService, mountPointService, List.of(localRpcs));
}
- @Override
- public void onModelContextUpdated(final EffectiveModelContext newModelContext) {
- final var local = localStrategy();
- if (!newModelContext.equals(local.modelContext())) {
- LOCAL_STRATEGY.setRelease(this, createLocalStrategy(newModelContext));
- }
- }
-
- private @NonNull MdsalRestconfStrategy createLocalStrategy(final EffectiveModelContext modelContext) {
- return new MdsalRestconfStrategy(DatabindContext.ofModel(modelContext), dataBroker, rpcService, sourceProvider,
- localRpcs);
+ private @NonNull MdsalRestconfStrategy createLocalStrategy(final DatabindContext databind) {
+ return new MdsalRestconfStrategy(databind, dataBroker, localRpcs, rpcService, actionService,
+ databindProvider.sourceProvider(), mountPointService);
}
private @NonNull MdsalRestconfStrategy localStrategy() {
- return verifyNotNull((MdsalRestconfStrategy) LOCAL_STRATEGY.getAcquire(this));
+ final var strategy = verifyNotNull((@NonNull MdsalRestconfStrategy) LOCAL_STRATEGY.getAcquire(this));
+ final var databind = databindProvider.currentDatabind();
+ return databind.equals(strategy.databind()) ? strategy : updateLocalStrategy(databind);
}
- @Deprecated(forRemoval = true)
- private @NonNull MdsalRestconfStrategy localStrategy(final DatabindContext databind) {
- final var local = localStrategy();
- return local.databind().equals(databind) ? local
- : new MdsalRestconfStrategy(databind, dataBroker, rpcService, sourceProvider, localRpcs);
+ private @NonNull MdsalRestconfStrategy updateLocalStrategy(final DatabindContext databind) {
+ final var strategy = createLocalStrategy(databind);
+ localStrategy = strategy;
+ return strategy;
}
@PreDestroy
@Deactivate
@Override
public void close() {
- reg.close();
localStrategy = null;
}
@Override
- public RestconfFuture<Empty> dataDELETE(final ApiPath identifier) {
- final var reqPath = bindRequestPath(identifier);
- final var strategy = getRestconfStrategy(reqPath.databind(), reqPath.getMountPoint());
- return strategy.delete(reqPath.getInstanceIdentifier());
+ public RestconfFuture<Empty> dataDELETE(final ServerRequest request, final ApiPath identifier) {
+ final StrategyAndTail stratAndTail;
+ try {
+ stratAndTail = localStrategy().resolveStrategy(identifier);
+ } catch (RestconfDocumentedException e) {
+ return RestconfFuture.failed(e);
+ }
+ return stratAndTail.strategy().dataDELETE(request, stratAndTail.tail());
}
@Override
- public RestconfFuture<NormalizedNodePayload> dataGET(final ReadDataParams readParams) {
- return readData(bindRequestRoot(), readParams);
+ public RestconfFuture<DataGetResult> dataGET(final ServerRequest request) {
+ return localStrategy().dataGET(request, ApiPath.empty());
}
@Override
- public RestconfFuture<NormalizedNodePayload> dataGET(final ApiPath identifier, final ReadDataParams readParams) {
- return readData(bindRequestPath(identifier), readParams);
- }
-
- private @NonNull RestconfFuture<NormalizedNodePayload> readData(final InstanceIdentifierContext reqPath,
- final ReadDataParams readParams) {
- final var fields = readParams.fields();
- final QueryParameters queryParams;
- if (fields != null) {
- final var modelContext = reqPath.databind().modelContext();
- final var schemaNode = (DataSchemaNode) reqPath.getSchemaNode();
- if (reqPath.getMountPoint() != null) {
- queryParams = QueryParameters.ofFieldPaths(readParams, NetconfFieldsTranslator.translate(modelContext,
- schemaNode, fields));
- } else {
- queryParams = QueryParameters.ofFields(readParams, WriterFieldsTranslator.translate(modelContext,
- schemaNode, fields));
- }
- } else {
- queryParams = QueryParameters.of(readParams);
- }
-
- final var fieldPaths = queryParams.fieldPaths();
- final var strategy = getRestconfStrategy(reqPath.databind(), reqPath.getMountPoint());
- final NormalizedNode node;
- if (fieldPaths != null && !fieldPaths.isEmpty()) {
- node = strategy.readData(readParams.content(), reqPath.getInstanceIdentifier(), readParams.withDefaults(),
- fieldPaths);
- } else {
- node = strategy.readData(readParams.content(), reqPath.getInstanceIdentifier(), readParams.withDefaults());
- }
- if (node == null) {
- return RestconfFuture.failed(new RestconfDocumentedException(
- "Request could not be completed because the relevant data model content does not exist",
- ErrorType.PROTOCOL, ErrorTag.DATA_MISSING));
+ public RestconfFuture<DataGetResult> dataGET(final ServerRequest request, final ApiPath identifier) {
+ final StrategyAndTail stratAndTail;
+ try {
+ stratAndTail = localStrategy().resolveStrategy(identifier);
+ } catch (RestconfDocumentedException e) {
+ return RestconfFuture.failed(e);
}
-
- return RestconfFuture.of(new NormalizedNodePayload(reqPath.inference(), node, queryParams));
+ return stratAndTail.strategy().dataGET(request, stratAndTail.tail());
}
@Override
- public RestconfFuture<Empty> dataPATCH(final ResourceBody body) {
- return dataPATCH(bindRequestRoot(), body);
+ public RestconfFuture<DataPatchResult> dataPATCH(final ServerRequest request, final ResourceBody body) {
+ return localStrategy().dataPATCH(ApiPath.empty(), body);
}
@Override
- public RestconfFuture<Empty> dataPATCH(final ApiPath identifier, final ResourceBody body) {
- return dataPATCH(bindRequestPath(identifier), body);
- }
-
- private @NonNull RestconfFuture<Empty> dataPATCH(final InstanceIdentifierContext reqPath, final ResourceBody body) {
- final var req = bindResourceRequest(reqPath, body);
- return req.strategy().merge(req.path(), req.data());
+ public RestconfFuture<DataPatchResult> dataPATCH(final ServerRequest request, final ApiPath identifier,
+ final ResourceBody body) {
+ final StrategyAndTail strategyAndTail;
+ try {
+ strategyAndTail = localStrategy().resolveStrategy(identifier);
+ } catch (RestconfDocumentedException e) {
+ return RestconfFuture.failed(e);
+ }
+ return strategyAndTail.strategy().dataPATCH(strategyAndTail.tail(), body);
}
@Override
- public RestconfFuture<PatchStatusContext> dataPATCH(final PatchBody body) {
- return dataPATCH(bindRequestRoot(), body);
+ public RestconfFuture<DataYangPatchResult> dataPATCH(final ServerRequest request, final PatchBody body) {
+ return localStrategy().dataPATCH(ApiPath.empty(), body);
}
@Override
- public RestconfFuture<PatchStatusContext> dataPATCH(final ApiPath identifier, final PatchBody body) {
- return dataPATCH(bindRequestPath(identifier), body);
- }
-
- private @NonNull RestconfFuture<PatchStatusContext> dataPATCH(final InstanceIdentifierContext reqPath,
+ public RestconfFuture<DataYangPatchResult> dataPATCH(final ServerRequest request, final ApiPath identifier,
final PatchBody body) {
- final PatchContext patch;
+ final StrategyAndTail strategyAndTail;
try {
- patch = body.toPatchContext(reqPath.databind(), reqPath.getInstanceIdentifier());
- } catch (IOException e) {
- LOG.debug("Error parsing YANG Patch input", e);
- return RestconfFuture.failed(new RestconfDocumentedException("Error parsing input: " + e.getMessage(),
- ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE, e));
+ strategyAndTail = localStrategy().resolveStrategy(identifier);
+ } catch (RestconfDocumentedException e) {
+ return RestconfFuture.failed(e);
}
- return getRestconfStrategy(reqPath.databind(), reqPath.getMountPoint()).patchData(patch);
+ return strategyAndTail.strategy().dataPATCH(strategyAndTail.tail(), body);
}
@Override
- public RestconfFuture<CreateResource> dataPOST(final ChildBody body, final Map<String, String> queryParameters) {
- return dataCreatePOST(bindRequestRoot(), body, queryParameters);
+ public RestconfFuture<CreateResourceResult> dataPOST(final ServerRequest request, final ChildBody body) {
+ return localStrategy().dataCreatePOST(request, body);
}
@Override
- public RestconfFuture<? extends DataPostResult> dataPOST(final ApiPath identifier, final DataPostBody body,
- final Map<String, String> queryParameters) {
- final var reqPath = bindRequestPath(identifier);
- if (reqPath.getSchemaNode() instanceof ActionDefinition) {
- try (var inputBody = body.toOperationInput()) {
- return dataInvokePOST(reqPath, inputBody);
- }
- }
-
- try (var childBody = body.toResource()) {
- return dataCreatePOST(reqPath, childBody, queryParameters);
- }
- }
-
- private @NonNull RestconfFuture<CreateResource> dataCreatePOST(final InstanceIdentifierContext reqPath,
- final ChildBody body, final Map<String, String> queryParameters) {
- final Insert insert;
+ public RestconfFuture<? extends DataPostResult> dataPOST(final ServerRequest request, final ApiPath identifier,
+ final DataPostBody body) {
+ final StrategyAndTail strategyAndTail;
try {
- insert = Insert.ofQueryParameters(reqPath.databind(), queryParameters);
- } catch (IllegalArgumentException e) {
- return RestconfFuture.failed(new RestconfDocumentedException(e.getMessage(),
- ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE, e));
- }
-
- final var parentPath = reqPath.getInstanceIdentifier();
- final var payload = body.toPayload(parentPath, reqPath.inference());
- return getRestconfStrategy(reqPath.databind(), reqPath.getMountPoint())
- .postData(concat(parentPath, payload.prefix()), payload.body(), insert);
- }
-
- private static YangInstanceIdentifier concat(final YangInstanceIdentifier parent, final List<PathArgument> args) {
- var ret = parent;
- for (var arg : args) {
- ret = ret.node(arg);
+ strategyAndTail = localStrategy().resolveStrategy(identifier);
+ } catch (RestconfDocumentedException e) {
+ return RestconfFuture.failed(e);
}
- return ret;
- }
-
- private RestconfFuture<InvokeOperation> dataInvokePOST(final InstanceIdentifierContext reqPath,
- final OperationInputBody body) {
- final var yangIIdContext = reqPath.getInstanceIdentifier();
- final var inference = reqPath.inference();
- final ContainerNode input;
- try {
- input = body.toContainerNode(inference);
- } catch (IOException e) {
- LOG.debug("Error reading input", e);
- return RestconfFuture.failed(new RestconfDocumentedException("Error parsing input: " + e.getMessage(),
- ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE, e));
- }
-
- final var mountPoint = reqPath.getMountPoint();
- final var schemaPath = inference.toSchemaInferenceStack().toSchemaNodeIdentifier();
- final var future = mountPoint != null ? dataInvokePOST(input, schemaPath, yangIIdContext, mountPoint)
- : dataInvokePOST(input, schemaPath, yangIIdContext, actionService);
-
- return future.transform(result -> result.getOutput()
- .flatMap(output -> output.isEmpty() ? Optional.empty()
- : Optional.of(new InvokeOperation(new NormalizedNodePayload(reqPath.inference(), output))))
- .orElse(InvokeOperation.EMPTY));
- }
-
- /**
- * 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}
- */
- private static RestconfFuture<DOMActionResult> dataInvokePOST(final ContainerNode data, final Absolute schemaPath,
- final YangInstanceIdentifier yangIId, final DOMActionService actionService) {
- final var ret = new SettableRestconfFuture<DOMActionResult>();
-
- Futures.addCallback(actionService.invokeAction(schemaPath,
- new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL, yangIId.getParent()), data),
- new FutureCallback<DOMActionResult>() {
- @Override
- public void onSuccess(final DOMActionResult result) {
- final var errors = result.getErrors();
- LOG.debug("InvokeAction Error Message {}", errors);
- if (errors.isEmpty()) {
- ret.set(result);
- } else {
- ret.setFailure(new RestconfDocumentedException("InvokeAction Error Message ", null, errors));
- }
- }
-
- @Override
- public void onFailure(final Throwable cause) {
- if (cause instanceof DOMActionException) {
- ret.set(new SimpleDOMActionResult(List.of(RpcResultBuilder.newError(
- ErrorType.RPC, ErrorTag.OPERATION_FAILED, cause.getMessage()))));
- } else if (cause instanceof RestconfDocumentedException e) {
- ret.setFailure(e);
- } else if (cause instanceof CancellationException) {
- ret.setFailure(new RestconfDocumentedException("Action cancelled while executing",
- ErrorType.RPC, ErrorTag.PARTIAL_OPERATION, cause));
- } else {
- ret.setFailure(new RestconfDocumentedException("Invocation failed", cause));
- }
- }
- }, MoreExecutors.directExecutor());
-
- return ret;
- }
-
- /**
- * Invoking Action via mount point.
- *
- * @param mountPoint mount point
- * @param data input data
- * @param schemaPath schema path of data
- * @return {@link DOMActionResult}
- */
- private static RestconfFuture<DOMActionResult> dataInvokePOST(final ContainerNode data, final Absolute schemaPath,
- final YangInstanceIdentifier yangIId, final DOMMountPoint mountPoint) {
- final var actionService = mountPoint.getService(DOMActionService.class);
- return actionService.isPresent() ? dataInvokePOST(data, schemaPath, yangIId, actionService.orElseThrow())
- : RestconfFuture.failed(new RestconfDocumentedException("DOMActionService is missing."));
+ return strategyAndTail.strategy().dataPOST(request, strategyAndTail.tail(), body);
}
@Override
- public RestconfFuture<DataPutResult> dataPUT(final ResourceBody body, final Map<String, String> query) {
- return dataPUT(bindRequestRoot(), body, query);
+ public RestconfFuture<DataPutResult> dataPUT(final ServerRequest request, final ResourceBody body) {
+ return localStrategy().dataPUT(request, ApiPath.empty(), body);
}
@Override
- public RestconfFuture<DataPutResult> dataPUT(final ApiPath identifier, final ResourceBody body,
- final Map<String, String> queryParameters) {
- return dataPUT(bindRequestPath(identifier), body, queryParameters);
- }
-
- private @NonNull RestconfFuture<DataPutResult> dataPUT(final InstanceIdentifierContext reqPath,
- final ResourceBody body, final Map<String, String> queryParameters) {
- final Insert insert;
+ public RestconfFuture<DataPutResult> dataPUT(final ServerRequest request, final ApiPath identifier,
+ final ResourceBody body) {
+ final StrategyAndTail strategyAndTail;
try {
- insert = Insert.ofQueryParameters(reqPath.databind(), queryParameters);
- } catch (IllegalArgumentException e) {
- return RestconfFuture.failed(new RestconfDocumentedException(e.getMessage(),
- ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE, e));
+ strategyAndTail = localStrategy().resolveStrategy(identifier);
+ } catch (RestconfDocumentedException e) {
+ return RestconfFuture.failed(e);
}
- final var req = bindResourceRequest(reqPath, body);
- return req.strategy().putData(req.path(), req.data(), insert);
+ return strategyAndTail.strategy().dataPUT(request, strategyAndTail.tail(), body);
}
@Override
- public RestconfFuture<ModulesGetResult> modulesYangGET(final String fileName, final String revision) {
- return modulesGET(fileName, revision, YangTextSchemaSource.class);
+ public RestconfFuture<ModulesGetResult> modulesYangGET(final ServerRequest request, final String fileName,
+ final String revision) {
+ return modulesGET(fileName, revision, YangTextSource.class);
}
@Override
- public RestconfFuture<ModulesGetResult> modulesYangGET(final ApiPath mountPath, final String fileName,
- final String revision) {
- return modulesGET(mountPath, fileName, revision, YangTextSchemaSource.class);
+ public RestconfFuture<ModulesGetResult> modulesYangGET(final ServerRequest request, final ApiPath mountPath,
+ final String fileName, final String revision) {
+ return modulesGET(mountPath, fileName, revision, YangTextSource.class);
}
@Override
- public RestconfFuture<ModulesGetResult> modulesYinGET(final String fileName, final String revision) {
- return modulesGET(fileName, revision, YinTextSchemaSource.class);
+ public RestconfFuture<ModulesGetResult> modulesYinGET(final ServerRequest request, final String fileName,
+ final String revision) {
+ return modulesGET(fileName, revision, YinTextSource.class);
}
@Override
- public RestconfFuture<ModulesGetResult> modulesYinGET(final ApiPath mountPath, final String fileName,
- final String revision) {
- return modulesGET(mountPath, fileName, revision, YinTextSchemaSource.class);
+ public RestconfFuture<ModulesGetResult> modulesYinGET(final ServerRequest request, final ApiPath mountPath,
+ final String fileName, final String revision) {
+ return modulesGET(mountPath, fileName, revision, YinTextSource.class);
}
private @NonNull RestconfFuture<ModulesGetResult> modulesGET(final String fileName, final String revision,
- final Class<? extends SchemaSourceRepresentation> representation) {
+ final Class<? extends SourceRepresentation> representation) {
return modulesGET(localStrategy(), fileName, revision, representation);
}
private @NonNull RestconfFuture<ModulesGetResult> modulesGET(final ApiPath mountPath, final String fileName,
- final String revision, final Class<? extends SchemaSourceRepresentation> representation) {
+ final String revision, final Class<? extends SourceRepresentation> representation) {
final var mountOffset = mountPath.indexOf("yang-ext", "mount");
if (mountOffset != mountPath.steps().size() - 1) {
return RestconfFuture.failed(new RestconfDocumentedException("Mount path has to end with yang-ext:mount"));
}
- final InstanceIdentifierContext point;
- try {
- point = InstanceIdentifierContext.ofApiPath(mountPath, localStrategy().databind(), mountPointService);
- } catch (RestconfDocumentedException e) {
- return RestconfFuture.failed(e);
- }
-
- final RestconfStrategy strategy;
+ final StrategyAndTail stratAndTail;
try {
- strategy = forMountPoint(point.databind(), point.getMountPoint());
+ stratAndTail = localStrategy().resolveStrategy(mountPath);
} catch (RestconfDocumentedException e) {
return RestconfFuture.failed(e);
}
- return modulesGET(strategy, fileName, revision, representation);
+ // FIXME: require remnant to be empty
+ return modulesGET(stratAndTail.strategy(), fileName, revision, representation);
}
private static @NonNull RestconfFuture<ModulesGetResult> modulesGET(final RestconfStrategy strategy,
final String moduleName, final String revisionStr,
- final Class<? extends SchemaSourceRepresentation> representation) {
+ final Class<? extends SourceRepresentation> representation) {
if (moduleName == null) {
return RestconfFuture.failed(new RestconfDocumentedException("Module name must be supplied",
ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE));
}
@Override
- public RestconfFuture<OperationsGetResult> operationsGET() {
- return operationsGET(localStrategy().modelContext());
- }
-
- @Override
- public RestconfFuture<OperationsGetResult> operationsGET(final ApiPath operation) {
- // get current module RPCs/actions by RPC/action name
- final var inference = bindRequestPath(operation).inference();
- if (inference.isEmpty()) {
- return operationsGET(inference.getEffectiveModelContext());
- }
-
- final var stmt = inference.toSchemaInferenceStack().currentStatement();
- if (stmt instanceof RpcEffectiveStatement rpc) {
- return RestconfFuture.of(
- new OperationsGetResult.Leaf(inference.getEffectiveModelContext(), rpc.argument()));
- }
- return RestconfFuture.failed(new RestconfDocumentedException("RPC not found",
- ErrorType.PROTOCOL, ErrorTag.DATA_MISSING));
- }
-
- private static @NonNull RestconfFuture<OperationsGetResult> operationsGET(
- final EffectiveModelContext modelContext) {
- final var modules = modelContext.getModuleStatements();
- if (modules.isEmpty()) {
- // No modules, or defensive return empty content
- return RestconfFuture.of(new OperationsGetResult.Container(modelContext, ImmutableSetMultimap.of()));
- }
-
- // RPC QNames by their XMLNamespace/Revision. This should be a Table, but Revision can be null, which wrecks us.
- final var table = new HashMap<XMLNamespace, Map<Revision, ImmutableSet<QName>>>();
- for (var entry : modules.entrySet()) {
- final var module = entry.getValue();
- final var rpcNames = module.streamEffectiveSubstatements(RpcEffectiveStatement.class)
- .map(RpcEffectiveStatement::argument)
- .collect(ImmutableSet.toImmutableSet());
- if (!rpcNames.isEmpty()) {
- final var namespace = entry.getKey();
- table.computeIfAbsent(namespace.getNamespace(), ignored -> new HashMap<>())
- .put(namespace.getRevision().orElse(null), rpcNames);
- }
- }
-
- // Now pick the latest revision for each namespace
- final var rpcs = ImmutableSetMultimap.<QNameModule, QName>builder();
- for (var entry : table.entrySet()) {
- entry.getValue().entrySet().stream()
- .sorted(Comparator.comparing(Entry::getKey, (first, second) -> Revision.compare(second, first)))
- .findFirst()
- .ifPresent(row -> rpcs.putAll(QNameModule.create(entry.getKey(), row.getKey()), row.getValue()));
- }
- return RestconfFuture.of(new OperationsGetResult.Container(modelContext, rpcs.build()));
+ public RestconfFuture<FormattableBody> operationsGET(final ServerRequest request) {
+ return localStrategy().operationsGET(request);
}
@Override
- public RestconfFuture<OperationOutput> operationsPOST(final URI restconfURI, final ApiPath apiPath,
- final OperationInputBody body) {
- final var reqPath = bindRequestPath(localStrategy(), apiPath);
- final var inference = reqPath.inference();
- final ContainerNode input;
+ public RestconfFuture<FormattableBody> operationsGET(final ServerRequest request, final ApiPath operation) {
+ final StrategyAndTail strategyAndTail;
try {
- input = body.toContainerNode(inference);
- } catch (IOException e) {
- LOG.debug("Error reading input", e);
- return RestconfFuture.failed(new RestconfDocumentedException("Error parsing input: " + e.getMessage(),
- ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE, e));
+ strategyAndTail = localStrategy().resolveStrategy(operation);
+ } catch (RestconfDocumentedException e) {
+ return RestconfFuture.failed(e);
}
- final var strategy = getRestconfStrategy(reqPath.databind(), reqPath.getMountPoint());
- return strategy.invokeRpc(restconfURI, reqPath.getSchemaNode().getQName(),
- new OperationInput(strategy.databind(), inference, input));
+ final var strategy = strategyAndTail.strategy();
+ final var tail = strategyAndTail.tail();
+ return tail.isEmpty() ? strategy.operationsGET(request) : strategy.operationsGET(request, tail);
}
@Override
- public RestconfFuture<NormalizedNodePayload> yangLibraryVersionGET() {
- final var stack = SchemaInferenceStack.of(localStrategy().modelContext());
+ public RestconfFuture<InvokeResult> operationsPOST(final ServerRequest request, final URI restconfURI,
+ final ApiPath apiPath, final OperationInputBody body) {
+ final StrategyAndTail strategyAndTail;
try {
- stack.enterYangData(YangApi.NAME);
- stack.enterDataTree(Restconf.QNAME);
- stack.enterDataTree(YANG_LIBRARY_VERSION);
- } catch (IllegalArgumentException e) {
- return RestconfFuture.failed(new RestconfDocumentedException("RESTCONF is not available"));
- }
- return RestconfFuture.of(new NormalizedNodePayload(stack.toInference(),
- ImmutableNodes.leafNode(YANG_LIBRARY_VERSION, stack.getEffectiveModelContext()
- .findModuleStatements("ietf-yang-library").iterator().next().localQNameModule().getRevision()
- .map(Revision::toString).orElse(""))));
- }
-
- private @NonNull InstanceIdentifierContext bindRequestPath(final @NonNull ApiPath identifier) {
- return bindRequestPath(localStrategy(), identifier);
- }
-
- private @NonNull InstanceIdentifierContext bindRequestPath(final @NonNull MdsalRestconfStrategy strategy,
- final @NonNull ApiPath identifier) {
- // FIXME: DatabindContext looks like it should be internal
- return InstanceIdentifierContext.ofApiPath(identifier, strategy.databind(), mountPointService);
- }
-
- private @NonNull InstanceIdentifierContext bindRequestRoot() {
- return InstanceIdentifierContext.ofLocalRoot(localStrategy().databind());
- }
-
- private @NonNull ResourceRequest bindResourceRequest(final InstanceIdentifierContext reqPath,
- final ResourceBody body) {
- final var path = reqPath.getInstanceIdentifier();
- final var data = body.toNormalizedNode(path, reqPath.inference(), reqPath.getSchemaNode());
-
- return new ResourceRequest(getRestconfStrategy(reqPath.databind(), reqPath.getMountPoint()), path, data);
- }
-
- @VisibleForTesting
- @NonNull RestconfStrategy getRestconfStrategy(final DatabindContext databind,
- final @Nullable DOMMountPoint mountPoint) {
- if (mountPoint == null) {
- return localStrategy(databind);
+ strategyAndTail = localStrategy().resolveStrategy(apiPath);
+ } catch (RestconfDocumentedException e) {
+ return RestconfFuture.failed(e);
}
- return forMountPoint(databind, mountPoint);
+ final var strategy = strategyAndTail.strategy();
+ return strategy.operationsPOST(request, restconfURI, strategyAndTail.tail(), body);
}
- private static @NonNull RestconfStrategy forMountPoint(final DatabindContext databind,
- final DOMMountPoint mountPoint) {
- final var ret = RestconfStrategy.forMountPoint(databind, mountPoint);
- if (ret == null) {
- final var mountId = mountPoint.getIdentifier();
- LOG.warn("Mount point {} does not expose a suitable access interface", mountId);
- throw new RestconfDocumentedException("Could not find a supported access interface in mount point",
- ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED, mountId);
- }
- return ret;
+ @Override
+ public RestconfFuture<FormattableBody> yangLibraryVersionGET(final ServerRequest request) {
+ return localStrategy().yangLibraryVersionGET(request);
}
}
Code Review / netconf.git / blobdiff