opendaylight/netconf/netconf-impl/src/main/java/org/opendaylight/controller/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.controller.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.util.Set;
  20 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
  21 import org.opendaylight.controller.netconf.api.NetconfServerSessionPreferences;
  22 import org.opendaylight.controller.netconf.api.monitoring.NetconfMonitoringService;
  23 import org.opendaylight.controller.netconf.api.xml.XmlNetconfConstants;
  24 import org.opendaylight.controller.netconf.impl.osgi.NetconfOperationRouter;
  25 import org.opendaylight.controller.netconf.impl.osgi.NetconfOperationRouterImpl;
  26 import org.opendaylight.controller.netconf.mapping.api.NetconfOperationService;
  27 import org.opendaylight.controller.netconf.mapping.api.NetconfOperationServiceFactory;
  28 import org.opendaylight.controller.netconf.util.messages.NetconfHelloMessage;
  29 import org.opendaylight.protocol.framework.SessionListenerFactory;
  30 import org.opendaylight.protocol.framework.SessionNegotiator;
  31 import org.opendaylight.protocol.framework.SessionNegotiatorFactory;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Uri;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Capabilities;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37 public class NetconfServerSessionNegotiatorFactory implements SessionNegotiatorFactory<NetconfHelloMessage, 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     // TODO too many params, refactor
  55     public NetconfServerSessionNegotiatorFactory(final Timer timer, final NetconfOperationServiceFactory netconfOperationProvider,
  56                                                  final SessionIdProvider idProvider, final long connectionTimeoutMillis,
  57                                                  final NetconfMonitoringService monitoringService) {
  58         this(timer, netconfOperationProvider, idProvider, connectionTimeoutMillis, monitoringService, DEFAULT_BASE_CAPABILITIES);
  59     }
  60
  61     // TODO too many params, refactor
  62     public NetconfServerSessionNegotiatorFactory(final Timer timer, final NetconfOperationServiceFactory netconfOperationProvider,
  63                                                  final SessionIdProvider idProvider, final long connectionTimeoutMillis,
  64                                                  final NetconfMonitoringService monitoringService, final Set<String> baseCapabilities) {
  65         this.timer = timer;
  66         this.aggregatedOpService = netconfOperationProvider;
  67         this.idProvider = idProvider;
  68         this.connectionTimeoutMillis = connectionTimeoutMillis;
  69         this.monitoringService = monitoringService;
  70         this.baseCapabilities = validateBaseCapabilities(baseCapabilities);
  71     }
  72
  73     private static ImmutableSet<String> validateBaseCapabilities(final Set<String> baseCapabilities) {
  74         // Check base capabilities to be supported by the server
  75         final Sets.SetView<String> unknownBaseCaps = Sets.difference(baseCapabilities, DEFAULT_BASE_CAPABILITIES);
  76         Preconditions.checkArgument(unknownBaseCaps.isEmpty(),
  77                 "Base capabilities that will be supported by netconf server have to be subset of %s, 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      *
  89      * @param defunctSessionListenerFactory will not be taken into account as session listener factory can
  90      *                                      only be created after snapshot is opened, thus this method constructs
  91      *                                      proper session listener factory.
  92      * @param channel Underlying channel
  93      * @param promise Promise to be notified
  94      * @return session negotiator
  95      */
  96     @Override
  97     public SessionNegotiator<NetconfServerSession> getSessionNegotiator(final SessionListenerFactory<NetconfServerSessionListener> defunctSessionListenerFactory,
  98                                                                         final Channel channel, final Promise<NetconfServerSession> promise) {
  99         final long sessionId = idProvider.getNextSessionId();
 100
 101         NetconfServerSessionPreferences proposal;
 102         try {
 103             proposal = new NetconfServerSessionPreferences(createHelloMessage(sessionId, monitoringService), sessionId);
 104         } catch (final NetconfDocumentedException e) {
 105             LOG.error("Unable to create hello message for session {} with {}", sessionId, monitoringService);
 106             throw new IllegalStateException(e);
 107         }
 108
 109         return new NetconfServerSessionNegotiator(proposal, promise, channel, timer,
 110                 getListener(Long.toString(sessionId)), connectionTimeoutMillis);
 111     }
 112
 113     private NetconfServerSessionListener getListener(final String netconfSessionIdForReporting) {
 114         final NetconfOperationService service =
 115                 this.aggregatedOpService.createService(netconfSessionIdForReporting);
 116         final NetconfOperationRouter operationRouter =
 117                 new NetconfOperationRouterImpl(service, monitoringService, netconfSessionIdForReporting);
 118         return new NetconfServerSessionListener(operationRouter, monitoringService, service);
 119
 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 }