X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=netconf%2Fnetconf-topology%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fnetconf%2Ftopology%2FAbstractNetconfTopology.java;h=ad4bfa9029425205ccab65efdf3bc4600395a493;hb=57d2a366160965279304fbc24df0f946b09ea9ac;hp=68a6f11f9fd7319abafd8ece766d76dc5263a173;hpb=e1bdc7d1eff9c117a0e3c4559f5e8a0595f53a3f;p=netconf.git diff --git a/netconf/netconf-topology/src/main/java/org/opendaylight/netconf/topology/AbstractNetconfTopology.java b/netconf/netconf-topology/src/main/java/org/opendaylight/netconf/topology/AbstractNetconfTopology.java index 68a6f11f9f..ad4bfa9029 100644 --- a/netconf/netconf-topology/src/main/java/org/opendaylight/netconf/topology/AbstractNetconfTopology.java +++ b/netconf/netconf-topology/src/main/java/org/opendaylight/netconf/topology/AbstractNetconfTopology.java @@ -96,17 +96,18 @@ public abstract class AbstractNetconfTopology implements NetconfTopology { private static final String CACHE_DIRECTORY = "cache"; /** - * The default cache directory relative to CACHE_DIRECTORY + * The default cache directory relative to CACHE_DIRECTORY. */ private static final String DEFAULT_CACHE_DIRECTORY = "schema"; /** - * The qualified schema cache directory cache/schema + * The qualified schema cache directory cache/schema. */ - private static final String QUALIFIED_DEFAULT_CACHE_DIRECTORY = CACHE_DIRECTORY + File.separator+ DEFAULT_CACHE_DIRECTORY; + private static final String QUALIFIED_DEFAULT_CACHE_DIRECTORY = + CACHE_DIRECTORY + File.separator + DEFAULT_CACHE_DIRECTORY; /** - * The name for the default schema repository + * The name for the default schema repository. */ private static final String DEFAULT_SCHEMA_REPOSITORY_NAME = "sal-netconf-connector"; @@ -134,15 +135,15 @@ public abstract class AbstractNetconfTopology implements NetconfTopology { * of the schema cache directory, and the value is a corresponding SchemaResourcesDTO. The * SchemaResourcesDTO is essentially a container that allows for the extraction of the * SchemaRegistry and SchemaContextFactory which should be used for a particular - * Netconf mount. Access to schemaResourcesDTOs should be surrounded by appropriate + * Netconf mount. Access to SCHEMA_RESOURCES_DTO_MAP should be surrounded by appropriate * synchronization locks. */ - private static final Map schemaResourcesDTOs = new HashMap<>(); + private static final Map SCHEMA_RESOURCES_DTO_MAP = new HashMap<>(); // Initializes default constant instances for the case when the default schema repository // directory cache/schema is used. static { - schemaResourcesDTOs.put(DEFAULT_CACHE_DIRECTORY, + SCHEMA_RESOURCES_DTO_MAP.put(DEFAULT_CACHE_DIRECTORY, new NetconfDevice.SchemaResourcesDTO(DEFAULT_SCHEMA_REPOSITORY, DEFAULT_SCHEMA_REPOSITORY, DEFAULT_SCHEMA_CONTEXT_FACTORY, new NetconfStateSchemasResolverImpl())); @@ -168,7 +169,8 @@ public abstract class AbstractNetconfTopology implements NetconfTopology { protected AbstractNetconfTopology(final String topologyId, final NetconfClientDispatcher clientDispatcher, final EventExecutor eventExecutor, final ScheduledThreadPool keepaliveExecutor, - final ThreadPool processingExecutor, final SchemaRepositoryProvider schemaRepositoryProvider, + final ThreadPool processingExecutor, + final SchemaRepositoryProvider schemaRepositoryProvider, final DataBroker dataBroker, final DOMMountPointService mountPointService) { this.topologyId = topologyId; this.clientDispatcher = clientDispatcher; @@ -198,7 +200,8 @@ public abstract class AbstractNetconfTopology implements NetconfTopology { public ListenableFuture disconnectNode(final NodeId nodeId) { LOG.debug("Disconnecting RemoteDevice{{}}", nodeId.getValue()); if (!activeConnectors.containsKey(nodeId)) { - return Futures.immediateFailedFuture(new IllegalStateException("Unable to disconnect device that is not connected")); + return Futures.immediateFailedFuture( + new IllegalStateException("Unable to disconnect device that is not connected")); } // retrieve connection, and disconnect it @@ -219,8 +222,10 @@ public abstract class AbstractNetconfTopology implements NetconfTopology { final NetconfConnectorDTO deviceCommunicatorDTO = createDeviceCommunicator(nodeId, netconfNode); final NetconfDeviceCommunicator deviceCommunicator = deviceCommunicatorDTO.getCommunicator(); final NetconfClientSessionListener netconfClientSessionListener = deviceCommunicatorDTO.getSessionListener(); - final NetconfReconnectingClientConfiguration clientConfig = getClientConfig(netconfClientSessionListener, netconfNode); - final ListenableFuture future = deviceCommunicator.initializeRemoteConnection(clientDispatcher, clientConfig); + final NetconfReconnectingClientConfiguration clientConfig = + getClientConfig(netconfClientSessionListener, netconfNode); + final ListenableFuture future = + deviceCommunicator.initializeRemoteConnection(clientDispatcher, clientConfig); activeConnectors.put(nodeId, deviceCommunicatorDTO); @@ -231,7 +236,7 @@ public abstract class AbstractNetconfTopology implements NetconfTopology { } @Override - public void onFailure(final Throwable t) { + public void onFailure(final Throwable throwable) { LOG.error("Connector for : " + nodeId.getValue() + " failed"); // remove this node from active connectors? } @@ -243,13 +248,16 @@ public abstract class AbstractNetconfTopology implements NetconfTopology { protected NetconfConnectorDTO createDeviceCommunicator(final NodeId nodeId, final NetconfNode node) { //setup default values since default value is not supported in mdsal - final Long defaultRequestTimeoutMillis = node.getDefaultRequestTimeoutMillis() == null ? DEFAULT_REQUEST_TIMEOUT_MILLIS : node.getDefaultRequestTimeoutMillis(); - final Long keepaliveDelay = node.getKeepaliveDelay() == null ? DEFAULT_KEEPALIVE_DELAY : node.getKeepaliveDelay(); - final Boolean reconnectOnChangedSchema = node.isReconnectOnChangedSchema() == null ? DEFAULT_RECONNECT_ON_CHANGED_SCHEMA : node.isReconnectOnChangedSchema(); + final Long defaultRequestTimeoutMillis = node.getDefaultRequestTimeoutMillis() == null + ? DEFAULT_REQUEST_TIMEOUT_MILLIS : node.getDefaultRequestTimeoutMillis(); + final Long keepaliveDelay = node.getKeepaliveDelay() == null + ? DEFAULT_KEEPALIVE_DELAY : node.getKeepaliveDelay(); + final Boolean reconnectOnChangedSchema = node.isReconnectOnChangedSchema() == null + ? DEFAULT_RECONNECT_ON_CHANGED_SCHEMA : node.isReconnectOnChangedSchema(); final IpAddress ipAddress = node.getHost().getIpAddress(); - final InetSocketAddress address = new InetSocketAddress(ipAddress.getIpv4Address() != null ? - ipAddress.getIpv4Address().getValue() : ipAddress.getIpv6Address().getValue(), + final InetSocketAddress address = new InetSocketAddress(ipAddress.getIpv4Address() != null + ? ipAddress.getIpv4Address().getValue() : ipAddress.getIpv6Address().getValue(), node.getPort().getValue()); final RemoteDeviceId remoteDeviceId = new RemoteDeviceId(nodeId.getValue(), address); @@ -258,7 +266,8 @@ public abstract class AbstractNetconfTopology implements NetconfTopology { if (keepaliveDelay > 0) { LOG.warn("Adding keepalive facade, for device {}", nodeId); - salFacade = new KeepaliveSalFacade(remoteDeviceId, salFacade, keepaliveExecutor.getExecutor(), keepaliveDelay, defaultRequestTimeoutMillis); + salFacade = new KeepaliveSalFacade(remoteDeviceId, salFacade, keepaliveExecutor.getExecutor(), + keepaliveDelay, defaultRequestTimeoutMillis); } // pre register yang library sources as fallback schemas to schema registry @@ -269,20 +278,21 @@ public abstract class AbstractNetconfTopology implements NetconfTopology { final String yangLigPassword = node.getYangLibrary().getPassword(); final LibraryModulesSchemas libraryModulesSchemas; - if(yangLibURL != null) { - if(yangLibUsername != null && yangLigPassword != null) { + if (yangLibURL != null) { + if (yangLibUsername != null && yangLigPassword != null) { libraryModulesSchemas = LibraryModulesSchemas.create(yangLibURL, yangLibUsername, yangLigPassword); } else { libraryModulesSchemas = LibraryModulesSchemas.create(yangLibURL); } - for (final Map.Entry sourceIdentifierURLEntry : libraryModulesSchemas.getAvailableModels().entrySet()) { - registeredYangLibSources. - add(schemaRegistry.registerSchemaSource( - new YangLibrarySchemaYangSourceProvider(remoteDeviceId, libraryModulesSchemas.getAvailableModels()), - PotentialSchemaSource - .create(sourceIdentifierURLEntry.getKey(), YangTextSchemaSource.class, - PotentialSchemaSource.Costs.REMOTE_IO.getValue()))); + for (final Map.Entry sourceIdentifierURLEntry + : libraryModulesSchemas.getAvailableModels().entrySet()) { + registeredYangLibSources + .add(schemaRegistry.registerSchemaSource( + new YangLibrarySchemaYangSourceProvider(remoteDeviceId, + libraryModulesSchemas.getAvailableModels()), + PotentialSchemaSource.create(sourceIdentifierURLEntry.getKey(), + YangTextSchemaSource.class, PotentialSchemaSource.Costs.REMOTE_IO.getValue()))); } } } @@ -318,22 +328,25 @@ public abstract class AbstractNetconfTopology implements NetconfTopology { // Setup information related to the SchemaRegistry, SchemaResourceFactory, etc. NetconfDevice.SchemaResourcesDTO schemaResourcesDTO = null; final String moduleSchemaCacheDirectory = node.getSchemaCacheDirectory(); - // Only checks to ensure the String is not empty or null; further checks related to directory accessibility and file permissions - // are handled during the FilesystemSchemaSourceCache initialization. + // Only checks to ensure the String is not empty or null; further checks related to directory + // accessibility and file permissionsare handled during the FilesystemSchemaSourceCache initialization. if (!Strings.isNullOrEmpty(moduleSchemaCacheDirectory)) { - // If a custom schema cache directory is specified, create the backing DTO; otherwise, the SchemaRegistry and - // SchemaContextFactory remain the default values. + // If a custom schema cache directory is specified, create the backing DTO; otherwise, + // the SchemaRegistry and SchemaContextFactory remain the default values. if (!moduleSchemaCacheDirectory.equals(DEFAULT_CACHE_DIRECTORY)) { - // Multiple modules may be created at once; synchronize to avoid issues with data consistency among threads. - synchronized(schemaResourcesDTOs) { - // Look for the cached DTO to reuse SchemaRegistry and SchemaContextFactory variables if they already exist - schemaResourcesDTO = schemaResourcesDTOs.get(moduleSchemaCacheDirectory); + // Multiple modules may be created at once; + // synchronize to avoid issues with data consistency among threads. + synchronized (SCHEMA_RESOURCES_DTO_MAP) { + // Look for the cached DTO to reuse SchemaRegistry and SchemaContextFactory variables + // if they already exist + schemaResourcesDTO = SCHEMA_RESOURCES_DTO_MAP.get(moduleSchemaCacheDirectory); if (schemaResourcesDTO == null) { schemaResourcesDTO = createSchemaResourcesDTO(moduleSchemaCacheDirectory); schemaResourcesDTO.getSchemaRegistry().registerSchemaSourceListener( - TextToASTTransformer.create((SchemaRepository) schemaResourcesDTO.getSchemaRegistry(), schemaResourcesDTO.getSchemaRegistry()) + TextToASTTransformer.create((SchemaRepository) schemaResourcesDTO.getSchemaRegistry(), + schemaResourcesDTO.getSchemaRegistry()) ); - schemaResourcesDTOs.put(moduleSchemaCacheDirectory, schemaResourcesDTO); + SCHEMA_RESOURCES_DTO_MAP.put(moduleSchemaCacheDirectory, schemaResourcesDTO); } } LOG.info("Netconf connector for device {} will use schema cache directory {} instead of {}", @@ -345,8 +358,8 @@ public abstract class AbstractNetconfTopology implements NetconfTopology { } if (schemaResourcesDTO == null) { - schemaResourcesDTO = new NetconfDevice.SchemaResourcesDTO(schemaRegistry, schemaRepository, schemaContextFactory, - new NetconfStateSchemasResolverImpl()); + schemaResourcesDTO = new NetconfDevice.SchemaResourcesDTO(schemaRegistry, schemaRepository, + schemaContextFactory, new NetconfStateSchemasResolverImpl()); } return schemaResourcesDTO; @@ -377,17 +390,23 @@ public abstract class AbstractNetconfTopology implements NetconfTopology { * @param schemaCacheDirectory The custom cache directory relative to "cache" * @return A FilesystemSchemaSourceCache for the custom schema cache directory */ - private FilesystemSchemaSourceCache createDeviceFilesystemCache(final String schemaCacheDirectory) { + private FilesystemSchemaSourceCache createDeviceFilesystemCache( + final String schemaCacheDirectory) { final String relativeSchemaCacheDirectory = CACHE_DIRECTORY + File.separator + schemaCacheDirectory; - return new FilesystemSchemaSourceCache<>(schemaRegistry, YangTextSchemaSource.class, new File(relativeSchemaCacheDirectory)); + return new FilesystemSchemaSourceCache<>(schemaRegistry, YangTextSchemaSource.class, + new File(relativeSchemaCacheDirectory)); } - public NetconfReconnectingClientConfiguration getClientConfig(final NetconfClientSessionListener listener, final NetconfNode node) { + public NetconfReconnectingClientConfiguration getClientConfig(final NetconfClientSessionListener listener, + final NetconfNode node) { //setup default values since default value is not supported in mdsal - final long clientConnectionTimeoutMillis = node.getConnectionTimeoutMillis() == null ? DEFAULT_CONNECTION_TIMEOUT_MILLIS : node.getConnectionTimeoutMillis(); - final long maxConnectionAttempts = node.getMaxConnectionAttempts() == null ? DEFAULT_MAX_CONNECTION_ATTEMPTS : node.getMaxConnectionAttempts(); - final int betweenAttemptsTimeoutMillis = node.getBetweenAttemptsTimeoutMillis() == null ? DEFAULT_BETWEEN_ATTEMPTS_TIMEOUT_MILLIS : node.getBetweenAttemptsTimeoutMillis(); + final long clientConnectionTimeoutMillis = node.getConnectionTimeoutMillis() == null + ? DEFAULT_CONNECTION_TIMEOUT_MILLIS : node.getConnectionTimeoutMillis(); + final long maxConnectionAttempts = node.getMaxConnectionAttempts() == null + ? DEFAULT_MAX_CONNECTION_ATTEMPTS : node.getMaxConnectionAttempts(); + final int betweenAttemptsTimeoutMillis = node.getBetweenAttemptsTimeoutMillis() == null + ? DEFAULT_BETWEEN_ATTEMPTS_TIMEOUT_MILLIS : node.getBetweenAttemptsTimeoutMillis(); final BigDecimal sleepFactor = node.getSleepFactor() == null ? DEFAULT_SLEEP_FACTOR : node.getSleepFactor(); final InetSocketAddress socketAddress = getSocketAddress(node.getHost(), node.getPort().getValue()); @@ -398,10 +417,13 @@ public abstract class AbstractNetconfTopology implements NetconfTopology { final AuthenticationHandler authHandler; final Credentials credentials = node.getCredentials(); - if (credentials instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.LoginPassword) { + if (credentials instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114 + .netconf.node.credentials.credentials.LoginPassword) { authHandler = new LoginPassword( - ((org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.LoginPassword) credentials).getUsername(), - ((org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.LoginPassword) credentials).getPassword()); + ((org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114 + .netconf.node.credentials.credentials.LoginPassword) credentials).getUsername(), + ((org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114 + .netconf.node.credentials.credentials.LoginPassword) credentials).getPassword()); } else { throw new IllegalStateException("Only login/password authentification is supported"); } @@ -411,22 +433,22 @@ public abstract class AbstractNetconfTopology implements NetconfTopology { .withConnectionTimeoutMillis(clientConnectionTimeoutMillis) .withReconnectStrategy(strategy) .withAuthHandler(authHandler) - .withProtocol(node.isTcpOnly() ? - NetconfClientConfiguration.NetconfClientProtocol.TCP : + .withProtocol(node.isTcpOnly() ? NetconfClientConfiguration.NetconfClientProtocol.TCP : NetconfClientConfiguration.NetconfClientProtocol.SSH) .withConnectStrategyFactory(sf) .withSessionListener(listener) .build(); } - protected abstract RemoteDeviceHandler createSalFacade(final RemoteDeviceId id); + protected abstract RemoteDeviceHandler createSalFacade(RemoteDeviceId id); private InetSocketAddress getSocketAddress(final Host host, final int port) { - if(host.getDomainName() != null) { + if (host.getDomainName() != null) { return new InetSocketAddress(host.getDomainName().getValue(), port); } else { final IpAddress ipAddress = host.getIpAddress(); - final String ip = ipAddress.getIpv4Address() != null ? ipAddress.getIpv4Address().getValue() : ipAddress.getIpv6Address().getValue(); + final String ip = ipAddress.getIpv4Address() != null + ? ipAddress.getIpv4Address().getValue() : ipAddress.getIpv6Address().getValue(); return new InetSocketAddress(ip, port); } } @@ -448,9 +470,9 @@ public abstract class AbstractNetconfTopology implements NetconfTopology { //non-module capabilities should not exist in yang module capabilities final NetconfSessionPreferences netconfSessionPreferences = NetconfSessionPreferences.fromStrings(capabilities); - Preconditions.checkState(netconfSessionPreferences.getNonModuleCaps().isEmpty(), "List yang-module-capabilities/capability " + - "should contain only module based capabilities. Non-module capabilities used: " + - netconfSessionPreferences.getNonModuleCaps()); + Preconditions.checkState(netconfSessionPreferences.getNonModuleCaps().isEmpty(), + "List yang-module-capabilities/capability should contain only module based capabilities. " + + "Non-module capabilities used: " + netconfSessionPreferences.getNonModuleCaps()); boolean overrideNonModuleCaps = false; if (node.getNonModuleCapabilities() != null) { @@ -458,8 +480,8 @@ public abstract class AbstractNetconfTopology implements NetconfTopology { overrideNonModuleCaps = node.getNonModuleCapabilities().isOverride(); } - return Optional.of(new UserPreferences(NetconfSessionPreferences.fromStrings(capabilities, CapabilityOrigin.UserDefined), - overrideYangModuleCaps, overrideNonModuleCaps)); + return Optional.of(new UserPreferences(NetconfSessionPreferences + .fromStrings(capabilities, CapabilityOrigin.UserDefined), overrideYangModuleCaps, overrideNonModuleCaps)); } private static final class TimedReconnectStrategyFactory implements ReconnectStrategyFactory { @@ -468,7 +490,8 @@ public abstract class AbstractNetconfTopology implements NetconfTopology { private final double sleepFactor; private final int minSleep; - TimedReconnectStrategyFactory(final EventExecutor executor, final Long maxConnectionAttempts, final int minSleep, final BigDecimal sleepFactor) { + TimedReconnectStrategyFactory(final EventExecutor executor, final Long maxConnectionAttempts, + final int minSleep, final BigDecimal sleepFactor) { if (maxConnectionAttempts != null && maxConnectionAttempts > 0) { connectionAttempts = maxConnectionAttempts; } else { @@ -495,7 +518,8 @@ public abstract class AbstractNetconfTopology implements NetconfTopology { private final NetconfDeviceCommunicator communicator; private final RemoteDeviceHandler facade; - public NetconfConnectorDTO(final NetconfDeviceCommunicator communicator, final RemoteDeviceHandler facade) { + public NetconfConnectorDTO(final NetconfDeviceCommunicator communicator, + final RemoteDeviceHandler facade) { this.communicator = communicator; this.facade = facade; }