/*
* Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.netconf.topology.singleton.impl.utils;
import com.google.common.base.Strings;
import java.io.File;
import java.math.BigDecimal;
import java.net.InetSocketAddress;
import java.util.HashMap;
import java.util.Map;
import org.opendaylight.controller.config.util.xml.DocumentedException;
import org.opendaylight.netconf.sal.connect.netconf.NetconfDevice;
import org.opendaylight.netconf.sal.connect.netconf.NetconfStateSchemasResolverImpl;
import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
import org.opendaylight.yangtools.yang.binding.Identifier;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
import org.opendaylight.yangtools.yang.model.repo.api.SchemaContextFactory;
import org.opendaylight.yangtools.yang.model.repo.api.SchemaRepository;
import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceFilter;
import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceRegistry;
import org.opendaylight.yangtools.yang.model.repo.util.FilesystemSchemaSourceCache;
import org.opendaylight.yangtools.yang.parser.repo.SharedSchemaRepository;
import org.opendaylight.yangtools.yang.parser.util.TextToASTTransformer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class NetconfTopologyUtils {
private static Logger LOG = LoggerFactory.getLogger(NetconfTopologyUtils.class);
private static final String DEFAULT_SCHEMA_REPOSITORY_NAME = "sal-netconf-connector";
public static final long DEFAULT_REQUEST_TIMEOUT_MILLIS = 60000L;
public static final int DEFAULT_KEEPALIVE_DELAY = 0;
public static final boolean DEFAULT_RECONNECT_ON_CHANGED_SCHEMA = false;
public static final int DEFAULT_CONCURRENT_RPC_LIMIT = 0;
public static final int DEFAULT_MAX_CONNECTION_ATTEMPTS = 0;
public static final int DEFAULT_BETWEEN_ATTEMPTS_TIMEOUT_MILLIS = 2000;
public static final long DEFAULT_CONNECTION_TIMEOUT_MILLIS = 20000L;
public static final BigDecimal DEFAULT_SLEEP_FACTOR = new BigDecimal(1.5);
// The default cache directory relative to CACHE_DIRECTORY
public static final String DEFAULT_CACHE_DIRECTORY = "schema";
// Filesystem based caches are stored relative to the cache directory.
public static final String CACHE_DIRECTORY = "cache";
// The qualified schema cache directory cache/schema
public static final String QUALIFIED_DEFAULT_CACHE_DIRECTORY =
CACHE_DIRECTORY + File.separator + DEFAULT_CACHE_DIRECTORY;
// The default schema repository in the case that one is not specified.
public static final SharedSchemaRepository DEFAULT_SCHEMA_REPOSITORY =
new SharedSchemaRepository(DEFAULT_SCHEMA_REPOSITORY_NAME);
// The default FilesystemSchemaSourceCache
, which stores cached files in cache/schema
.
public static final FilesystemSchemaSourceCache DEFAULT_CACHE =
new FilesystemSchemaSourceCache<>(DEFAULT_SCHEMA_REPOSITORY, YangTextSchemaSource.class,
new File(QUALIFIED_DEFAULT_CACHE_DIRECTORY));
// The default factory for creating SchemaContext
instances.
public static final SchemaContextFactory DEFAULT_SCHEMA_CONTEXT_FACTORY =
DEFAULT_SCHEMA_REPOSITORY.createSchemaContextFactory(SchemaSourceFilter.ALWAYS_ACCEPT);
/**
* Keeps track of initialized Schema resources. A Map is maintained in which the key represents the name
* 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 SCHEMA_RESOURCES_DTO_MAP
should be surrounded by appropriate
* synchronization locks.
*/
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 {
SCHEMA_RESOURCES_DTO_MAP.put(DEFAULT_CACHE_DIRECTORY,
new NetconfDevice.SchemaResourcesDTO(DEFAULT_SCHEMA_REPOSITORY, DEFAULT_SCHEMA_REPOSITORY,
DEFAULT_SCHEMA_CONTEXT_FACTORY, new NetconfStateSchemasResolverImpl()));
DEFAULT_SCHEMA_REPOSITORY.registerSchemaSourceListener(DEFAULT_CACHE);
DEFAULT_SCHEMA_REPOSITORY.registerSchemaSourceListener(
TextToASTTransformer.create(DEFAULT_SCHEMA_REPOSITORY, DEFAULT_SCHEMA_REPOSITORY));
}
public static NetconfDevice.SchemaResourcesDTO setupSchemaCacheDTO(final Node node) {
final NetconfNode netconfNode = node.getAugmentation(NetconfNode.class);
final String moduleSchemaCacheDirectory = netconfNode.getSchemaCacheDirectory();
final RemoteDeviceId deviceId = createRemoteDeviceId(node.getNodeId(), netconfNode);
// Setup information related to the SchemaRegistry, SchemaResourceFactory, etc.
NetconfDevice.SchemaResourcesDTO schemaResourcesDTO = null;
// 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.
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 (!moduleSchemaCacheDirectory.equals(DEFAULT_CACHE_DIRECTORY)) {
// 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())
);
SCHEMA_RESOURCES_DTO_MAP.put(moduleSchemaCacheDirectory, schemaResourcesDTO);
}
}
LOG.info("{} : netconf connector will use schema cache directory {} instead of {}",
deviceId, moduleSchemaCacheDirectory, DEFAULT_CACHE_DIRECTORY);
}
}
if (schemaResourcesDTO == null) {
synchronized (SCHEMA_RESOURCES_DTO_MAP) {
schemaResourcesDTO = SCHEMA_RESOURCES_DTO_MAP.get(DEFAULT_CACHE_DIRECTORY);
}
LOG.info("{} : using the default directory {}",
deviceId, QUALIFIED_DEFAULT_CACHE_DIRECTORY);
}
return schemaResourcesDTO;
}
/**
* Creates the backing Schema classes for a particular directory.
*
* @param moduleSchemaCacheDirectory The string directory relative to "cache"
* @return A DTO containing the Schema classes for the Netconf mount.
*/
private static NetconfDevice.SchemaResourcesDTO createSchemaResourcesDTO(final String moduleSchemaCacheDirectory) {
final SharedSchemaRepository repository = new SharedSchemaRepository(moduleSchemaCacheDirectory);
final SchemaContextFactory schemaContextFactory
= repository.createSchemaContextFactory(SchemaSourceFilter.ALWAYS_ACCEPT);
final FilesystemSchemaSourceCache deviceCache =
createDeviceFilesystemCache(moduleSchemaCacheDirectory, repository);
repository.registerSchemaSourceListener(deviceCache);
return new NetconfDevice.SchemaResourcesDTO(repository, repository, schemaContextFactory,
new NetconfStateSchemasResolverImpl());
}
/**
* Creates a FilesystemSchemaSourceCache
for the custom schema cache directory.
*
* @param schemaCacheDirectory The custom cache directory relative to "cache"
* @return A FilesystemSchemaSourceCache
for the custom schema cache directory
*/
private static FilesystemSchemaSourceCache createDeviceFilesystemCache(
final String schemaCacheDirectory, final SchemaSourceRegistry schemaRegistry) {
final String relativeSchemaCacheDirectory =
NetconfTopologyUtils.CACHE_DIRECTORY + File.separator + schemaCacheDirectory;
return new FilesystemSchemaSourceCache<>(schemaRegistry, YangTextSchemaSource.class,
new File(relativeSchemaCacheDirectory));
}
public static RemoteDeviceId createRemoteDeviceId(final NodeId nodeId, final NetconfNode node) {
final IpAddress ipAddress = node.getHost().getIpAddress();
final InetSocketAddress address = new InetSocketAddress(ipAddress.getIpv4Address() != null
? ipAddress.getIpv4Address().getValue() : ipAddress.getIpv6Address().getValue(),
node.getPort().getValue());
return new RemoteDeviceId(nodeId.getValue(), address);
}
public static String createActorPath(final String masterMember, final String name) {
return masterMember + "/user/" + name;
}
public static String createMasterActorName(final String name, final String masterAddress) {
return masterAddress.replaceAll("//", "") + "_" + name;
}
public static NodeId getNodeId(final InstanceIdentifier.PathArgument pathArgument) {
if (pathArgument instanceof InstanceIdentifier.IdentifiableItem, ?>) {
final Identifier key = ((InstanceIdentifier.IdentifiableItem) pathArgument).getKey();
if (key instanceof NodeKey) {
return ((NodeKey) key).getNodeId();
}
}
throw new IllegalStateException("Unable to create NodeId from: " + pathArgument);
}
public static KeyedInstanceIdentifier createTopologyListPath(final String topologyId) {
final InstanceIdentifier networkTopology = InstanceIdentifier.create(NetworkTopology.class);
return networkTopology.child(Topology.class, new TopologyKey(new TopologyId(topologyId)));
}
public static InstanceIdentifier createTopologyNodeListPath(final NodeKey key, final String topologyId) {
return createTopologyListPath(topologyId)
.child(Node.class, new NodeKey(new NodeId(key.getNodeId().getValue())));
}
public static InstanceIdentifier createTopologyNodePath(final String topologyId) {
return createTopologyListPath(topologyId).child(Node.class);
}
public static DocumentedException createMasterIsDownException(final RemoteDeviceId id) {
return new DocumentedException(id + ":Master is down. Please try again.",
DocumentedException.ErrorType.APPLICATION, DocumentedException.ErrorTag.OPERATION_FAILED,
DocumentedException.ErrorSeverity.WARNING);
}
}