• Home
• org.opendaylight.netconf
• restconf-server-mdsal
• 8.0.2
• source code
• MdsalRestconfServer.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

/*
 * 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.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 javax.annotation.PreDestroy;
import javax.inject.Inject;
import javax.inject.Singleton;
import org.eclipse.jdt.annotation.NonNull;
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.restconf.api.ApiPath;
import org.opendaylight.restconf.api.FormattableBody;
import org.opendaylight.restconf.mdsal.spi.DOMServerActionOperations;
import org.opendaylight.restconf.mdsal.spi.DOMServerModulesOperations;
import org.opendaylight.restconf.mdsal.spi.DOMServerRpcOperations;
import org.opendaylight.restconf.mdsal.spi.data.MdsalRestconfStrategy;
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.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.OperationInputBody;
import org.opendaylight.restconf.server.api.OptionsResult;
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.api.ServerException;
import org.opendaylight.restconf.server.api.ServerRequest;
import org.opendaylight.restconf.server.spi.ExportingServerModulesOperations;
import org.opendaylight.restconf.server.spi.InterceptingServerRpcOperations;
import org.opendaylight.restconf.server.spi.NotSupportedServerActionOperations;
import org.opendaylight.restconf.server.spi.NotSupportedServerRpcOperations;
import org.opendaylight.restconf.server.spi.RpcImplementation;
import org.opendaylight.restconf.server.spi.ServerActionOperations;
import org.opendaylight.restconf.server.spi.ServerRpcOperations;
import org.opendaylight.restconf.server.spi.ServerStrategy;
import org.opendaylight.restconf.server.spi.ServerStrategy.StrategyAndPath;
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.Revision;
import org.opendaylight.yangtools.yang.common.YangNames;
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.osgi.service.component.annotations.ReferencePolicyOption;

/**
 * A RESTCONF server implemented on top of MD-SAL.
 */
@Singleton
@Component(service = RestconfServer.class)
public final class MdsalRestconfServer implements RestconfServer, AutoCloseable {
    private static final VarHandle LOCAL_STRATEGY;

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

    private final @NonNull MdsalMountPointResolver mountPointResolver;
    private final @NonNull MdsalDatabindProvider databindProvider;
    private final @NonNull ServerActionOperations action;
    private final @NonNull ServerRpcOperations rpc;
    private final @NonNull DOMDataBroker dataBroker;

    @SuppressFBWarnings(value = "URF_UNREAD_FIELD", justification = "https://github.com/spotbugs/spotbugs/issues/2749")
    private volatile MdsalServerStrategy localStrategy;

    @Inject
    @Activate
    public MdsalRestconfServer(@Reference final MdsalDatabindProvider databindProvider,
            @Reference final DOMDataBroker dataBroker, @Reference final DOMRpcService rpcService,
            @Reference final DOMActionService actionService,
            @Reference final DOMMountPointService mountPointService,
            @Reference(policyOption = ReferencePolicyOption.GREEDY) final List localRpcs) {
        this.databindProvider = requireNonNull(databindProvider);
        this.dataBroker = requireNonNull(dataBroker);
        mountPointResolver = new MdsalMountPointResolver(mountPointService);

        final var rpcs = Maps.uniqueIndex(localRpcs, RpcImplementation::qname);
        final var rpcDelegate = rpcService != null ? new DOMServerRpcOperations(rpcService)
            : NotSupportedServerRpcOperations.INSTANCE;
        rpc = rpcs.isEmpty() ? rpcDelegate
            : new InterceptingServerRpcOperations(path -> rpcs.get(path.rpc().argument()), rpcDelegate);
        action = actionService != null ? new DOMServerActionOperations(actionService)
            : NotSupportedServerActionOperations.INSTANCE;

        localStrategy = createLocalStrategy(databindProvider.currentDatabind());
    }

    public MdsalRestconfServer(final MdsalDatabindProvider databindProvider, final DOMDataBroker dataBroker,
            final DOMRpcService rpcService, final DOMActionService actionService,
            final DOMMountPointService mountPointService, final RpcImplementation... localRpcs) {
        this(databindProvider, dataBroker, rpcService, actionService, mountPointService, List.of(localRpcs));
    }

    private @NonNull MdsalServerStrategy createLocalStrategy(final @NonNull DatabindContext databind) {
        final var sourceExporter = new ExportingServerModulesOperations(databind.modelContext());
        final var sourceProvider = databindProvider.sourceProvider();

        return new MdsalServerStrategy(databind, mountPointResolver, action,
            new MdsalRestconfStrategy(databind, dataBroker),
            sourceProvider == null ? sourceExporter : new DOMServerModulesOperations(sourceProvider, sourceExporter),
            rpc);
    }

    private @NonNull MdsalServerStrategy localStrategy() {
        final var strategy = verifyNotNull((@NonNull MdsalServerStrategy) LOCAL_STRATEGY.getAcquire(this));
        final var databind = databindProvider.currentDatabind();
        return databind.equals(strategy.databind()) ? strategy : updateLocalStrategy(databind);
    }

    private @NonNull MdsalServerStrategy updateLocalStrategy(final @NonNull DatabindContext databind) {
        final var strategy = createLocalStrategy(databind);
        localStrategy = strategy;
        return strategy;
    }

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

    @Override
    public void dataDELETE(final ServerRequest request, final ApiPath identifier) {
        final StrategyAndPath stratAndTail;
        try {
            stratAndTail = localStrategy().resolveStrategy(identifier);
        } catch (ServerException e) {
            request.completeWith(e);
            return;
        }
        stratAndTail.strategy().dataDELETE(request, stratAndTail.path());
    }

    @Override
    public void dataGET(final ServerRequest request) {
        localStrategy().dataGET(request);
    }

    @Override
    public void dataGET(final ServerRequest request, final ApiPath identifier) {
        final StrategyAndPath stratAndTail;
        try {
            stratAndTail = localStrategy().resolveStrategy(identifier);
        } catch (ServerException e) {
            request.completeWith(e);
            return;
        }
        stratAndTail.strategy().dataGET(request, stratAndTail.path());
    }

    @Override
    public void dataOPTIONS(final ServerRequest request) {
        localStrategy().dataOPTIONS(request);
    }

    @Override
    public void dataOPTIONS(final ServerRequest request, final ApiPath identifier) {
        final StrategyAndPath stratAndTail;
        try {
            stratAndTail = localStrategy().resolveStrategy(identifier);
        } catch (ServerException e) {
            request.completeWith(e);
            return;
        }

        final var strategy = stratAndTail.strategy();
        final var tail = stratAndTail.path();
        if (tail.isEmpty()) {
            strategy.dataOPTIONS(request);
        } else {
            strategy.dataOPTIONS(request, tail);
        }
    }

    @Override
    public void dataPATCH(final ServerRequest request, final ResourceBody body) {
        localStrategy().dataPATCH(request, body);
    }

    @Override
    public void dataPATCH(final ServerRequest request, final ApiPath identifier,
            final ResourceBody body) {
        final StrategyAndPath strategyAndPath;
        try {
            strategyAndPath = localStrategy().resolveStrategy(identifier);
        } catch (ServerException e) {
            request.completeWith(e);
            return;
        }
        strategyAndPath.strategy().dataPATCH(request, strategyAndPath.path(), body);
    }

    @Override
    public void dataPATCH(final ServerRequest request, final PatchBody body) {
        localStrategy().dataPATCH(request, body);
    }

    @Override
    public void dataPATCH(final ServerRequest request, final ApiPath identifier,
            final PatchBody body) {
        final StrategyAndPath strategyAndPath;
        try {
            strategyAndPath = localStrategy().resolveStrategy(identifier);
        } catch (ServerException e) {
            request.completeWith(e);
            return;
        }
        strategyAndPath.strategy().dataPATCH(request, strategyAndPath.path(), body);
    }

