From c670e63b45ef42f1aa025ff94f79efa2bd9a1c01 Mon Sep 17 00:00:00 2001 From: Maros Marsalek Date: Fri, 20 Jun 2014 13:14:27 +0200 Subject: [PATCH] BUG-944 Remove backwards compatibility config from sal-netconf- connector. BREAKS BACKWARDS COMPATIBILITY FOR CONNECTOR CONFIGURATION. SEND EMAIL TO MAILING LIST ABOUT BREAKING COMPATIBILITY FOR NETCONF CONNECTOR BEFORE MERGE! ALL DISTRIBUTIONS THAT USE NETCONF-CONNECTOR NEED TO UPDATE CONFIGURATION OF CONNECTORS ACCORDING TO 99-netconf-connector INITIAL CONFIG FILE Deprecated config attributes and code removed. Extracted common connector modules(threadfactory, threadpool and client dispatcher) from config file 99-netconf-connector into 01-netconf Change-Id: I77a93a1dc6845414474632f85c93d8a940449ac6 Signed-off-by: Maros Marsalek --- .../configuration/initial/01-netconf.xml | 84 +++++++++++++++++ .../initial/99-netconf-connector.xml | 65 ------------- .../netconf/NetconfConnectorModule.java | 93 ++++--------------- .../yang/odl-sal-netconf-connector-cfg.yang | 37 ++------ 4 files changed, 108 insertions(+), 171 deletions(-) create mode 100644 opendaylight/distribution/opendaylight/src/main/resources/configuration/initial/01-netconf.xml diff --git a/opendaylight/distribution/opendaylight/src/main/resources/configuration/initial/01-netconf.xml b/opendaylight/distribution/opendaylight/src/main/resources/configuration/initial/01-netconf.xml new file mode 100644 index 0000000000..8fedbe4d4c --- /dev/null +++ b/opendaylight/distribution/opendaylight/src/main/resources/configuration/initial/01-netconf.xml @@ -0,0 +1,84 @@ + + + + + + + + + + + prefix:netconf-client-dispatcher + global-netconf-dispatcher + + prefix:netty-threadgroup + global-boss-group + + + prefix:netty-threadgroup + global-worker-group + + + prefix:netty-timer + global-timer + + + + + + prefix:threadfactory-naming + global-netconf-processing-executor-threadfactory + remote-connector-processing-executor + + + + prefix:threadpool-flexible + global-netconf-processing-executor + 1 + 4 + 600000 + + prefix:threadfactory + global-netconf-processing-executor-threadfactory + + + + + + + prefix:netconf-client-dispatcher + + global-netconf-dispatcher + /modules/module[type='netconf-client-dispatcher'][name='global-netconf-dispatcher'] + + + + prefix:threadfactory + + global-netconf-processing-executor-threadfactory + /modules/module[type='threadfactory-naming'][name='global-netconf-processing-executor-threadfactory'] + + + + prefix:threadpool + + global-netconf-processing-executor + /modules/module[type='threadpool-flexible'][name='global-netconf-processing-executor'] + + + + + + + + urn:opendaylight:params:xml:ns:yang:controller:config:netconf:client:dispatcher?module=odl-netconfig-client-cfg&revision=2014-04-08 + urn:opendaylight:params:xml:ns:yang:controller:threadpool:impl?module=threadpool-impl&revision=2013-04-05 + urn:opendaylight:params:xml:ns:yang:controller:threadpool:impl:flexible?module=threadpool-impl-flexible&revision=2013-12-01 + + diff --git a/opendaylight/distribution/opendaylight/src/main/resources/configuration/initial/99-netconf-connector.xml b/opendaylight/distribution/opendaylight/src/main/resources/configuration/initial/99-netconf-connector.xml index b4b433dbca..7155eb8883 100644 --- a/opendaylight/distribution/opendaylight/src/main/resources/configuration/initial/99-netconf-connector.xml +++ b/opendaylight/distribution/opendaylight/src/main/resources/configuration/initial/99-netconf-connector.xml @@ -11,43 +11,6 @@ - - - - prefix:netconf-client-dispatcher - global-netconf-dispatcher - - prefix:netty-threadgroup - global-boss-group - - - prefix:netty-threadgroup - global-worker-group - - - prefix:netty-timer - global-timer - - - - - - prefix:threadfactory-naming - global-netconf-processing-executor-threadfactory - remote-connector-processing-executor - - - prefix:threadpool-flexible - global-netconf-processing-executor - 1 - 4 - 600000 - - prefix:threadfactory - global-netconf-processing-executor-threadfactory - - - prefix:sal-netconf-connector @@ -79,37 +42,9 @@ - - - - prefix:netconf-client-dispatcher - - global-netconf-dispatcher - /modules/module[type='netconf-client-dispatcher'][name='global-netconf-dispatcher'] - - - - prefix:threadfactory - - global-netconf-processing-executor-threadfactory - /modules/module[type='threadfactory-naming'][name='global-netconf-processing-executor-threadfactory'] - - - - prefix:threadpool - - global-netconf-processing-executor - /modules/module[type='threadpool-flexible'][name='global-netconf-processing-executor'] - - - - urn:opendaylight:params:xml:ns:yang:controller:md:sal:connector:netconf?module=odl-sal-netconf-connector-cfg&revision=2013-10-28 - urn:opendaylight:params:xml:ns:yang:controller:config:netconf:client:dispatcher?module=odl-netconfig-client-cfg&revision=2014-04-08 - urn:opendaylight:params:xml:ns:yang:controller:threadpool:impl?module=threadpool-impl&revision=2013-04-05 - urn:opendaylight:params:xml:ns:yang:controller:threadpool:impl:flexible?module=threadpool-impl-flexible&revision=2013-12-01 diff --git a/opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/config/yang/md/sal/connector/netconf/NetconfConnectorModule.java b/opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/config/yang/md/sal/connector/netconf/NetconfConnectorModule.java index f73d9cc72f..037bfb4a82 100644 --- a/opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/config/yang/md/sal/connector/netconf/NetconfConnectorModule.java +++ b/opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/config/yang/md/sal/connector/netconf/NetconfConnectorModule.java @@ -12,13 +12,10 @@ import static org.opendaylight.controller.config.api.JmxAttributeValidationExcep import java.io.File; import java.io.InputStream; -import java.net.InetAddress; import java.net.InetSocketAddress; import java.util.concurrent.ExecutorService; -import java.util.concurrent.Executors; import org.opendaylight.controller.netconf.client.NetconfClientDispatcher; -import org.opendaylight.controller.netconf.client.NetconfClientDispatcherImpl; import org.opendaylight.controller.netconf.client.conf.NetconfClientConfiguration; import org.opendaylight.controller.netconf.client.conf.NetconfReconnectingClientConfiguration; import org.opendaylight.controller.netconf.client.conf.NetconfReconnectingClientConfigurationBuilder; @@ -33,19 +30,16 @@ import org.opendaylight.controller.sal.core.api.Broker; import org.opendaylight.protocol.framework.ReconnectStrategy; import org.opendaylight.protocol.framework.ReconnectStrategyFactory; import org.opendaylight.protocol.framework.TimedReconnectStrategy; +import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Host; +import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress; import org.opendaylight.yangtools.yang.model.util.repo.AbstractCachingSchemaSourceProvider; import org.opendaylight.yangtools.yang.model.util.repo.FilesystemSchemaCachingProvider; import org.opendaylight.yangtools.yang.model.util.repo.SchemaSourceProvider; import org.opendaylight.yangtools.yang.model.util.repo.SchemaSourceProviders; import org.osgi.framework.BundleContext; -import org.osgi.framework.ServiceReference; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import com.google.common.base.Preconditions; -import com.google.common.net.InetAddresses; -import io.netty.util.HashedWheelTimer; - /** * */ @@ -67,6 +61,7 @@ public final class NetconfConnectorModule extends org.opendaylight.controller.co @Override protected void customValidation() { checkNotNull(getAddress(), addressJmxAttribute); + checkCondition(isHostAddressPresent(getAddress()), "Host address not present in " + getAddress(), addressJmxAttribute); checkNotNull(getPort(), portJmxAttribute); checkNotNull(getDomRegistry(), portJmxAttribute); checkNotNull(getDomRegistry(), domRegistryJmxAttribute); @@ -77,11 +72,9 @@ public final class NetconfConnectorModule extends org.opendaylight.controller.co checkNotNull(getBetweenAttemptsTimeoutMillis(), betweenAttemptsTimeoutMillisJmxAttribute); checkCondition(getBetweenAttemptsTimeoutMillis() > 0, "must be > 0", betweenAttemptsTimeoutMillisJmxAttribute); - // FIXME BUG-944 remove backwards compatibility - if(getClientDispatcher() == null) { - checkCondition(getBossThreadGroup() != null, "Client dispatcher was not set, thread groups have to be set instead", bossThreadGroupJmxAttribute); - checkCondition(getWorkerThreadGroup() != null, "Client dispatcher was not set, thread groups have to be set instead", workerThreadGroupJmxAttribute); - } + checkNotNull(getClientDispatcher(), clientDispatcherJmxAttribute); + checkNotNull(getBindingRegistry(), bindingRegistryJmxAttribute); + checkNotNull(getProcessingExecutor(), processingExecutorJmxAttribute); // Check username + password in case of ssh if(getTcpOnly() == false) { @@ -89,33 +82,21 @@ public final class NetconfConnectorModule extends org.opendaylight.controller.co checkNotNull(getPassword(), passwordJmxAttribute); } - // FIXME BUG 944 remove this warning - if(getBindingRegistry() == null) { - logger.warn("Configuration property: \"binding-registry\" not set for sal-netconf-connector (" + getIdentifier() + "). " + - "Netconf-connector now requires a dependency on \"binding-broker-osgi-registry\". " + - "The dependency is optional for now to preserve backwards compatibility, but will be mandatory in the future. " + - "Please set the property as in \"01-netconf-connector\" initial config file. " + - "The service will be retrieved from OSGi service registry now."); - } + } - // FIXME BUG 944 remove this warning - if(getProcessingExecutor() == null) { - logger.warn("Configuration property: \"processing-executor\" not set for sal-netconf-connector (" + getIdentifier() + "). " + - "Netconf-connector now requires a dependency on \"threadpool\". " + - "The dependency is optional for now to preserve backwards compatibility, but will be mandatory in the future. " + - "Please set the property as in \"01-netconf-connector\" initial config file. " + - "New instance will be created for the executor."); - } + private boolean isHostAddressPresent(Host address) { + return address.getDomainName() != null || + address.getIpAddress() != null && (address.getIpAddress().getIpv4Address() != null || address.getIpAddress().getIpv6Address() != null); } @Override public java.lang.AutoCloseable createInstance() { final RemoteDeviceId id = new RemoteDeviceId(getIdentifier()); - final ExecutorService globalProcessingExecutor = getGlobalProcessingExecutor(); + final ExecutorService globalProcessingExecutor = getProcessingExecutorDependency().getExecutor(); final Broker domBroker = getDomRegistryDependency(); - final BindingAwareBroker bindingBroker = getBindingRegistryBackwards(); + final BindingAwareBroker bindingBroker = getBindingRegistryDependency(); final RemoteDeviceHandler salFacade = new NetconfDeviceSalFacade(id, domBroker, bindingBroker, bundleContext, globalProcessingExecutor); final NetconfDevice device = @@ -123,8 +104,7 @@ public final class NetconfConnectorModule extends org.opendaylight.controller.co final NetconfDeviceCommunicator listener = new NetconfDeviceCommunicator(id, device); final NetconfReconnectingClientConfiguration clientConfig = getClientConfig(listener); - // FIXME BUG-944 remove backwards compatibility - final NetconfClientDispatcher dispatcher = getClientDispatcher() == null ? createDispatcher() : getClientDispatcherDependency(); + final NetconfClientDispatcher dispatcher = getClientDispatcherDependency(); listener.initializeRemoteConnection(dispatcher, clientConfig); return new AutoCloseable() { @@ -136,30 +116,6 @@ public final class NetconfConnectorModule extends org.opendaylight.controller.co }; } - private BindingAwareBroker getBindingRegistryBackwards() { - if(getBindingRegistry() != null) { - return getBindingRegistryDependency(); - } else { - // FIXME BUG 944 remove backwards compatibility - final ServiceReference serviceReference = bundleContext.getServiceReference(BindingAwareBroker.class); - Preconditions - .checkNotNull( - serviceReference, - "Unable to retrieve %s from OSGi service registry, use binding-registry config property to inject %s with config subsystem", - BindingAwareBroker.class, BindingAwareBroker.class); - return bundleContext.getService(serviceReference); - } - } - - private ExecutorService getGlobalProcessingExecutor() { - if(getProcessingExecutor() != null) { - return getProcessingExecutorDependency().getExecutor(); - } else { - // FIXME BUG 944 remove backwards compatibility - return Executors.newCachedThreadPool(); - } - } - private synchronized AbstractCachingSchemaSourceProvider getGlobalNetconfSchemaProvider() { if(GLOBAL_NETCONF_SOURCE_PROVIDER == null) { final String storageFile = "cache/schema"; @@ -171,16 +127,6 @@ public final class NetconfConnectorModule extends org.opendaylight.controller.co return GLOBAL_NETCONF_SOURCE_PROVIDER; } - // FIXME BUG-944 remove backwards compatibility - /** - * @deprecated Use getClientDispatcherDependency method instead to retrieve injected dispatcher. - * This one creates new instance of NetconfClientDispatcher and will be removed in near future. - */ - @Deprecated - private NetconfClientDispatcher createDispatcher() { - return new NetconfClientDispatcherImpl(getBossThreadGroupDependency(), getWorkerThreadGroupDependency(), new HashedWheelTimer()); - } - public void setBundleContext(final BundleContext bundleContext) { this.bundleContext = bundleContext; } @@ -226,15 +172,12 @@ public final class NetconfConnectorModule extends org.opendaylight.controller.co } private InetSocketAddress getSocketAddress() { - /* - * Uncomment after Switch to IP Address - if(getAddress().getIpv4Address() != null) { - addressValue = getAddress().getIpv4Address().getValue(); + if(getAddress().getDomainName() != null) { + return new InetSocketAddress(getAddress().getDomainName().getValue(), getPort().getValue()); } else { - addressValue = getAddress().getIpv6Address().getValue(); + IpAddress ipAddress = getAddress().getIpAddress(); + String ip = ipAddress.getIpv4Address() != null ? ipAddress.getIpv4Address().getValue() : ipAddress.getIpv6Address().getValue(); + return new InetSocketAddress(ip, getPort().getValue()); } - */ - final InetAddress inetAddress = InetAddresses.forString(getAddress()); - return new InetSocketAddress(inetAddress, getPort().intValue()); } } diff --git a/opendaylight/md-sal/sal-netconf-connector/src/main/yang/odl-sal-netconf-connector-cfg.yang b/opendaylight/md-sal/sal-netconf-connector/src/main/yang/odl-sal-netconf-connector-cfg.yang index c59c41c437..6bad4798c2 100644 --- a/opendaylight/md-sal/sal-netconf-connector/src/main/yang/odl-sal-netconf-connector-cfg.yang +++ b/opendaylight/md-sal/sal-netconf-connector/src/main/yang/odl-sal-netconf-connector-cfg.yang @@ -9,6 +9,7 @@ module odl-sal-netconf-connector-cfg { import opendaylight-md-sal-dom {prefix dom;} import opendaylight-md-sal-binding {prefix md-sal-binding; revision-date 2013-10-28;} import odl-netconf-cfg { prefix cfg-net; revision-date 2014-04-08; } + import ietf-inet-types {prefix inet; revision-date "2010-09-24";} description "Service definition for Binding Aware MD-SAL."; @@ -38,11 +39,11 @@ module odl-sal-netconf-connector-cfg { when "/config:modules/config:module/config:type = 'sal-netconf-connector'"; leaf address { - type string; + type inet:host; } leaf port { - type uint32; + type inet:port-number; } leaf tcp-only { @@ -69,40 +70,16 @@ module odl-sal-netconf-connector-cfg { container binding-registry { uses config:service-ref { refine type { - // FIXME BUG-944 make mandatory (remove backwards compatibility) - mandatory false; + mandatory true; config:required-identity md-sal-binding:binding-broker-osgi-registry; } } } - // FIXME BUG-944 remove backwards compatibility - // Deprecated, replaced by client dispatcher. - // This dependency will be removed in near future and all configurations of netconf-connector need to be changed to use dispatcher dependency. - container boss-thread-group { - uses config:service-ref { - refine type { - mandatory false; - config:required-identity netty:netty-threadgroup; - } - } - } - - // FIXME BUG-944 remove backwards compatibility - // Deprecated, replaced by client dispatcher. - // This dependency will be removed in near future and all configurations of netconf-connector need to be changed to use dispatcher dependency. - container worker-thread-group { - uses config:service-ref { - refine type { - mandatory false; - config:required-identity netty:netty-threadgroup; - } - } - } - container event-executor { uses config:service-ref { refine type { + mandatory true; config:required-identity netty:netty-event-executor; } } @@ -111,8 +88,7 @@ module odl-sal-netconf-connector-cfg { container processing-executor { uses config:service-ref { refine type { - // FIXME BUG-944 make mandatory (remove backwards compatibility) - mandatory false; + mandatory true; config:required-identity th:threadpool; } } @@ -120,7 +96,6 @@ module odl-sal-netconf-connector-cfg { description "Makes up for flaws in netty threading design"; } - // Replaces thread group dependencies container client-dispatcher { uses config:service-ref { refine type { -- 2.36.6