org.opendaylight.restconf.server.mdsal.MdsalRestconfServer Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2023 PANTHEON.tech, s.r.o. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.restconf.server.mdsal;

import static com.google.common.base.Verify.verifyNotNull;
import static java.util.Objects.requireNonNull;

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.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.mdsal.dom.api.DOMActionService;
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.DOMSchemaService.YangTextSourceExtension;
import org.opendaylight.restconf.api.ApiPath;
import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
import org.opendaylight.restconf.common.errors.RestconfFuture;
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.ChildBody;
import org.opendaylight.restconf.server.api.DataGetParams;
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.ModulesGetResult;
import org.opendaylight.restconf.server.api.OperationInputBody;
import org.opendaylight.restconf.server.api.OperationsGetResult;
import org.opendaylight.restconf.server.api.OperationsPostResult;
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.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.spi.node.ImmutableNodes;
import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
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.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
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;

/**
 * A RESTCONF server implemented on top of MD-SAL.
 */
@Singleton
@Component(service = { RestconfServer.class, DatabindProvider.class })
public final class MdsalRestconfServer implements RestconfServer, DatabindProvider, AutoCloseable {
    private static final QName YANG_LIBRARY_VERSION = QName.create(Restconf.QNAME, "yang-library-version").intern();
    private static final VarHandle LOCAL_STRATEGY;

    static {
        try {
            LOCAL_STRATEGY = MethodHandles.lookup()
                .findVarHandle(MdsalRestconfServer.class, "localStrategy", MdsalRestconfStrategy.class);
        } catch (NoSuchFieldException | IllegalAccessException e) {
            throw new ExceptionInInitializerError(e);
        }
    }

