2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.netconf.impl;
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;
21 import org.opendaylight.netconf.mapping.api.NetconfOperationService;
22 import org.opendaylight.netconf.mapping.api.NetconfOperationServiceFactory;
23 import org.opendaylight.netconf.util.messages.NetconfHelloMessage;
24 import org.opendaylight.netconf.api.NetconfDocumentedException;
25 import org.opendaylight.netconf.api.NetconfServerSessionPreferences;
26 import org.opendaylight.netconf.api.monitoring.NetconfMonitoringService;
27 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
28 import org.opendaylight.netconf.impl.osgi.NetconfOperationRouter;
29 import org.opendaylight.netconf.impl.osgi.NetconfOperationRouterImpl;
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;
38 public class NetconfServerSessionNegotiatorFactory implements SessionNegotiatorFactory<NetconfHelloMessage, NetconfServerSession, NetconfServerSessionListener> {
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
46 private final Timer timer;
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;
55 // TODO too many params, refactor
56 public NetconfServerSessionNegotiatorFactory(final Timer timer, final NetconfOperationServiceFactory netconfOperationProvider,
57 final SessionIdProvider idProvider, final long connectionTimeoutMillis,
58 final NetconfMonitoringService monitoringService) {
59 this(timer, netconfOperationProvider, idProvider, connectionTimeoutMillis, monitoringService, DEFAULT_BASE_CAPABILITIES);
62 // TODO too many params, refactor
63 public NetconfServerSessionNegotiatorFactory(final Timer timer, final NetconfOperationServiceFactory netconfOperationProvider,
64 final SessionIdProvider idProvider, final long connectionTimeoutMillis,
65 final NetconfMonitoringService monitoringService, final Set<String> baseCapabilities) {
67 this.aggregatedOpService = netconfOperationProvider;
68 this.idProvider = idProvider;
69 this.connectionTimeoutMillis = connectionTimeoutMillis;
70 this.monitoringService = monitoringService;
71 this.baseCapabilities = validateBaseCapabilities(baseCapabilities);
74 private static ImmutableSet<String> validateBaseCapabilities(final Set<String> baseCapabilities) {
75 // Check base capabilities to be supported by the server
76 final Sets.SetView<String> unknownBaseCaps = Sets.difference(baseCapabilities, DEFAULT_BASE_CAPABILITIES);
77 Preconditions.checkArgument(unknownBaseCaps.isEmpty(),
78 "Base capabilities that will be supported by netconf server have to be subset of %s, unknown base capabilities: %s",
79 DEFAULT_BASE_CAPABILITIES, unknownBaseCaps);
81 final ImmutableSet.Builder<String> b = ImmutableSet.builder();
82 b.addAll(baseCapabilities);
83 // Base 1.0 capability is supported by default
84 b.add(XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0);
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
98 public SessionNegotiator<NetconfServerSession> getSessionNegotiator(final SessionListenerFactory<NetconfServerSessionListener> defunctSessionListenerFactory,
99 final Channel channel, final Promise<NetconfServerSession> promise) {
100 final long sessionId = idProvider.getNextSessionId();
102 NetconfServerSessionPreferences proposal;
104 proposal = new NetconfServerSessionPreferences(createHelloMessage(sessionId, monitoringService), sessionId);
105 } catch (final NetconfDocumentedException e) {
106 LOG.error("Unable to create hello message for session {} with {}", sessionId, monitoringService);
107 throw new IllegalStateException(e);
110 return new NetconfServerSessionNegotiator(proposal, promise, channel, timer,
111 getListener(Long.toString(sessionId), channel.localAddress()), connectionTimeoutMillis);
114 private NetconfServerSessionListener getListener(final String netconfSessionIdForReporting, final SocketAddress socketAddress) {
115 final NetconfOperationService service = getOperationServiceForAddress(netconfSessionIdForReporting, socketAddress);
116 final NetconfOperationRouter operationRouter =
117 new NetconfOperationRouterImpl(service, monitoringService, netconfSessionIdForReporting);
118 return new NetconfServerSessionListener(operationRouter, monitoringService, service);
122 protected NetconfOperationService getOperationServiceForAddress(final String netconfSessionIdForReporting, final SocketAddress socketAddress) {
123 return this.aggregatedOpService.createService(netconfSessionIdForReporting);
126 protected final NetconfOperationServiceFactory getOperationServiceFactory() {
127 return aggregatedOpService;
130 private NetconfHelloMessage createHelloMessage(final long sessionId, final NetconfMonitoringService capabilityProvider) throws NetconfDocumentedException {
131 return NetconfHelloMessage.createServerHello(Sets.union(transformCapabilities(capabilityProvider.getCapabilities()), baseCapabilities), sessionId);
134 public static Set<String> transformCapabilities(final Capabilities capabilities) {
135 return Sets.newHashSet(Collections2.transform(capabilities.getCapability(), new Function<Uri, String>() {
137 public String apply(final Uri uri) {
138 return uri.getValue();