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.NetconfSessionListenerFactory;
  21 import org.opendaylight.netconf.api.messages.HelloMessage;
  22 import org.opendaylight.netconf.api.monitoring.NetconfMonitoringService;
  23 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
  24 import org.opendaylight.netconf.mapping.api.NetconfOperationService;
  25 import org.opendaylight.netconf.mapping.api.NetconfOperationServiceFactory;
  26 import org.opendaylight.netconf.nettyutil.AbstractNetconfSessionNegotiator;
  27 import org.opendaylight.netconf.nettyutil.NetconfSessionNegotiatorFactory;
  28 import org.opendaylight.netconf.server.osgi.NetconfOperationRouterImpl;
  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 public class NetconfServerSessionNegotiatorFactory
  33     implements NetconfSessionNegotiatorFactory<NetconfServerSession, NetconfServerSessionListener> {
  34
  35     public static final Set<String> DEFAULT_BASE_CAPABILITIES = ImmutableSet.of(
  36             XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0,
  37             XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_1,
  38             XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_CAPABILITY_EXI_1_0,
  39             XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_CAPABILITY_NOTIFICATION_1_0
  40     );
  41
  42     private final @NonNegative int maximumIncomingChunkSize;
  43     private final Timer timer;
  44     private final SessionIdProvider idProvider;
  45     private final NetconfOperationServiceFactory aggregatedOpService;
  46     private final long connectionTimeoutMillis;
  47     private final NetconfMonitoringService monitoringService;
  48     private final Set<String> baseCapabilities;
  49
  50     // FIXME: 5.0.0: protected
  51     public NetconfServerSessionNegotiatorFactory(final Timer timer,
  52             final NetconfOperationServiceFactory netconfOperationProvider, final SessionIdProvider idProvider,
  53             final long connectionTimeoutMillis, final NetconfMonitoringService monitoringService) {
  54         this(timer, netconfOperationProvider, idProvider, connectionTimeoutMillis, monitoringService, null);
  55     }
  56
  57     // FIXME: 5.0.0: protected
  58     public NetconfServerSessionNegotiatorFactory(final Timer timer,
  59             final NetconfOperationServiceFactory netconfOperationProvider, final SessionIdProvider idProvider,
  60             final long connectionTimeoutMillis,  final NetconfMonitoringService monitoringService,
  61             final Set<String> baseCapabilities) {
  62         this(timer, netconfOperationProvider, idProvider, connectionTimeoutMillis, monitoringService, baseCapabilities,
  63             AbstractNetconfSessionNegotiator.DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE);
  64     }
  65
  66     protected NetconfServerSessionNegotiatorFactory(final Timer timer,
  67             final NetconfOperationServiceFactory netconfOperationProvider, final SessionIdProvider idProvider,
  68             final long connectionTimeoutMillis, final NetconfMonitoringService monitoringService,
  69             final Set<String> baseCapabilities, final @NonNegative int maximumIncomingChunkSize) {
  70         this.timer = timer;
  71         aggregatedOpService = netconfOperationProvider;
  72         this.idProvider = idProvider;
  73         this.connectionTimeoutMillis = connectionTimeoutMillis;
  74         this.monitoringService = monitoringService;
  75         this.maximumIncomingChunkSize = maximumIncomingChunkSize;
  76         this.baseCapabilities = validateBaseCapabilities(baseCapabilities == null ? DEFAULT_BASE_CAPABILITIES :
  77                 baseCapabilities);
  78     }
  79
  80     private static ImmutableSet<String> validateBaseCapabilities(final Set<String> baseCapabilities) {
  81         // Check base capabilities to be supported by the server
  82         final Sets.SetView<String> unknownBaseCaps = Sets.difference(baseCapabilities, DEFAULT_BASE_CAPABILITIES);
  83         Preconditions.checkArgument(unknownBaseCaps.isEmpty(),
  84                 "Base capabilities that will be supported by netconf server have to be subset of %s, "
  85                         + "unknown base capabilities: %s",
  86                 DEFAULT_BASE_CAPABILITIES, unknownBaseCaps);
  87
  88         final ImmutableSet.Builder<String> b = ImmutableSet.builder();
  89         b.addAll(baseCapabilities);
  90         // Base 1.0 capability is supported by default
  91         b.add(XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0);
  92         return b.build();
  93     }
  94
  95     /**
  96      * Get session negotiator.
  97      *
  98      * @param defunctSessionListenerFactory will not be taken into account as session listener factory can
  99      *                                      only be created after snapshot is opened, thus this method constructs
 100      *                                      proper session listener factory.
 101      * @param channel                       Underlying channel
 102      * @param promise                       Promise to be notified
 103      * @return session negotiator
 104      */
 105     @Override
 106     public NetconfServerSessionNegotiator getSessionNegotiator(
 107             final NetconfSessionListenerFactory<NetconfServerSessionListener> defunctSessionListenerFactory,
 108             final Channel channel, final Promise<NetconfServerSession> promise) {
 109         final long sessionId = idProvider.getNextSessionId();
 110
 111         return new NetconfServerSessionNegotiator(createHelloMessage(sessionId, monitoringService), sessionId, promise,
 112             channel, timer, getListener(Long.toString(sessionId), channel.parent().localAddress()),
 113             connectionTimeoutMillis, maximumIncomingChunkSize);
 114     }
 115
 116     private NetconfServerSessionListener getListener(final String netconfSessionIdForReporting,
 117                                                      final SocketAddress socketAddress) {
 118         final var service = getOperationServiceForAddress(netconfSessionIdForReporting, socketAddress);
 119         return new NetconfServerSessionListener(
 120             new NetconfOperationRouterImpl(service, monitoringService, netconfSessionIdForReporting), monitoringService,
 121             service);
 122     }
 123
 124     protected NetconfOperationService getOperationServiceForAddress(final String netconfSessionIdForReporting,
 125                                                                     final SocketAddress socketAddress) {
 126         return aggregatedOpService.createService(netconfSessionIdForReporting);
 127     }
 128
 129     protected final NetconfOperationServiceFactory getOperationServiceFactory() {
 130         return aggregatedOpService;
 131     }
 132
 133     private HelloMessage createHelloMessage(final long sessionId, final NetconfMonitoringService capabilityProvider) {
 134         return HelloMessage.createServerHello(Sets.union(
 135             transformCapabilities(capabilityProvider.getCapabilities()), baseCapabilities),
 136             sessionId);
 137     }
 138
 139     public static Set<String> transformCapabilities(final Capabilities capabilities) {
 140         return Sets.newHashSet(Collections2.transform(capabilities.getCapability(), Uri::getValue));
 141     }
 142 }