    private final @NonNull ImmutableMap localRpcs;
    private final @NonNull DOMMountPointService mountPointService;
    private final @NonNull DOMDataBroker dataBroker;
    private final @Nullable DOMRpcService rpcService;
    private final @Nullable DOMActionService actionService;
    private final @Nullable YangTextSourceExtension 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,
            @Reference final DOMDataBroker dataBroker, @Reference final DOMRpcService rpcService,
            @Reference final DOMActionService actionService,
            @Reference final DOMMountPointService mountPointService,
            @Reference final List localRpcs) {
        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.extension(YangTextSourceExtension.class);

        localStrategy = createLocalStrategy(schemaService.getGlobalContext());
        reg = schemaService.registerSchemaContextListener(this::onModelContextUpdated);
    }

    public MdsalRestconfServer(final DOMSchemaService schemaService, 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();
    }

    private 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() {
        return verifyNotNull((MdsalRestconfStrategy) LOCAL_STRATEGY.getAcquire(this));
    }

    @PreDestroy
    @Deactivate
    @Override
    public void close() {
        reg.close();
        localStrategy = null;
    }

    @Override
    public RestconfFuture dataDELETE(final ApiPath identifier) {
        final StrategyAndTail stratAndTail;
        try {
            stratAndTail = localStrategy().resolveStrategy(identifier);
        } catch (RestconfDocumentedException e) {
            return RestconfFuture.failed(e);
        }
        return stratAndTail.strategy().dataDELETE(stratAndTail.tail());
    }

    @Override
    public RestconfFuture dataGET(final DataGetParams params) {
        return localStrategy().dataGET(ApiPath.empty(), params);
    }

    @Override
    public RestconfFuture dataGET(final ApiPath identifier, final DataGetParams params) {
        final StrategyAndTail stratAndTail;
        try {
            stratAndTail = localStrategy().resolveStrategy(identifier);
        } catch (RestconfDocumentedException e) {
            return RestconfFuture.failed(e);
        }
        return stratAndTail.strategy().dataGET(stratAndTail.tail(), params);
    }

    @Override
    public RestconfFuture dataPATCH(final ResourceBody body) {
        return localStrategy().dataPATCH(ApiPath.empty(), body);
    }

    @Override
    public RestconfFuture dataPATCH(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 dataPATCH(final PatchBody body) {
        return localStrategy().dataPATCH(ApiPath.empty(), body);
    }

    @Override
    public RestconfFuture dataPATCH(final ApiPath identifier, final PatchBody 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 dataPOST(final ChildBody body, final Map queryParameters) {
        return localStrategy().dataCreatePOST(body, queryParameters);
    }

    @Override
    public RestconfFuture dataPOST(final ApiPath identifier, final DataPostBody body,
            final Map queryParameters) {
        final StrategyAndTail strategyAndTail;
        try {
            strategyAndTail = localStrategy().resolveStrategy(identifier);
        } catch (RestconfDocumentedException e) {
            return RestconfFuture.failed(e);
        }
        return strategyAndTail.strategy().dataPOST(strategyAndTail.tail(), body, queryParameters);
    }

    @Override
    public RestconfFuture dataPUT(final ResourceBody body, final Map query) {
        return localStrategy().dataPUT(ApiPath.empty(), body, query);
    }

    @Override
    public RestconfFuture dataPUT(final ApiPath identifier, final ResourceBody body,
             final Map queryParameters) {
        final StrategyAndTail strategyAndTail;
        try {
            strategyAndTail = localStrategy().resolveStrategy(identifier);
        } catch (RestconfDocumentedException e) {
            return RestconfFuture.failed(e);
        }
        return strategyAndTail.strategy().dataPUT(strategyAndTail.tail(), body, queryParameters);
    }

    @Override
    public RestconfFuture modulesYangGET(final String fileName, final String revision) {
        return modulesGET(fileName, revision, YangTextSource.class);
    }

    @Override
    public RestconfFuture modulesYangGET(final ApiPath mountPath, final String fileName,
            final String revision) {
        return modulesGET(mountPath, fileName, revision, YangTextSource.class);
    }

    @Override
    public RestconfFuture modulesYinGET(final String fileName, final String revision) {
        return modulesGET(fileName, revision, YinTextSource.class);
    }

    @Override
    public RestconfFuture modulesYinGET(final ApiPath mountPath, final String fileName,
            final String revision) {
        return modulesGET(mountPath, fileName, revision, YinTextSource.class);
    }

    private @NonNull RestconfFuture modulesGET(final String fileName, final String revision,
            final Class representation) {
        return modulesGET(localStrategy(), fileName, revision, representation);
    }

    private @NonNull RestconfFuture modulesGET(final ApiPath mountPath, final String fileName,
            final String revision, final Class 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 StrategyAndTail stratAndTail;
        try {
            stratAndTail = localStrategy().resolveStrategy(mountPath);
        } catch (RestconfDocumentedException e) {
            return RestconfFuture.failed(e);
        }
        // FIXME: require remnant to be empty
        return modulesGET(stratAndTail.strategy(), fileName, revision, representation);
    }

    private static @NonNull RestconfFuture modulesGET(final RestconfStrategy strategy,
            final String moduleName, final String revisionStr,
            final Class representation) {
        if (moduleName == null) {
            return RestconfFuture.failed(new RestconfDocumentedException("Module name must be supplied",
                ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE));
        }
        if (moduleName.isEmpty() || !YangNames.IDENTIFIER_START.matches(moduleName.charAt(0))) {
            return RestconfFuture.failed(new RestconfDocumentedException(
                "Identifier must start with character from set 'a-zA-Z_", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE));
        }
        if (moduleName.toUpperCase(Locale.ROOT).startsWith("XML")) {
            return RestconfFuture.failed(new RestconfDocumentedException(
                "Identifier must NOT start with XML ignore case", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE));
        }
        if (YangNames.NOT_IDENTIFIER_PART.matchesAnyOf(moduleName.substring(1))) {
            return RestconfFuture.failed(new RestconfDocumentedException(
                "Supplied name has not expected identifier format", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE));
        }

        // YANG Revision-compliant string is required
        final Revision revision;
        try {
            revision = Revision.ofNullable(revisionStr).orElse(null);
        } catch (final DateTimeParseException e) {
            return RestconfFuture.failed(new RestconfDocumentedException(
                "Supplied revision is not in expected date format YYYY-mm-dd",
                ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE, e));
        }

        return strategy.resolveSource(new SourceIdentifier(moduleName, revision), representation)
            .transform(ModulesGetResult::new);
    }

    @Override
    public RestconfFuture operationsGET() {
        return localStrategy().operationsGET();
    }

    @Override
    public RestconfFuture operationsGET(final ApiPath operation) {
        final StrategyAndTail strategyAndTail;
        try {
            strategyAndTail = localStrategy().resolveStrategy(operation);
        } catch (RestconfDocumentedException e) {
            return RestconfFuture.failed(e);
        }
        return strategyAndTail.strategy().operationsGET(strategyAndTail.tail());
    }

    @Override
    public RestconfFuture operationsPOST(final URI restconfURI, final ApiPath apiPath,
            final OperationInputBody body) {
        final StrategyAndTail strategyAndTail;
        try {
            strategyAndTail = localStrategy().resolveStrategy(apiPath);
        } catch (RestconfDocumentedException e) {
            return RestconfFuture.failed(e);
        }
        final var strategy = strategyAndTail.strategy();
        return strategy.operationsPOST(restconfURI, strategyAndTail.tail(), body);
    }

    @Override
    public RestconfFuture 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.modelContext()
                .findModuleStatements("ietf-yang-library").iterator().next().localQNameModule().getRevision()
                .map(Revision::toString).orElse(""))));
    }
}