All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.opendaylight.restconf.nb.rfc8040.OSGiNorthbound Maven / Gradle / Ivy

Go to download

RESTCONF Northbound application

The newest version!
/*
 * 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.nb.rfc8040;

import static java.util.Objects.requireNonNull;

import java.net.URI;
import java.util.Map;
import org.opendaylight.netconf.transport.http.ConfigUtils;
import org.opendaylight.restconf.api.query.PrettyPrintParam;
import org.opendaylight.restconf.server.NettyEndpoint;
import org.opendaylight.restconf.server.NettyEndpointConfiguration;
import org.opendaylight.restconf.server.jaxrs.JaxRsEndpoint;
import org.opendaylight.restconf.server.jaxrs.JaxRsEndpointConfiguration;
import org.opendaylight.restconf.server.spi.EndpointConfiguration;
import org.opendaylight.restconf.server.spi.ErrorTagMapping;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.http.server.rev240208.http.server.stack.grouping.Transport;
import org.opendaylight.yangtools.yang.common.Uint16;
import org.opendaylight.yangtools.yang.common.Uint32;
import org.osgi.framework.FrameworkUtil;
import org.osgi.service.component.ComponentFactory;
import org.osgi.service.component.ComponentInstance;
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.Modified;
import org.osgi.service.component.annotations.Reference;
import org.osgi.service.metatype.annotations.AttributeDefinition;
import org.osgi.service.metatype.annotations.Designate;
import org.osgi.service.metatype.annotations.ObjectClassDefinition;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Component managing global RESTCONF northbound configuration.
 */
@Component(service = { }, configurationPid = "org.opendaylight.restconf.nb.rfc8040")
@Designate(ocd = OSGiNorthbound.Configuration.class)
public final class OSGiNorthbound {
    @ObjectClassDefinition
    public @interface Configuration {
        // Note: these are mirrored in EndpointConfiguration

        @AttributeDefinition(
            name = "default pretty-print",
            description = "Control the default value of the '" + PrettyPrintParam.uriName + "' query parameter.")
        boolean pretty$_$print() default false;

        @AttributeDefinition(
            name = "Report 404 on data-missing",
            description = """
                Control the HTTP status code reporting of conditions corresponding to "data-missing". When this is set
                to true, the server will violate RFC8040 and report "404" instead of "409".

                For details and reasoning see https://www.rfc-editor.org/errata/eid5565 and
                https://mailarchive.ietf.org/arch/browse/netconf/?gbt=1&index=XcF9r3ek3LvZ4DjF-7_B8kxuiwA""")
        boolean data$_$missing$_$is$_$404() default false;

        @AttributeDefinition(min = "0", max = "" + EndpointConfiguration.SSE_MAXIMUM_FRAGMENT_LENGTH_MAX)
        int maximum$_$fragment$_$length() default 0;

        @AttributeDefinition(min = "0")
        int heartbeat$_$interval() default 10000;

        // Note: these are mirrored in JaxRsEndpointConfiguration

        @AttributeDefinition(name = "{+restconf}", description = """
            The value of RFC8040 {+restconf} URI template, pointing to the root resource. Must not end with '/'.""")
        String restconf() default "rests";

        @AttributeDefinition(min = "1")
        String ping$_$executor$_$name$_$prefix() default JaxRsEndpointConfiguration.DEFAULT_NAME_PREFIX;

        // FIXME: this is a misnomer: it specifies the core pool size, i.e. minimum thread count, the maximum is set to
        //        Integer.MAX_VALUE, which is not what we want
        @AttributeDefinition(min = "0")
        int max$_$thread$_$count() default JaxRsEndpointConfiguration.DEFAULT_CORE_POOL_SIZE;

        // Note: below (+restconf above) are used in NettyEndpointConfiguration

        @AttributeDefinition(description = "The hostname to be used for URLs constructed on server side")
        String host$_$name() default "localhost";

        @AttributeDefinition
        String bind$_$address() default "0.0.0.0";

        @AttributeDefinition(min = "1", max = "65535")
        int bind$_$port() default 8182;

        @AttributeDefinition(description = "Thread name prefix to be used by Netty's thread executor")
        String group$_$name() default "restconf-server";

        @AttributeDefinition(min = "0", description = "Netty's thread limit. 0 means no limits.")
        int group$_$threads() default 0;

        @AttributeDefinition(description = "Default encoding for outgoing messages. Expected 'xml' or 'json'.")
        String default$_$encoding() default "json";

        @AttributeDefinition(description = "Path to certificate file")
        String tls$_$certificate() default "";

        @AttributeDefinition(description = "Path to private key file")
        String tls$_$private$_$key() default "";
    }

    private static final Logger LOG = LoggerFactory.getLogger(OSGiNorthbound.class);

