2 * Copyright (c) 2014 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.controller.config.yang.md.sal.connector.netconf;
10 import static org.opendaylight.controller.config.api.JmxAttributeValidationException.checkCondition;
11 import static org.opendaylight.controller.config.api.JmxAttributeValidationException.checkNotNull;
13 import com.google.common.base.Optional;
14 import io.netty.util.concurrent.EventExecutor;
15 import java.math.BigDecimal;
16 import java.net.InetSocketAddress;
17 import java.util.List;
18 import java.util.concurrent.ExecutorService;
19 import org.opendaylight.controller.config.api.JmxAttributeValidationException;
20 import org.opendaylight.controller.netconf.client.NetconfClientDispatcher;
21 import org.opendaylight.controller.netconf.client.conf.NetconfClientConfiguration;
22 import org.opendaylight.controller.netconf.client.conf.NetconfReconnectingClientConfiguration;
23 import org.opendaylight.controller.netconf.client.conf.NetconfReconnectingClientConfigurationBuilder;
24 import org.opendaylight.controller.netconf.nettyutil.handler.ssh.authentication.LoginPassword;
25 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
26 import org.opendaylight.controller.sal.connect.api.RemoteDeviceHandler;
27 import org.opendaylight.controller.sal.connect.netconf.NetconfDevice;
28 import org.opendaylight.controller.sal.connect.netconf.NetconfStateSchemas;
29 import org.opendaylight.controller.sal.connect.netconf.listener.NetconfDeviceCommunicator;
30 import org.opendaylight.controller.sal.connect.netconf.listener.NetconfSessionPreferences;
31 import org.opendaylight.controller.sal.connect.netconf.sal.NetconfDeviceSalFacade;
32 import org.opendaylight.controller.sal.connect.util.RemoteDeviceId;
33 import org.opendaylight.controller.sal.core.api.Broker;
34 import org.opendaylight.protocol.framework.ReconnectStrategy;
35 import org.opendaylight.protocol.framework.ReconnectStrategyFactory;
36 import org.opendaylight.protocol.framework.TimedReconnectStrategy;
37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Host;
38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
39 import org.opendaylight.yangtools.yang.model.repo.api.SchemaContextFactory;
40 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceRegistry;
41 import org.osgi.framework.BundleContext;
42 import org.slf4j.Logger;
43 import org.slf4j.LoggerFactory;
48 public final class NetconfConnectorModule extends org.opendaylight.controller.config.yang.md.sal.connector.netconf.AbstractNetconfConnectorModule
50 private static final Logger logger = LoggerFactory.getLogger(NetconfConnectorModule.class);
52 private BundleContext bundleContext;
53 private Optional<NetconfSessionPreferences> userCapabilities;
54 private SchemaSourceRegistry schemaRegistry;
55 private SchemaContextFactory schemaContextFactory;
57 public NetconfConnectorModule(final org.opendaylight.controller.config.api.ModuleIdentifier identifier, final org.opendaylight.controller.config.api.DependencyResolver dependencyResolver) {
58 super(identifier, dependencyResolver);
61 public NetconfConnectorModule(final org.opendaylight.controller.config.api.ModuleIdentifier identifier, final org.opendaylight.controller.config.api.DependencyResolver dependencyResolver, final NetconfConnectorModule oldModule, final java.lang.AutoCloseable oldInstance) {
62 super(identifier, dependencyResolver, oldModule, oldInstance);
66 protected void customValidation() {
67 checkNotNull(getAddress(), addressJmxAttribute);
68 checkCondition(isHostAddressPresent(getAddress()), "Host address not present in " + getAddress(), addressJmxAttribute);
69 checkNotNull(getPort(), portJmxAttribute);
70 checkNotNull(getDomRegistry(), portJmxAttribute);
71 checkNotNull(getDomRegistry(), domRegistryJmxAttribute);
73 checkNotNull(getConnectionTimeoutMillis(), connectionTimeoutMillisJmxAttribute);
74 checkCondition(getConnectionTimeoutMillis() > 0, "must be > 0", connectionTimeoutMillisJmxAttribute);
76 checkNotNull(getConnectionTimeoutMillis(), defaultRequestTimeoutMillisJmxAttribute);
77 checkCondition(getConnectionTimeoutMillis() > 0, "must be > 0", defaultRequestTimeoutMillisJmxAttribute);
79 checkNotNull(getBetweenAttemptsTimeoutMillis(), betweenAttemptsTimeoutMillisJmxAttribute);
80 checkCondition(getBetweenAttemptsTimeoutMillis() > 0, "must be > 0", betweenAttemptsTimeoutMillisJmxAttribute);
82 checkNotNull(getClientDispatcher(), clientDispatcherJmxAttribute);
83 checkNotNull(getBindingRegistry(), bindingRegistryJmxAttribute);
84 checkNotNull(getProcessingExecutor(), processingExecutorJmxAttribute);
86 // Check username + password in case of ssh
87 if(getTcpOnly() == false) {
88 checkNotNull(getUsername(), usernameJmxAttribute);
89 checkNotNull(getPassword(), passwordJmxAttribute);
92 userCapabilities = getUserCapabilities();
95 private boolean isHostAddressPresent(final Host address) {
96 return address.getDomainName() != null ||
97 address.getIpAddress() != null && (address.getIpAddress().getIpv4Address() != null || address.getIpAddress().getIpv6Address() != null);
101 public java.lang.AutoCloseable createInstance() {
102 final RemoteDeviceId id = new RemoteDeviceId(getIdentifier(), getSocketAddress());
104 final ExecutorService globalProcessingExecutor = getProcessingExecutorDependency().getExecutor();
106 final Broker domBroker = getDomRegistryDependency();
107 final BindingAwareBroker bindingBroker = getBindingRegistryDependency();
109 final RemoteDeviceHandler<NetconfSessionPreferences> salFacade
110 = new NetconfDeviceSalFacade(id, domBroker, bindingBroker, bundleContext, getDefaultRequestTimeoutMillis());
112 final NetconfDevice.SchemaResourcesDTO schemaResourcesDTO =
113 new NetconfDevice.SchemaResourcesDTO(schemaRegistry, schemaContextFactory, new NetconfStateSchemas.NetconfStateSchemasResolverImpl());
115 final NetconfDevice device =
116 new NetconfDevice(schemaResourcesDTO, id, salFacade, globalProcessingExecutor, getReconnectOnChangedSchema());
118 final NetconfDeviceCommunicator listener = userCapabilities.isPresent() ?
119 new NetconfDeviceCommunicator(id, device, userCapabilities.get()) : new NetconfDeviceCommunicator(id, device);
121 final NetconfReconnectingClientConfiguration clientConfig = getClientConfig(listener);
122 final NetconfClientDispatcher dispatcher = getClientDispatcherDependency();
124 listener.initializeRemoteConnection(dispatcher, clientConfig);
126 return new SalConnectorCloseable(listener, salFacade);
129 private Optional<NetconfSessionPreferences> getUserCapabilities() {
130 if(getYangModuleCapabilities() == null) {
131 return Optional.absent();
134 final List<String> capabilities = getYangModuleCapabilities().getCapability();
135 if(capabilities == null || capabilities.isEmpty()) {
136 return Optional.absent();
139 final NetconfSessionPreferences parsedOverrideCapabilities = NetconfSessionPreferences.fromStrings(capabilities);
140 JmxAttributeValidationException.checkCondition(
141 parsedOverrideCapabilities.getNonModuleCaps().isEmpty(),
142 "Capabilities to override can only contain module based capabilities, non-module capabilities will be retrieved from the device," +
143 " configured non-module capabilities: " + parsedOverrideCapabilities.getNonModuleCaps(),
144 yangModuleCapabilitiesJmxAttribute);
146 return Optional.of(parsedOverrideCapabilities);
149 public void setBundleContext(final BundleContext bundleContext) {
150 this.bundleContext = bundleContext;
153 public NetconfReconnectingClientConfiguration getClientConfig(final NetconfDeviceCommunicator listener) {
154 final InetSocketAddress socketAddress = getSocketAddress();
155 final long clientConnectionTimeoutMillis = getConnectionTimeoutMillis();
157 final ReconnectStrategyFactory sf = new TimedReconnectStrategyFactory(
158 getEventExecutorDependency(), getMaxConnectionAttempts(), getBetweenAttemptsTimeoutMillis(), getSleepFactor());
159 final ReconnectStrategy strategy = sf.createReconnectStrategy();
161 return NetconfReconnectingClientConfigurationBuilder.create()
162 .withAddress(socketAddress)
163 .withConnectionTimeoutMillis(clientConnectionTimeoutMillis)
164 .withReconnectStrategy(strategy)
165 .withAuthHandler(new LoginPassword(getUsername(), getPassword()))
166 .withProtocol(getTcpOnly() ?
167 NetconfClientConfiguration.NetconfClientProtocol.TCP :
168 NetconfClientConfiguration.NetconfClientProtocol.SSH)
169 .withConnectStrategyFactory(sf)
170 .withSessionListener(listener)
174 private static final class SalConnectorCloseable implements AutoCloseable {
175 private final RemoteDeviceHandler<NetconfSessionPreferences> salFacade;
176 private final NetconfDeviceCommunicator listener;
178 public SalConnectorCloseable(final NetconfDeviceCommunicator listener,
179 final RemoteDeviceHandler<NetconfSessionPreferences> salFacade) {
180 this.listener = listener;
181 this.salFacade = salFacade;
185 public void close() {
191 private static final class TimedReconnectStrategyFactory implements ReconnectStrategyFactory {
192 private final Long connectionAttempts;
193 private final EventExecutor executor;
194 private final double sleepFactor;
195 private final int minSleep;
197 TimedReconnectStrategyFactory(final EventExecutor executor, final Long maxConnectionAttempts, final int minSleep, final BigDecimal sleepFactor) {
198 if (maxConnectionAttempts != null && maxConnectionAttempts > 0) {
199 connectionAttempts = maxConnectionAttempts;
201 logger.trace("Setting {} on {} to infinity", maxConnectionAttemptsJmxAttribute, this);
202 connectionAttempts = null;
205 this.sleepFactor = sleepFactor.doubleValue();
206 this.executor = executor;
207 this.minSleep = minSleep;
211 public ReconnectStrategy createReconnectStrategy() {
212 final Long maxSleep = null;
213 final Long deadline = null;
215 return new TimedReconnectStrategy(executor, minSleep,
216 minSleep, sleepFactor, maxSleep, connectionAttempts, deadline);
220 private InetSocketAddress getSocketAddress() {
221 if(getAddress().getDomainName() != null) {
222 return new InetSocketAddress(getAddress().getDomainName().getValue(), getPort().getValue());
224 final IpAddress ipAddress = getAddress().getIpAddress();
225 final String ip = ipAddress.getIpv4Address() != null ? ipAddress.getIpv4Address().getValue() : ipAddress.getIpv6Address().getValue();
226 return new InetSocketAddress(ip, getPort().getValue());
230 public void setSchemaRegistry(final SchemaSourceRegistry schemaRegistry) {
231 this.schemaRegistry = schemaRegistry;
234 public void setSchemaContextFactory(final SchemaContextFactory schemaContextFactory) {
235 this.schemaContextFactory = schemaContextFactory;