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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of restconf-server-mdsal Show documentation
RESTCONF server implemented on top of MD-SAL
There is a newer version: 8.0.3
Show newest version
/*
 * Copyright (c) 2024 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 java.util.Objects.requireNonNull;

import org.eclipse.jdt.annotation.NonNullByDefault;
import org.opendaylight.mdsal.dom.api.DOMActionService;
import org.opendaylight.mdsal.dom.api.DOMDataBroker;
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.DOMSchemaService.YangTextSourceExtension;
import org.opendaylight.netconf.dom.api.NetconfDataTreeService;
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.DOMServerStrategy;
import org.opendaylight.restconf.mdsal.spi.data.MdsalRestconfStrategy;
import org.opendaylight.restconf.mdsal.spi.data.NetconfRestconfStrategy;
import org.opendaylight.restconf.server.api.DatabindContext;
import org.opendaylight.restconf.server.api.DatabindPath.Data;
import org.opendaylight.restconf.server.api.ServerErrorPath;
import org.opendaylight.restconf.server.api.ServerException;
import org.opendaylight.restconf.server.spi.ErrorTags;
import org.opendaylight.restconf.server.spi.ExportingServerModulesOperations;
import org.opendaylight.restconf.server.spi.NotSupportedServerActionOperations;
import org.opendaylight.restconf.server.spi.NotSupportedServerDataOperations;
import org.opendaylight.restconf.server.spi.NotSupportedServerMountPointResolver;
import org.opendaylight.restconf.server.spi.NotSupportedServerRpcOperations;
import org.opendaylight.restconf.server.spi.ServerActionOperations;
import org.opendaylight.restconf.server.spi.ServerDataOperations;
import org.opendaylight.restconf.server.spi.ServerMountPointResolver;
import org.opendaylight.restconf.server.spi.ServerRpcOperations;
import org.opendaylight.restconf.server.spi.ServerStrategy;
import org.opendaylight.yangtools.yang.common.ErrorType;

/**
 * A resolver of {@code yang-ext:mount} references based on {@link DOMMountPointService}.
 */
@NonNullByDefault
public record MdsalMountPointResolver(DOMMountPointService mountPointService) implements ServerMountPointResolver {
    public MdsalMountPointResolver {
        requireNonNull(mountPointService);
    }

    @Override
    public ServerStrategy resolveMountPoint(final Data mountPath) throws ServerException {
        final var mountPoint = mountPointService.getMountPoint(mountPath.instance())
            .orElseThrow(() -> new ServerException(ErrorType.PROTOCOL, ErrorTags.RESOURCE_DENIED_TRANSPORT,
                "Mount point does not exist", new ServerErrorPath(mountPath), null));
        final var serverStrategy = mountPoint.getService(DOMServerStrategy.class);
        if (serverStrategy.isPresent()) {
            return serverStrategy.orElseThrow().serverStrategy();
        }

        final var mountSchemaService = mountPoint.getService(DOMSchemaService.class)
            .orElseThrow(() -> new ServerException(ErrorType.PROTOCOL, ErrorTags.RESOURCE_DENIED_TRANSPORT,
                "Mount point does not expose DOMSchemaService", new ServerErrorPath(mountPath), null));
        final var mountModelContext = mountSchemaService.getGlobalContext();
        if (mountModelContext == null) {
            throw new ServerException(ErrorType.PROTOCOL, ErrorTags.RESOURCE_DENIED_TRANSPORT,
                "Mount point does not have any models", new ServerErrorPath(mountPath), null);
        }
        final var sourceExporter = new ExportingServerModulesOperations(mountModelContext);
        final var sourceProvider = mountSchemaService.extension(YangTextSourceExtension.class);
        final var modules = sourceProvider == null ? sourceExporter
            : new DOMServerModulesOperations(sourceProvider, sourceExporter);

        final var mountDatabind = DatabindContext.ofModel(mountModelContext);

        return new MdsalServerStrategy(mountDatabind, mountPointResolverOf(mountPoint), actionOperationsOf(mountPoint),
            dataOperationsOf(mountDatabind, mountPoint), modules, rpcOperationsOf(mountPoint));
    }

    private static ServerActionOperations actionOperationsOf(final DOMMountPoint mountPoint) {
        return mountPoint.getService(DOMActionService.class)
            .map(DOMServerActionOperations::new)
            .orElse(NotSupportedServerActionOperations.INSTANCE);
    }

    private static ServerDataOperations dataOperationsOf(final DatabindContext mountDatabind,
            final DOMMountPoint mountPoint) {
        final var netconfService = mountPoint.getService(NetconfDataTreeService.class);
        if (netconfService.isPresent()) {
            return new NetconfRestconfStrategy(mountDatabind, netconfService.orElseThrow());
        }
        final var dataBroker = mountPoint.getService(DOMDataBroker.class);
        if (dataBroker.isPresent()) {
            return new MdsalRestconfStrategy(mountDatabind, dataBroker.orElseThrow());
        }
        return NotSupportedServerDataOperations.INSTANCE;
    }

    private static ServerMountPointResolver mountPointResolverOf(final DOMMountPoint mountPoint) {
        return mountPoint.getService(DOMMountPointService.class)
            .map(MdsalMountPointResolver::new)
            .orElse(NotSupportedServerMountPointResolver.INSTANCE);
    }

    private static ServerRpcOperations rpcOperationsOf(final DOMMountPoint mountPoint) {
        return mountPoint.getService(DOMRpcService.class)
            .map(DOMServerRpcOperations::new)
            .orElse(NotSupportedServerRpcOperations.INSTANCE);
    }
}