protocol/netconf-server/src/main/java/org/opendaylight/netconf/server/NetconfServerSessionNegotiatorFactory.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.netconf.server;
   9
  10 import com.google.common.collect.ImmutableSet;
  11 import com.google.common.collect.Sets;
  12 import io.netty.channel.Channel;
  13 import io.netty.util.Timer;
  14 import io.netty.util.concurrent.Promise;
  15 import java.net.SocketAddress;
  16 import java.util.Set;
  17 import org.checkerframework.checker.index.qual.NonNegative;
  18 import org.opendaylight.netconf.api.CapabilityURN;
  19 import org.opendaylight.netconf.api.messages.HelloMessage;
  20 import org.opendaylight.netconf.nettyutil.NetconfSessionNegotiator;
  21 import org.opendaylight.netconf.server.api.SessionIdProvider;
  22 import org.opendaylight.netconf.server.api.monitoring.NetconfMonitoringService;
  23 import org.opendaylight.netconf.server.api.operations.NetconfOperationService;
  24 import org.opendaylight.netconf.server.api.operations.NetconfOperationServiceFactory;
  25 import org.opendaylight.netconf.server.osgi.NetconfOperationRouterImpl;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.SessionIdType;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Capabilities;
  29
  30 // non-final for testing and netconf-testtool (for some reason)
  31 public class NetconfServerSessionNegotiatorFactory {
  32     public static final Set<String> DEFAULT_BASE_CAPABILITIES = ImmutableSet.of(
  33         CapabilityURN.BASE,
  34         CapabilityURN.BASE_1_1,
  35         CapabilityURN.EXI,
  36         CapabilityURN.NOTIFICATION);
  37
  38     private final @NonNegative int maximumIncomingChunkSize;
  39     private final Timer timer;
  40     private final SessionIdProvider idProvider;
  41     private final NetconfOperationServiceFactory aggregatedOpService;
  42     private final long connectionTimeoutMillis;
  43     private final NetconfMonitoringService monitoringService;
  44     private final Set<String> baseCapabilities;
  45
  46     // FIXME: 5.0.0: protected
  47     public NetconfServerSessionNegotiatorFactory(final Timer timer,
  48             final NetconfOperationServiceFactory netconfOperationProvider, final SessionIdProvider idProvider,
  49             final long connectionTimeoutMillis, final NetconfMonitoringService monitoringService) {
  50         this(timer, netconfOperationProvider, idProvider, connectionTimeoutMillis, monitoringService, null);
  51     }
  52
  53     // FIXME: 5.0.0: protected
  54     public NetconfServerSessionNegotiatorFactory(final Timer timer,
  55             final NetconfOperationServiceFactory netconfOperationProvider, final SessionIdProvider idProvider,
  56             final long connectionTimeoutMillis,  final NetconfMonitoringService monitoringService,
  57             final Set<String> baseCapabilities) {
  58         this(timer, netconfOperationProvider, idProvider, connectionTimeoutMillis, monitoringService, baseCapabilities,
  59             NetconfSessionNegotiator.DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE);
  60     }
  61
  62     protected NetconfServerSessionNegotiatorFactory(final Timer timer,
  63             final NetconfOperationServiceFactory netconfOperationProvider, final SessionIdProvider idProvider,
  64             final long connectionTimeoutMillis, final NetconfMonitoringService monitoringService,
  65             final Set<String> baseCapabilities, final @NonNegative int maximumIncomingChunkSize) {
  66         this.timer = timer;
  67         aggregatedOpService = netconfOperationProvider;
  68         this.idProvider = idProvider;
  69         this.connectionTimeoutMillis = connectionTimeoutMillis;
  70         this.monitoringService = monitoringService;
  71         this.maximumIncomingChunkSize = maximumIncomingChunkSize;
  72         this.baseCapabilities = validateBaseCapabilities(baseCapabilities == null ? DEFAULT_BASE_CAPABILITIES :
  73                 baseCapabilities);
  74     }
  75
  76     private static ImmutableSet<String> validateBaseCapabilities(final Set<String> baseCapabilities) {
  77         // Check base capabilities to be supported by the server
  78         final var unknownBaseCaps = Sets.difference(baseCapabilities, DEFAULT_BASE_CAPABILITIES);
  79         if (!unknownBaseCaps.isEmpty()) {
  80             throw new IllegalArgumentException(
  81                 "Base capabilities that will be supported by netconf server have to be subset of "
  82                     + DEFAULT_BASE_CAPABILITIES + ", unknown base capabilities: " + unknownBaseCaps);
  83         }
  84
  85         return ImmutableSet.<String>builder()
  86             .addAll(baseCapabilities)
  87             // Base 1.0 capability is supported by default
  88             .add(CapabilityURN.BASE)
  89             .build();
  90     }
  91
  92     /**
  93      * Get session negotiator.
  94      *
  95      * @param channel                       Underlying channel
  96      * @param promise                       Promise to be notified
  97      * @return session negotiator
  98      */
  99     public NetconfServerSessionNegotiator getSessionNegotiator(final Channel channel,
 100             final Promise<NetconfServerSession> promise) {
 101         final var sessionId = idProvider.getNextSessionId();
 102         final var service = getOperationServiceForAddress(sessionId,
 103             channel.parent() == null ? null : channel.parent().localAddress());
 104
 105         return new NetconfServerSessionNegotiator(createHelloMessage(sessionId, monitoringService), sessionId, promise,
 106             channel, timer,
 107             new NetconfServerSessionListener(new NetconfOperationRouterImpl(service, monitoringService, sessionId),
 108                 monitoringService, service),
 109             connectionTimeoutMillis, maximumIncomingChunkSize);
 110     }
 111
 112     protected NetconfOperationService getOperationServiceForAddress(final SessionIdType sessionId,
 113             final SocketAddress socketAddress) {
 114         return aggregatedOpService.createService(sessionId);
 115     }
 116
 117     protected final NetconfOperationServiceFactory getOperationServiceFactory() {
 118         return aggregatedOpService;
 119     }
 120
 121     private HelloMessage createHelloMessage(final SessionIdType sessionId,
 122             final NetconfMonitoringService capabilityProvider) {
 123         return HelloMessage.createServerHello(Sets.union(
 124             transformCapabilities(capabilityProvider.getCapabilities()), baseCapabilities),
 125             sessionId);
 126     }
 127
 128     public static ImmutableSet<String> transformCapabilities(final Capabilities capabilities) {
 129         return capabilities.requireCapability().stream().map(Uri::getValue).collect(ImmutableSet.toImmutableSet());
 130     }
 131 }