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.controller.netconf.impl;
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;
18 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
19 import org.opendaylight.controller.netconf.api.NetconfServerSessionPreferences;
20 import org.opendaylight.controller.netconf.api.monitoring.NetconfMonitoringService;
21 import org.opendaylight.controller.netconf.api.xml.XmlNetconfConstants;
22 import org.opendaylight.controller.netconf.impl.mapping.operations.DefaultCommit;
23 import org.opendaylight.controller.netconf.impl.osgi.NetconfOperationRouter;
24 import org.opendaylight.controller.netconf.impl.osgi.NetconfOperationRouterImpl;
25 import org.opendaylight.controller.netconf.mapping.api.NetconfOperationService;
26 import org.opendaylight.controller.netconf.mapping.api.NetconfOperationServiceFactory;
27 import org.opendaylight.controller.netconf.util.messages.NetconfHelloMessage;
28 import org.opendaylight.protocol.framework.SessionListenerFactory;
29 import org.opendaylight.protocol.framework.SessionNegotiator;
30 import org.opendaylight.protocol.framework.SessionNegotiatorFactory;
31 import org.slf4j.Logger;
32 import org.slf4j.LoggerFactory;
34 public class NetconfServerSessionNegotiatorFactory implements SessionNegotiatorFactory<NetconfHelloMessage, NetconfServerSession, NetconfServerSessionListener> {
36 public static final Set<String> DEFAULT_BASE_CAPABILITIES = ImmutableSet.of(
37 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0,
38 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_1,
39 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_CAPABILITY_EXI_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 CommitNotifier commitNotificationProducer;
48 private final NetconfMonitoringService monitoringService;
49 private static final Logger LOG = LoggerFactory.getLogger(NetconfServerSessionNegotiatorFactory.class);
50 private final Set<String> baseCapabilities;
52 // TODO too many params, refactor
53 public NetconfServerSessionNegotiatorFactory(final Timer timer, final NetconfOperationServiceFactory netconfOperationProvider,
54 final SessionIdProvider idProvider, final long connectionTimeoutMillis,
55 final CommitNotifier commitNot,
56 final NetconfMonitoringService monitoringService) {
57 this(timer, netconfOperationProvider, idProvider, connectionTimeoutMillis, commitNot, monitoringService, DEFAULT_BASE_CAPABILITIES);
60 // TODO too many params, refactor
61 public NetconfServerSessionNegotiatorFactory(final Timer timer, final NetconfOperationServiceFactory netconfOperationProvider,
62 final SessionIdProvider idProvider, final long connectionTimeoutMillis,
63 final CommitNotifier commitNot,
64 final NetconfMonitoringService monitoringService, final Set<String> baseCapabilities) {
66 this.aggregatedOpService = netconfOperationProvider;
67 this.idProvider = idProvider;
68 this.connectionTimeoutMillis = connectionTimeoutMillis;
69 this.commitNotificationProducer = commitNot;
70 this.monitoringService = monitoringService;
71 this.baseCapabilities = validateBaseCapabilities(baseCapabilities);
74 private 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)), connectionTimeoutMillis);
114 private NetconfServerSessionListener getListener(final String netconfSessionIdForReporting) {
115 final NetconfOperationService service =
116 this.aggregatedOpService.createService(netconfSessionIdForReporting);
117 final NetconfOperationRouter operationRouter =
118 new NetconfOperationRouterImpl(service, commitNotificationProducer, monitoringService, netconfSessionIdForReporting);
119 return new NetconfServerSessionListener(operationRouter, monitoringService, service);
123 private NetconfHelloMessage createHelloMessage(final long sessionId, final NetconfMonitoringService capabilityProvider) throws NetconfDocumentedException {
124 return NetconfHelloMessage.createServerHello(Sets.union(DefaultCommit.transformCapabilities(capabilityProvider.getCapabilities()), baseCapabilities), sessionId);