netconf/netconf-topology-singleton/src/main/java/org/opendaylight/netconf/topology/singleton/impl/utils/NetconfTopologyUtils.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.netconf.topology.singleton.impl.utils;
  10
  11 import com.google.common.base.Strings;
  12 import java.io.File;
  13 import java.math.BigDecimal;
  14 import java.net.InetSocketAddress;
  15 import java.util.HashMap;
  16 import java.util.Map;
  17 import org.opendaylight.controller.config.util.xml.DocumentedException;
  18 import org.opendaylight.netconf.sal.connect.netconf.NetconfDevice;
  19 import org.opendaylight.netconf.sal.connect.netconf.NetconfStateSchemasResolverImpl;
  20 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  23 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  24 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  25 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  26 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  27 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  28 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  29 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  30 import org.opendaylight.yangtools.yang.binding.Identifier;
  31 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  32 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  33 import org.opendaylight.yangtools.yang.model.repo.api.SchemaContextFactory;
  34 import org.opendaylight.yangtools.yang.model.repo.api.SchemaRepository;
  35 import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceFilter;
  36 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
  37 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceRegistry;
  38 import org.opendaylight.yangtools.yang.model.repo.util.FilesystemSchemaSourceCache;
  39 import org.opendaylight.yangtools.yang.parser.repo.SharedSchemaRepository;
  40 import org.opendaylight.yangtools.yang.parser.rfc7950.repo.TextToASTTransformer;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 public final class NetconfTopologyUtils {
  45     private static Logger LOG = LoggerFactory.getLogger(NetconfTopologyUtils.class);
  46
  47     private static final String DEFAULT_SCHEMA_REPOSITORY_NAME = "sal-netconf-connector";
  48
  49     public static final long DEFAULT_REQUEST_TIMEOUT_MILLIS = 60000L;
  50     public static final int DEFAULT_KEEPALIVE_DELAY = 0;
  51     public static final boolean DEFAULT_RECONNECT_ON_CHANGED_SCHEMA = false;
  52     public static final int DEFAULT_CONCURRENT_RPC_LIMIT = 0;
  53     public static final int DEFAULT_MAX_CONNECTION_ATTEMPTS = 0;
  54     public static final int DEFAULT_BETWEEN_ATTEMPTS_TIMEOUT_MILLIS = 2000;
  55     public static final long DEFAULT_CONNECTION_TIMEOUT_MILLIS = 20000L;
  56     public static final BigDecimal DEFAULT_SLEEP_FACTOR = new BigDecimal(1.5);
  57
  58
  59     // The default cache directory relative to <code>CACHE_DIRECTORY</code>
  60
  61     public static final String DEFAULT_CACHE_DIRECTORY = "schema";
  62
  63     // Filesystem based caches are stored relative to the cache directory.
  64     public static final String CACHE_DIRECTORY = "cache";
  65
  66     // The qualified schema cache directory <code>cache/schema</code>
  67     public static final String QUALIFIED_DEFAULT_CACHE_DIRECTORY =
  68             CACHE_DIRECTORY + File.separator + DEFAULT_CACHE_DIRECTORY;
  69
  70     // The default schema repository in the case that one is not specified.
  71     public static final SharedSchemaRepository DEFAULT_SCHEMA_REPOSITORY =
  72             new SharedSchemaRepository(DEFAULT_SCHEMA_REPOSITORY_NAME);
  73
  74
  75      // The default <code>FilesystemSchemaSourceCache</code>, which stores cached files in <code>cache/schema</code>.
  76     public static final FilesystemSchemaSourceCache<YangTextSchemaSource> DEFAULT_CACHE =
  77             new FilesystemSchemaSourceCache<>(DEFAULT_SCHEMA_REPOSITORY, YangTextSchemaSource.class,
  78                     new File(QUALIFIED_DEFAULT_CACHE_DIRECTORY));
  79
  80     // The default factory for creating <code>SchemaContext</code> instances.
  81     public static final SchemaContextFactory DEFAULT_SCHEMA_CONTEXT_FACTORY =
  82             DEFAULT_SCHEMA_REPOSITORY.createSchemaContextFactory(SchemaSourceFilter.ALWAYS_ACCEPT);
  83
  84     /**
  85      * Keeps track of initialized Schema resources.  A Map is maintained in which the key represents the name
  86      * of the schema cache directory, and the value is a corresponding <code>SchemaResourcesDTO</code>.  The
  87      * <code>SchemaResourcesDTO</code> is essentially a container that allows for the extraction of the
  88      * <code>SchemaRegistry</code> and <code>SchemaContextFactory</code> which should be used for a particular
  89      * Netconf mount.  Access to <code>SCHEMA_RESOURCES_DTO_MAP</code> should be surrounded by appropriate
  90      * synchronization locks.
  91      */
  92     private static final Map<String, NetconfDevice.SchemaResourcesDTO> SCHEMA_RESOURCES_DTO_MAP = new HashMap<>();
  93
  94     // Initializes default constant instances for the case when the default schema repository
  95     // directory cache/schema is used.
  96     static {
  97         SCHEMA_RESOURCES_DTO_MAP.put(DEFAULT_CACHE_DIRECTORY,
  98                 new NetconfDevice.SchemaResourcesDTO(DEFAULT_SCHEMA_REPOSITORY, DEFAULT_SCHEMA_REPOSITORY,
  99                         DEFAULT_SCHEMA_CONTEXT_FACTORY, new NetconfStateSchemasResolverImpl()));
 100         DEFAULT_SCHEMA_REPOSITORY.registerSchemaSourceListener(DEFAULT_CACHE);
 101         DEFAULT_SCHEMA_REPOSITORY.registerSchemaSourceListener(
 102                 TextToASTTransformer.create(DEFAULT_SCHEMA_REPOSITORY, DEFAULT_SCHEMA_REPOSITORY));
 103     }
 104
 105     private NetconfTopologyUtils() {
 106
 107     }
 108
 109     public static NetconfDevice.SchemaResourcesDTO setupSchemaCacheDTO(final Node node) {
 110         final NetconfNode netconfNode = node.getAugmentation(NetconfNode.class);
 111         final String moduleSchemaCacheDirectory = netconfNode.getSchemaCacheDirectory();
 112         final RemoteDeviceId deviceId = createRemoteDeviceId(node.getNodeId(), netconfNode);
 113
 114         // Setup information related to the SchemaRegistry, SchemaResourceFactory, etc.
 115         NetconfDevice.SchemaResourcesDTO schemaResourcesDTO = null;
 116         // Only checks to ensure the String is not empty or null;  further checks related to directory accessibility
 117         // and file permissions are handled during the FilesystemSchemaSourceCache initialization.
 118         if (!Strings.isNullOrEmpty(moduleSchemaCacheDirectory)) {
 119             // If a custom schema cache directory is specified, create the backing DTO; otherwise, the SchemaRegistry
 120             // and SchemaContextFactory remain the default values.
 121             if (!moduleSchemaCacheDirectory.equals(DEFAULT_CACHE_DIRECTORY)) {
 122                 // Multiple modules may be created at once;  synchronize to avoid issues with data consistency among
 123                 // threads.
 124                 synchronized (SCHEMA_RESOURCES_DTO_MAP) {
 125                     // Look for the cached DTO to reuse SchemaRegistry and SchemaContextFactory variables if
 126                     // they already exist
 127                     schemaResourcesDTO = SCHEMA_RESOURCES_DTO_MAP.get(moduleSchemaCacheDirectory);
 128                     if (schemaResourcesDTO == null) {
 129                         schemaResourcesDTO = createSchemaResourcesDTO(moduleSchemaCacheDirectory);
 130                         schemaResourcesDTO.getSchemaRegistry().registerSchemaSourceListener(
 131                                 TextToASTTransformer.create((SchemaRepository) schemaResourcesDTO.getSchemaRegistry(),
 132                                         schemaResourcesDTO.getSchemaRegistry())
 133                         );
 134                         SCHEMA_RESOURCES_DTO_MAP.put(moduleSchemaCacheDirectory, schemaResourcesDTO);
 135                     }
 136                 }
 137                 LOG.info("{} : netconf connector will use schema cache directory {} instead of {}",
 138                         deviceId, moduleSchemaCacheDirectory, DEFAULT_CACHE_DIRECTORY);
 139             }
 140         }
 141
 142         if (schemaResourcesDTO == null) {
 143             synchronized (SCHEMA_RESOURCES_DTO_MAP) {
 144                 schemaResourcesDTO = SCHEMA_RESOURCES_DTO_MAP.get(DEFAULT_CACHE_DIRECTORY);
 145             }
 146             LOG.info("{} : using the default directory {}",
 147                     deviceId, QUALIFIED_DEFAULT_CACHE_DIRECTORY);
 148         }
 149
 150         return schemaResourcesDTO;
 151     }
 152
 153     /**
 154      * Creates the backing Schema classes for a particular directory.
 155      *
 156      * @param moduleSchemaCacheDirectory The string directory relative to "cache"
 157      * @return A DTO containing the Schema classes for the Netconf mount.
 158      */
 159     private static NetconfDevice.SchemaResourcesDTO createSchemaResourcesDTO(final String moduleSchemaCacheDirectory) {
 160         final SharedSchemaRepository repository = new SharedSchemaRepository(moduleSchemaCacheDirectory);
 161         final SchemaContextFactory schemaContextFactory
 162                 = repository.createSchemaContextFactory(SchemaSourceFilter.ALWAYS_ACCEPT);
 163
 164         final FilesystemSchemaSourceCache<YangTextSchemaSource> deviceCache =
 165                 createDeviceFilesystemCache(moduleSchemaCacheDirectory, repository);
 166         repository.registerSchemaSourceListener(deviceCache);
 167         return new NetconfDevice.SchemaResourcesDTO(repository, repository, schemaContextFactory,
 168                 new NetconfStateSchemasResolverImpl());
 169     }
 170
 171     /**
 172      * Creates a <code>FilesystemSchemaSourceCache</code> for the custom schema cache directory.
 173      *
 174      * @param schemaCacheDirectory The custom cache directory relative to "cache"
 175      * @return A <code>FilesystemSchemaSourceCache</code> for the custom schema cache directory
 176      */
 177     private static FilesystemSchemaSourceCache<YangTextSchemaSource> createDeviceFilesystemCache(
 178             final String schemaCacheDirectory, final SchemaSourceRegistry schemaRegistry) {
 179         final String relativeSchemaCacheDirectory =
 180                 NetconfTopologyUtils.CACHE_DIRECTORY + File.separator + schemaCacheDirectory;
 181         return new FilesystemSchemaSourceCache<>(schemaRegistry, YangTextSchemaSource.class,
 182                 new File(relativeSchemaCacheDirectory));
 183     }
 184
 185
 186     public static RemoteDeviceId createRemoteDeviceId(final NodeId nodeId, final NetconfNode node) {
 187         final IpAddress ipAddress = node.getHost().getIpAddress();
 188         final InetSocketAddress address = new InetSocketAddress(ipAddress.getIpv4Address() != null
 189                 ? ipAddress.getIpv4Address().getValue() : ipAddress.getIpv6Address().getValue(),
 190                 node.getPort().getValue());
 191         return new RemoteDeviceId(nodeId.getValue(), address);
 192     }
 193
 194     public static String createActorPath(final String masterMember, final String name) {
 195         return  masterMember + "/user/" + name;
 196     }
 197
 198     public static String createMasterActorName(final String name, final String masterAddress) {
 199         return masterAddress.replaceAll("//", "") + "_" + name;
 200     }
 201
 202     public static NodeId getNodeId(final InstanceIdentifier.PathArgument pathArgument) {
 203         if (pathArgument instanceof InstanceIdentifier.IdentifiableItem<?, ?>) {
 204
 205             final Identifier key = ((InstanceIdentifier.IdentifiableItem) pathArgument).getKey();
 206             if (key instanceof NodeKey) {
 207                 return ((NodeKey) key).getNodeId();
 208             }
 209         }
 210         throw new IllegalStateException("Unable to create NodeId from: " + pathArgument);
 211     }
 212
 213     public static KeyedInstanceIdentifier<Topology, TopologyKey> createTopologyListPath(final String topologyId) {
 214         final InstanceIdentifier<NetworkTopology> networkTopology = InstanceIdentifier.create(NetworkTopology.class);
 215         return networkTopology.child(Topology.class, new TopologyKey(new TopologyId(topologyId)));
 216     }
 217
 218     public static InstanceIdentifier<Node> createTopologyNodeListPath(final NodeKey key, final String topologyId) {
 219         return createTopologyListPath(topologyId)
 220                 .child(Node.class, new NodeKey(new NodeId(key.getNodeId().getValue())));
 221     }
 222
 223     public static InstanceIdentifier<Node> createTopologyNodePath(final String topologyId) {
 224         return createTopologyListPath(topologyId).child(Node.class);
 225     }
 226
 227     public static DocumentedException createMasterIsDownException(final RemoteDeviceId id) {
 228         return new DocumentedException(id + ":Master is down. Please try again.",
 229                 DocumentedException.ErrorType.APPLICATION, DocumentedException.ErrorTag.OPERATION_FAILED,
 230                 DocumentedException.ErrorSeverity.WARNING);
 231     }
 232 }