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
8 package org.opendaylight.netconf.impl;
10 import com.google.common.base.Preconditions;
11 import com.google.common.collect.Collections2;
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;
19 import org.opendaylight.netconf.api.NetconfServerSessionPreferences;
20 import org.opendaylight.netconf.api.NetconfSessionListenerFactory;
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.netconf.nettyutil.NetconfSessionNegotiatorFactory;
29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Capabilities;
32 public class NetconfServerSessionNegotiatorFactory
33 implements NetconfSessionNegotiatorFactory<NetconfServerSession, NetconfServerSessionListener> {
35 public static final Set<String> DEFAULT_BASE_CAPABILITIES = ImmutableSet.of(
36 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0,
37 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_1,
38 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_CAPABILITY_EXI_1_0,
39 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_CAPABILITY_NOTIFICATION_1_0
42 private final Timer timer;
44 private final SessionIdProvider idProvider;
45 private final NetconfOperationServiceFactory aggregatedOpService;
46 private final long connectionTimeoutMillis;
47 private final NetconfMonitoringService monitoringService;
48 private final Set<String> baseCapabilities;
50 public NetconfServerSessionNegotiatorFactory(final Timer timer,
51 final NetconfOperationServiceFactory netconfOperationProvider,
52 final SessionIdProvider idProvider, final long connectionTimeoutMillis,
53 final NetconfMonitoringService monitoringService) {
54 this(timer, netconfOperationProvider, idProvider, connectionTimeoutMillis, monitoringService, null);
57 public NetconfServerSessionNegotiatorFactory(final Timer timer,
58 final NetconfOperationServiceFactory netconfOperationProvider,
59 final SessionIdProvider idProvider, final long connectionTimeoutMillis,
60 final NetconfMonitoringService monitoringService,
61 final Set<String> baseCapabilities) {
63 this.aggregatedOpService = netconfOperationProvider;
64 this.idProvider = idProvider;
65 this.connectionTimeoutMillis = connectionTimeoutMillis;
66 this.monitoringService = monitoringService;
67 this.baseCapabilities = validateBaseCapabilities(baseCapabilities == null ? DEFAULT_BASE_CAPABILITIES :
71 private static ImmutableSet<String> validateBaseCapabilities(final Set<String> baseCapabilities) {
72 // Check base capabilities to be supported by the server
73 final Sets.SetView<String> unknownBaseCaps = Sets.difference(baseCapabilities, DEFAULT_BASE_CAPABILITIES);
74 Preconditions.checkArgument(unknownBaseCaps.isEmpty(),
75 "Base capabilities that will be supported by netconf server have to be subset of %s, "
76 + "unknown base capabilities: %s",
77 DEFAULT_BASE_CAPABILITIES, unknownBaseCaps);
79 final ImmutableSet.Builder<String> b = ImmutableSet.builder();
80 b.addAll(baseCapabilities);
81 // Base 1.0 capability is supported by default
82 b.add(XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0);
87 * Get session negotiator.
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
97 public NetconfServerSessionNegotiator getSessionNegotiator(
98 final NetconfSessionListenerFactory<NetconfServerSessionListener> defunctSessionListenerFactory,
99 final Channel channel, final Promise<NetconfServerSession> promise) {
100 final long sessionId = idProvider.getNextSessionId();
102 NetconfServerSessionPreferences proposal =
103 new NetconfServerSessionPreferences(createHelloMessage(sessionId, monitoringService), sessionId);
105 return new NetconfServerSessionNegotiator(proposal, promise, channel, timer,
106 getListener(Long.toString(sessionId), channel.parent().localAddress()), connectionTimeoutMillis);
109 private NetconfServerSessionListener getListener(final String netconfSessionIdForReporting,
110 final SocketAddress socketAddress) {
111 final NetconfOperationService service = getOperationServiceForAddress(netconfSessionIdForReporting,
113 final NetconfOperationRouter operationRouter =
114 new NetconfOperationRouterImpl(service, monitoringService, netconfSessionIdForReporting);
115 return new NetconfServerSessionListener(operationRouter, monitoringService, service);
118 protected NetconfOperationService getOperationServiceForAddress(final String netconfSessionIdForReporting,
119 final SocketAddress socketAddress) {
120 return this.aggregatedOpService.createService(netconfSessionIdForReporting);
123 protected final NetconfOperationServiceFactory getOperationServiceFactory() {
124 return aggregatedOpService;
127 private NetconfHelloMessage createHelloMessage(
128 final long sessionId, final NetconfMonitoringService capabilityProvider) {
129 return NetconfHelloMessage.createServerHello(Sets.union(transformCapabilities(capabilityProvider
130 .getCapabilities()), baseCapabilities), sessionId);
133 public static Set<String> transformCapabilities(final Capabilities capabilities) {
134 return Sets.newHashSet(Collections2.transform(capabilities.getCapability(), Uri::getValue));