import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Maps;
+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.List;
import java.util.Locale;
-import java.util.Map;
import javax.annotation.PreDestroy;
import javax.inject.Inject;
import javax.inject.Singleton;
import org.opendaylight.mdsal.dom.api.DOMDataBroker;
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.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.patch.PatchStatusContext;
-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.NormalizedNodePayload;
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.transactions.RestconfStrategy.StrategyAndTail;
-import org.opendaylight.restconf.server.api.DataGetParams;
+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.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.OperationsPostResult;
+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.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.Revision;
import org.opendaylight.yangtools.yang.common.YangNames;
-import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
-import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
-import org.opendaylight.yangtools.yang.model.api.EffectiveModelContextListener;
-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 {
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));
+ this(databindProvider, dataBroker, rpcService, actionService, mountPointService, List.of(localRpcs));
}
- @Override
- public DatabindContext currentDatabind() {
- return localStrategy().databind();
+ private @NonNull MdsalRestconfStrategy createLocalStrategy(final DatabindContext databind) {
+ return new MdsalRestconfStrategy(databind, dataBroker, localRpcs, rpcService, actionService,
+ databindProvider.sourceProvider(), mountPointService);
}
- @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, actionService,
- sourceProvider, mountPointService, localRpcs);
+ private @NonNull MdsalRestconfStrategy localStrategy() {
+ final var strategy = verifyNotNull((@NonNull MdsalRestconfStrategy) LOCAL_STRATEGY.getAcquire(this));
+ final var databind = databindProvider.currentDatabind();
+ return databind.equals(strategy.databind()) ? strategy : updateLocalStrategy(databind);
}
- private @NonNull MdsalRestconfStrategy localStrategy() {
- return verifyNotNull((MdsalRestconfStrategy) LOCAL_STRATEGY.getAcquire(this));
+ 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) {
+ 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(stratAndTail.tail());
+ return stratAndTail.strategy().dataDELETE(request, stratAndTail.tail());
}
@Override
- public RestconfFuture<DataGetResult> dataGET(final DataGetParams params) {
- return localStrategy().dataGET(ApiPath.empty(), params);
+ public RestconfFuture<DataGetResult> dataGET(final ServerRequest request) {
+ return localStrategy().dataGET(request, ApiPath.empty());
}
@Override
- public RestconfFuture<DataGetResult> dataGET(final ApiPath identifier, final DataGetParams params) {
+ 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 stratAndTail.strategy().dataGET(stratAndTail.tail(), params);
+ return stratAndTail.strategy().dataGET(request, stratAndTail.tail());
}
@Override
- public RestconfFuture<DataPatchResult> dataPATCH(final ResourceBody body) {
+ public RestconfFuture<DataPatchResult> dataPATCH(final ServerRequest request, final ResourceBody body) {
return localStrategy().dataPATCH(ApiPath.empty(), body);
}
@Override
- public RestconfFuture<DataPatchResult> dataPATCH(final ApiPath identifier, final ResourceBody body) {
+ public RestconfFuture<DataPatchResult> dataPATCH(final ServerRequest request, final ApiPath identifier,
+ final ResourceBody body) {
final StrategyAndTail strategyAndTail;
try {
strategyAndTail = localStrategy().resolveStrategy(identifier);
}
@Override
- public RestconfFuture<PatchStatusContext> dataPATCH(final PatchBody 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) {
+ public RestconfFuture<DataYangPatchResult> dataPATCH(final ServerRequest request, final ApiPath identifier,
+ final PatchBody body) {
final StrategyAndTail strategyAndTail;
try {
strategyAndTail = localStrategy().resolveStrategy(identifier);
}
@Override
- public RestconfFuture<CreateResource> dataPOST(final ChildBody body, final Map<String, String> queryParameters) {
- return localStrategy().dataCreatePOST(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) {
+ public RestconfFuture<? extends DataPostResult> dataPOST(final ServerRequest request, final ApiPath identifier,
+ final DataPostBody body) {
final StrategyAndTail strategyAndTail;
try {
strategyAndTail = localStrategy().resolveStrategy(identifier);
} catch (RestconfDocumentedException e) {
return RestconfFuture.failed(e);
}
- return strategyAndTail.strategy().dataPOST(strategyAndTail.tail(), body, queryParameters);
+ return strategyAndTail.strategy().dataPOST(request, strategyAndTail.tail(), body);
}
@Override
- public RestconfFuture<DataPutResult> dataPUT(final ResourceBody body, final Map<String, String> query) {
- return localStrategy().dataPUT(ApiPath.empty(), 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) {
+ public RestconfFuture<DataPutResult> dataPUT(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().dataPUT(strategyAndTail.tail(), body, queryParameters);
+ 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"));
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 localStrategy().operationsGET();
+ public RestconfFuture<FormattableBody> operationsGET(final ServerRequest request) {
+ return localStrategy().operationsGET(request);
}
@Override
- public RestconfFuture<OperationsGetResult> operationsGET(final ApiPath operation) {
+ public RestconfFuture<FormattableBody> operationsGET(final ServerRequest request, final ApiPath operation) {
final StrategyAndTail strategyAndTail;
try {
strategyAndTail = localStrategy().resolveStrategy(operation);
} catch (RestconfDocumentedException e) {
return RestconfFuture.failed(e);
}
- return strategyAndTail.strategy().operationsGET(strategyAndTail.tail());
+
+ final var strategy = strategyAndTail.strategy();
+ final var tail = strategyAndTail.tail();
+ return tail.isEmpty() ? strategy.operationsGET(request) : strategy.operationsGET(request, tail);
}
@Override
- public RestconfFuture<OperationsPostResult> operationsPOST(final URI restconfURI, final ApiPath apiPath,
- final OperationInputBody body) {
+ public RestconfFuture<InvokeResult> operationsPOST(final ServerRequest request, final URI restconfURI,
+ final ApiPath apiPath, final OperationInputBody body) {
final StrategyAndTail strategyAndTail;
try {
strategyAndTail = localStrategy().resolveStrategy(apiPath);
return RestconfFuture.failed(e);
}
final var strategy = strategyAndTail.strategy();
- return strategy.operationsPOST(restconfURI, strategyAndTail.tail(), body);
+ return strategy.operationsPOST(request, restconfURI, strategyAndTail.tail(), body);
}
@Override
- public RestconfFuture<NormalizedNodePayload> yangLibraryVersionGET() {
- final var stack = SchemaInferenceStack.of(localStrategy().modelContext());
- 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(""))));
+ public RestconfFuture<FormattableBody> yangLibraryVersionGET(final ServerRequest request) {
+ return localStrategy().yangLibraryVersionGET(request);
}
}