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.base.Preconditions;
  11 import com.google.common.collect.Collections2;
  12 import com.google.common.collect.ImmutableSet;
  13 import com.google.common.collect.Sets;
  14 import io.netty.channel.Channel;
  15 import io.netty.util.Timer;
  16 import io.netty.util.concurrent.Promise;
  17 import java.net.SocketAddress;
  18 import java.util.Set;
  19 import org.checkerframework.checker.index.qual.NonNegative;
  20 import org.opendaylight.netconf.api.CapabilityURN;
  21 import org.opendaylight.netconf.api.messages.HelloMessage;
  22 import org.opendaylight.netconf.nettyutil.NetconfSessionNegotiator;
  23 import org.opendaylight.netconf.server.api.SessionIdProvider;
  24 import org.opendaylight.netconf.server.api.monitoring.NetconfMonitoringService;
  25 import org.opendaylight.netconf.server.api.operations.NetconfOperationService;
  26 import org.opendaylight.netconf.server.api.operations.NetconfOperationServiceFactory;
  27 import org.opendaylight.netconf.server.osgi.NetconfOperationRouterImpl;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.SessionIdType;
  29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Capabilities;
  31
  32 // non-final for testing and netconf-testtool (for some reason)
  33 public class NetconfServerSessionNegotiatorFactory {
  34     public static final Set<String> DEFAULT_BASE_CAPABILITIES = ImmutableSet.of(
  35         CapabilityURN.BASE,
  36         CapabilityURN.BASE_1_1,
  37         CapabilityURN.EXI,
  38         CapabilityURN.NOTIFICATION);
  39
  40     private final @NonNegative int maximumIncomingChunkSize;
  41     private final Timer timer;
  42     private final SessionIdProvider idProvider;
  43     private final NetconfOperationServiceFactory aggregatedOpService;
  44     private final long connectionTimeoutMillis;
  45     private final NetconfMonitoringService monitoringService;
  46     private final Set<String> baseCapabilities;
  47
  48     // FIXME: 5.0.0: protected
  49     public NetconfServerSessionNegotiatorFactory(final Timer timer,
  50             final NetconfOperationServiceFactory netconfOperationProvider, final SessionIdProvider idProvider,
  51             final long connectionTimeoutMillis, final NetconfMonitoringService monitoringService) {
  52         this(timer, netconfOperationProvider, idProvider, connectionTimeoutMillis, monitoringService, null);
  53     }
  54
  55     // FIXME: 5.0.0: protected
  56     public NetconfServerSessionNegotiatorFactory(final Timer timer,
  57             final NetconfOperationServiceFactory netconfOperationProvider, final SessionIdProvider idProvider,
  58             final long connectionTimeoutMillis,  final NetconfMonitoringService monitoringService,
  59             final Set<String> baseCapabilities) {
  60         this(timer, netconfOperationProvider, idProvider, connectionTimeoutMillis, monitoringService, baseCapabilities,
  61             NetconfSessionNegotiator.DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE);
  62     }
  63
  64     protected NetconfServerSessionNegotiatorFactory(final Timer timer,
  65             final NetconfOperationServiceFactory netconfOperationProvider, final SessionIdProvider idProvider,
  66             final long connectionTimeoutMillis, final NetconfMonitoringService monitoringService,
  67             final Set<String> baseCapabilities, final @NonNegative int maximumIncomingChunkSize) {
  68         this.timer = timer;
  69         aggregatedOpService = netconfOperationProvider;
  70         this.idProvider = idProvider;
  71         this.connectionTimeoutMillis = connectionTimeoutMillis;
  72         this.monitoringService = monitoringService;
  73         this.maximumIncomingChunkSize = maximumIncomingChunkSize;
  74         this.baseCapabilities = validateBaseCapabilities(baseCapabilities == null ? DEFAULT_BASE_CAPABILITIES :
  75                 baseCapabilities);
  76     }
  77
  78     private static ImmutableSet<String> validateBaseCapabilities(final Set<String> baseCapabilities) {
  79         // Check base capabilities to be supported by the server
  80         final var unknownBaseCaps = Sets.difference(baseCapabilities, DEFAULT_BASE_CAPABILITIES);
  81         Preconditions.checkArgument(unknownBaseCaps.isEmpty(),
  82                 "Base capabilities that will be supported by netconf server have to be subset of %s, "
  83                         + "unknown base capabilities: %s",
  84                 DEFAULT_BASE_CAPABILITIES, unknownBaseCaps);
  85
  86         return ImmutableSet.<String>builder()
  87             .addAll(baseCapabilities)
  88             // Base 1.0 capability is supported by default
  89             .add(CapabilityURN.BASE)
  90             .build();
  91     }
  92
  93     /**
  94      * Get session negotiator.
  95      *
  96      * @param channel                       Underlying channel
  97      * @param promise                       Promise to be notified
  98      * @return session negotiator
  99      */
 100     public NetconfServerSessionNegotiator getSessionNegotiator(final Channel channel,
 101             final Promise<NetconfServerSession> promise) {
 102         final var sessionId = idProvider.getNextSessionId();
 103         final var socketAddress = channel.parent() == null ? null : channel.parent().localAddress();
 104         final var service = getOperationServiceForAddress(sessionId, socketAddress);
 105         final var listener = new NetconfServerSessionListener(
 106             new NetconfOperationRouterImpl(service, monitoringService, sessionId), monitoringService, service);
 107
 108         return new NetconfServerSessionNegotiator(createHelloMessage(sessionId, monitoringService), sessionId, promise,
 109             channel, timer, listener, 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 Set<String> transformCapabilities(final Capabilities capabilities) {
 129         return Sets.newHashSet(Collections2.transform(capabilities.getCapability(), Uri::getValue));
 130     }
 131 }