    private final ComponentFactory jaxrsFactory;
    private final ComponentFactory nettyEndpointFactory;

    private ComponentInstance jaxrs;
    private ComponentInstance nettyEndpoint;
    private Map jaxrsProps;
    private Map nettyEndpointProps;

    @Activate
    public OSGiNorthbound(
            @Reference(target = "(component.factory=" + JaxRsEndpoint.FACTORY_NAME + ")")
            final ComponentFactory jaxrsFactory,
            @Reference(target = "(component.factory=" + NettyEndpoint.FACTORY_NAME + ")")
            final ComponentFactory nettyEndpointFactory,
            final Configuration configuration) {
        this.jaxrsFactory = requireNonNull(jaxrsFactory);
        jaxrsProps = newJaxrsProps(configuration);
        jaxrs = jaxrsFactory.newInstance(FrameworkUtil.asDictionary(jaxrsProps));

        this.nettyEndpointFactory = requireNonNull(nettyEndpointFactory);
        nettyEndpointProps = newNettyEndpointProps(configuration);
        nettyEndpoint = nettyEndpointFactory.newInstance(FrameworkUtil.asDictionary(nettyEndpointProps));

        LOG.info("Global RESTCONF northbound pools started");
    }

    @Modified
    void modified(final Configuration configuration) {
        final var newJaxRsProps = newJaxrsProps(configuration);
        if (!newJaxRsProps.equals(jaxrsProps)) {
            jaxrs.dispose();
            jaxrsProps = newJaxRsProps;
            jaxrs = jaxrsFactory.newInstance(FrameworkUtil.asDictionary(jaxrsProps));
            LOG.debug("JAX-RS northbound restarted with {}", jaxrsProps);
        }
        final var newNettyEndpointProps = newNettyEndpointProps(configuration);
        if (!newNettyEndpointProps.equals(nettyEndpointProps)) {
            nettyEndpoint.dispose();
            nettyEndpointProps = newNettyEndpointProps;
            nettyEndpoint = nettyEndpointFactory.newInstance(FrameworkUtil.asDictionary(nettyEndpointProps));
            LOG.debug("Netty northbound restarted with {}", nettyEndpointProps);
        }
        LOG.debug("Applied {}", configuration);
    }

    @Deactivate
    void deactivate() {
        jaxrs.dispose();
        jaxrs = null;
        nettyEndpoint.dispose();
        nettyEndpoint = null;
        LOG.info("Global RESTCONF northbound pools stopped");
    }

    private static Map newJaxrsProps(final Configuration configuration) {
        return JaxRsEndpoint.props(new JaxRsEndpointConfiguration(
            configuration.data$_$missing$_$is$_$404() ? ErrorTagMapping.ERRATA_5565 : ErrorTagMapping.RFC8040,
            PrettyPrintParam.of(configuration.pretty$_$print()),
            Uint16.valueOf(configuration.maximum$_$fragment$_$length()),
            Uint32.valueOf(configuration.heartbeat$_$interval()), configuration.restconf(),
            configuration.ping$_$executor$_$name$_$prefix(), configuration.max$_$thread$_$count()));
    }

    private static Map newNettyEndpointProps(final Configuration configuration) {
        // FIXME: do not start the endpoint if we fail to read the files (i.e. secure-on-failure)!
        // TODO: why are we even using separate files here?
        final var tlsCertKey = TlsUtils.readCertificateKey(configuration.tls$_$certificate(),
            configuration.tls$_$private$_$key());

        final Transport transport;
        final String scheme;
        if (tlsCertKey != null) {
            scheme = "https";
            transport = ConfigUtils.serverTransportTls(configuration.bind$_$address(), configuration.bind$_$port(),
                tlsCertKey.certificate(), tlsCertKey.privateKey());
        } else {
            scheme = "http";
            transport = ConfigUtils.serverTransportTcp(configuration.bind$_$address(), configuration.bind$_$port());
        }

        // FIXME: use seven-argument URI constructor instead, which correctly handles IPv6 addresses
        final var baseUri = URI.create("%s://%s:%d/%s".formatted(scheme, configuration.host$_$name(),
            configuration.bind$_$port(), configuration.restconf()));
        return NettyEndpoint.props(
            new NettyEndpointConfiguration(
                configuration.data$_$missing$_$is$_$404() ? ErrorTagMapping.ERRATA_5565 : ErrorTagMapping.RFC8040,
                PrettyPrintParam.of(configuration.pretty$_$print()),
                Uint16.valueOf(configuration.maximum$_$fragment$_$length()),
                Uint32.valueOf(configuration.heartbeat$_$interval()),
                baseUri,
                configuration.group$_$name(),
                configuration.group$_$threads(),
                NettyEndpointConfiguration.Encoding.from(configuration.default$_$encoding()),
                new HttpServerStackConfiguration(transport))
        );
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy