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.Preconditions;
  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.controller.netconf.api.NetconfDocumentedException;
  20 import org.opendaylight.controller.netconf.api.NetconfServerSessionPreferences;
  21 import org.opendaylight.controller.netconf.api.monitoring.NetconfMonitoringService;
  22 import org.opendaylight.controller.netconf.api.xml.XmlNetconfConstants;
  23 import org.opendaylight.controller.netconf.impl.mapping.operations.DefaultCommit;
  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.slf4j.Logger;
  33 import org.slf4j.LoggerFactory;
  34
  35 public class NetconfServerSessionNegotiatorFactory implements SessionNegotiatorFactory<NetconfHelloMessage, 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 CommitNotifier commitNotificationProducer;
  49     private final NetconfMonitoringService monitoringService;
  50     private static final Logger LOG = LoggerFactory.getLogger(NetconfServerSessionNegotiatorFactory.class);
  51     private final Set<String> baseCapabilities;
  52
  53     // TODO too many params, refactor
  54     public NetconfServerSessionNegotiatorFactory(final Timer timer, final NetconfOperationServiceFactory netconfOperationProvider,
  55                                                  final SessionIdProvider idProvider, final long connectionTimeoutMillis,
  56                                                  final CommitNotifier commitNot,
  57                                                  final NetconfMonitoringService monitoringService) {
  58         this(timer, netconfOperationProvider, idProvider, connectionTimeoutMillis, commitNot, 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 CommitNotifier commitNot,
  65                                                  final NetconfMonitoringService monitoringService, final Set<String> baseCapabilities) {
  66         this.timer = timer;
  67         this.aggregatedOpService = netconfOperationProvider;
  68         this.idProvider = idProvider;
  69         this.connectionTimeoutMillis = connectionTimeoutMillis;
  70         this.commitNotificationProducer = commitNot;
  71         this.monitoringService = monitoringService;
  72         this.baseCapabilities = validateBaseCapabilities(baseCapabilities);
  73     }
  74
  75     private static ImmutableSet<String> validateBaseCapabilities(final Set<String> baseCapabilities) {
  76         // Check base capabilities to be supported by the server
  77         final Sets.SetView<String> unknownBaseCaps = Sets.difference(baseCapabilities, DEFAULT_BASE_CAPABILITIES);
  78         Preconditions.checkArgument(unknownBaseCaps.isEmpty(),
  79                 "Base capabilities that will be supported by netconf server have to be subset of %s, unknown base capabilities: %s",
  80                 DEFAULT_BASE_CAPABILITIES, unknownBaseCaps);
  81
  82         final ImmutableSet.Builder<String> b = ImmutableSet.builder();
  83         b.addAll(baseCapabilities);
  84         // Base 1.0 capability is supported by default
  85         b.add(XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0);
  86         return b.build();
  87     }
  88
  89     /**
  90      *
  91      * @param defunctSessionListenerFactory will not be taken into account as session listener factory can
  92      *                                      only be created after snapshot is opened, thus this method constructs
  93      *                                      proper session listener factory.
  94      * @param channel Underlying channel
  95      * @param promise Promise to be notified
  96      * @return session negotiator
  97      */
  98     @Override
  99     public SessionNegotiator<NetconfServerSession> getSessionNegotiator(final SessionListenerFactory<NetconfServerSessionListener> defunctSessionListenerFactory,
 100                                                                         final Channel channel, final Promise<NetconfServerSession> promise) {
 101         final long sessionId = idProvider.getNextSessionId();
 102
 103         NetconfServerSessionPreferences proposal;
 104         try {
 105             proposal = new NetconfServerSessionPreferences(createHelloMessage(sessionId, monitoringService), sessionId);
 106         } catch (final NetconfDocumentedException e) {
 107             LOG.error("Unable to create hello message for session {} with {}", sessionId, monitoringService);
 108             throw new IllegalStateException(e);
 109         }
 110
 111         return new NetconfServerSessionNegotiator(proposal, promise, channel, timer,
 112                 getListener(Long.toString(sessionId), channel.localAddress()), connectionTimeoutMillis);
 113     }
 114
 115     private NetconfServerSessionListener getListener(final String netconfSessionIdForReporting, final SocketAddress socketAddress) {
 116         final NetconfOperationService service = getOperationServiceForAddress(netconfSessionIdForReporting, socketAddress);
 117         final NetconfOperationRouter operationRouter =
 118                 new NetconfOperationRouterImpl(service, commitNotificationProducer, monitoringService, netconfSessionIdForReporting);
 119         return new NetconfServerSessionListener(operationRouter, monitoringService, service);
 120
 121     }
 122
 123     protected NetconfOperationService getOperationServiceForAddress(final String netconfSessionIdForReporting, final SocketAddress socketAddress) {
 124         return this.aggregatedOpService.createService(netconfSessionIdForReporting);
 125     }
 126
 127     protected final NetconfOperationServiceFactory getOperationServiceFactory() {
 128         return aggregatedOpService;
 129     }
 130
 131     private NetconfHelloMessage createHelloMessage(final long sessionId, final NetconfMonitoringService capabilityProvider) throws NetconfDocumentedException {
 132         return NetconfHelloMessage.createServerHello(Sets.union(DefaultCommit.transformCapabilities(capabilityProvider.getCapabilities()), baseCapabilities), sessionId);
 133     }
 134
 135 }