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