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.Preconditions;
12 import com.google.common.collect.Collections2;
13 import com.google.common.collect.ImmutableSet;
14 import com.google.common.collect.Sets;
15 import io.netty.channel.Channel;
16 import io.netty.util.Timer;
17 import io.netty.util.concurrent.Promise;
18 import java.net.SocketAddress;
20 import org.opendaylight.netconf.api.NetconfDocumentedException;
21 import org.opendaylight.netconf.api.NetconfServerSessionPreferences;
22 import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
23 import org.opendaylight.netconf.api.monitoring.NetconfMonitoringService;
24 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
25 import org.opendaylight.netconf.impl.osgi.NetconfOperationRouter;
26 import org.opendaylight.netconf.impl.osgi.NetconfOperationRouterImpl;
27 import org.opendaylight.netconf.mapping.api.NetconfOperationService;
28 import org.opendaylight.netconf.mapping.api.NetconfOperationServiceFactory;
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.rev130715.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;
37 public class NetconfServerSessionNegotiatorFactory implements SessionNegotiatorFactory<NetconfHelloMessage,
38 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 public NetconfServerSessionNegotiatorFactory(final Timer timer,
56 final NetconfOperationServiceFactory netconfOperationProvider,
57 final SessionIdProvider idProvider, final long connectionTimeoutMillis,
58 final NetconfMonitoringService monitoringService,
59 final Set<String> baseCapabilities) {
61 this.aggregatedOpService = netconfOperationProvider;
62 this.idProvider = idProvider;
63 this.connectionTimeoutMillis = connectionTimeoutMillis;
64 this.monitoringService = monitoringService;
65 this.baseCapabilities = validateBaseCapabilities(baseCapabilities == null ? DEFAULT_BASE_CAPABILITIES :
70 private static ImmutableSet<String> validateBaseCapabilities(final Set<String> baseCapabilities) {
71 // Check base capabilities to be supported by the server
72 final Sets.SetView<String> unknownBaseCaps = Sets.difference(baseCapabilities, DEFAULT_BASE_CAPABILITIES);
73 Preconditions.checkArgument(unknownBaseCaps.isEmpty(),
74 "Base capabilities that will be supported by netconf server have to be subset of %s, "
75 + "unknown base capabilities: %s",
76 DEFAULT_BASE_CAPABILITIES, unknownBaseCaps);
78 final ImmutableSet.Builder<String> b = ImmutableSet.builder();
79 b.addAll(baseCapabilities);
80 // Base 1.0 capability is supported by default
81 b.add(XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0);
86 * Get session negotiator.
88 * @param defunctSessionListenerFactory will not be taken into account as session listener factory can
89 * only be created after snapshot is opened, thus this method constructs
90 * proper session listener factory.
91 * @param channel Underlying channel
92 * @param promise Promise to be notified
93 * @return session negotiator
96 public SessionNegotiator<NetconfServerSession> getSessionNegotiator(
97 final SessionListenerFactory<NetconfServerSessionListener> defunctSessionListenerFactory,
98 final Channel channel, final Promise<NetconfServerSession> promise) {
99 final long sessionId = idProvider.getNextSessionId();
101 NetconfServerSessionPreferences proposal;
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);
109 return new NetconfServerSessionNegotiator(proposal, promise, channel, timer,
110 getListener(Long.toString(sessionId), channel.parent().localAddress()), connectionTimeoutMillis);
113 private NetconfServerSessionListener getListener(final String netconfSessionIdForReporting,
114 final SocketAddress socketAddress) {
115 final NetconfOperationService service = getOperationServiceForAddress(netconfSessionIdForReporting,
117 final NetconfOperationRouter operationRouter =
118 new NetconfOperationRouterImpl(service, monitoringService, netconfSessionIdForReporting);
119 return new NetconfServerSessionListener(operationRouter, monitoringService, service);
123 protected NetconfOperationService getOperationServiceForAddress(final String netconfSessionIdForReporting,
124 final SocketAddress socketAddress) {
125 return this.aggregatedOpService.createService(netconfSessionIdForReporting);
128 protected final NetconfOperationServiceFactory getOperationServiceFactory() {
129 return aggregatedOpService;
132 private NetconfHelloMessage createHelloMessage(
133 final long sessionId, final NetconfMonitoringService capabilityProvider) throws NetconfDocumentedException {
134 return NetconfHelloMessage.createServerHello(Sets.union(transformCapabilities(capabilityProvider
135 .getCapabilities()), baseCapabilities), sessionId);
138 public static Set<String> transformCapabilities(final Capabilities capabilities) {
139 return Sets.newHashSet(Collections2.transform(capabilities.getCapability(), Uri::getValue));