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