    @Override
    public void dataPOST(final ServerRequest request, final ChildBody body) {
        localStrategy().dataPOST(request, body);
    }

    @Override
    public void dataPOST(final ServerRequest request, final ApiPath identifier,
            final DataPostBody body) {
        final StrategyAndPath strategyAndPath;
        try {
            strategyAndPath = localStrategy().resolveStrategy(identifier);
        } catch (ServerException e) {
            request.completeWith(e);
            return;
        }
        strategyAndPath.strategy().dataPOST(request, strategyAndPath.path(), body);
    }

    @Override
    public void dataPUT(final ServerRequest request, final ResourceBody body) {
        localStrategy().dataPUT(request, body);
    }

    @Override
    public void dataPUT(final ServerRequest request, final ApiPath identifier, final ResourceBody body) {
        final StrategyAndPath strategyAndPath;
        try {
            strategyAndPath = localStrategy().resolveStrategy(identifier);
        } catch (ServerException e) {
            request.completeWith(e);
            return ;
        }
        strategyAndPath.strategy().dataPUT(request, strategyAndPath.path(), body);
    }

    @Override
    public void modulesYangGET(final ServerRequest request, final String fileName,
            final String revision) {
        modulesGET(request, fileName, revision, YangTextSource.class);
    }

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

    @Override
    public void modulesYinGET(final ServerRequest request, final String fileName,
            final String revision) {
        modulesGET(request, fileName, revision, YinTextSource.class);
    }

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

    private void modulesGET(final ServerRequest request, final String fileName, final String revision,
            final Class representation) {
        modulesGET(request, localStrategy(), fileName, revision, representation);
    }

    private void modulesGET(final ServerRequest request, 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) {
            request.completeWith(new ServerException("Mount path has to end with yang-ext:mount"));
            return;
        }

        final StrategyAndPath stratAndTail;
        try {
            stratAndTail = localStrategy().resolveStrategy(mountPath);
        } catch (ServerException e) {
            request.completeWith(e);
            return;
        }
        // FIXME: require remnant to be empty
        modulesGET(request, stratAndTail.strategy(), fileName, revision, representation);
    }

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

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

        strategy.modulesGET(request, new SourceIdentifier(moduleName, revision), representation);
    }

    @Override
    public void operationsGET(final ServerRequest request) {
        localStrategy().operationsGET(request);
    }

    @Override
    public void operationsGET(final ServerRequest request, final ApiPath operation) {
        final StrategyAndPath strategyAndPath;
        try {
            strategyAndPath = localStrategy().resolveStrategy(operation);
        } catch (ServerException e) {
            request.completeWith(e);
            return;
        }

        final var strategy = strategyAndPath.strategy();
        final var tail = strategyAndPath.path();
        if (tail.isEmpty()) {
            strategy.operationsGET(request);
        } else {
            strategy.operationsGET(request, tail);
        }
    }

    @Override
    public void operationsOPTIONS(final ServerRequest request, final ApiPath operation) {
        final StrategyAndPath strategyAndPath;
        try {
            strategyAndPath = localStrategy().resolveStrategy(operation);
        } catch (ServerException e) {
            request.completeWith(e);
            return;
        }

        final var tail = strategyAndPath.path();
        if (tail.isEmpty()) {
            request.completeWith(OptionsResult.READ_ONLY);
        } else {
            strategyAndPath.strategy().operationsOPTIONS(request, tail);
        }
    }

    @Override
    public void operationsPOST(final ServerRequest request, final URI restconfURI, final ApiPath apiPath,
            final OperationInputBody body) {
        final StrategyAndPath strategyAndPath;
        try {
            strategyAndPath = localStrategy().resolveStrategy(apiPath);
        } catch (ServerException e) {
            request.completeWith(e);
            return;
        }
        strategyAndPath.strategy().operationsPOST(request, restconfURI, strategyAndPath.path(), body);
    }

    @Override
    public void yangLibraryVersionGET(final ServerRequest request) {
        localStrategy().yangLibraryVersionGET(request);
    }
}