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