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