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