opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/utils/ClusterUtils.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.controller.cluster.datastore.utils;
  10
  11 import org.opendaylight.controller.cluster.access.concepts.MemberName;
  12 import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
  13 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  14 import org.opendaylight.yangtools.yang.common.QName;
  15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  17 import org.slf4j.Logger;
  18 import org.slf4j.LoggerFactory;
  19
  20 /**
  21  * Utils for encoding prefix shard name.
  22  */
  23 public final class ClusterUtils {
  24     private static final Logger LOG = LoggerFactory.getLogger(ClusterUtils.class);
  25
  26     // id for the shard used to store prefix configuration
  27     public static final String PREFIX_CONFIG_SHARD_ID = "prefix-configuration-shard";
  28
  29     public static final QName PREFIX_SHARDS_QNAME =
  30             QName.create("urn:opendaylight:params:xml:ns:yang:controller:md:sal:clustering:prefix-shard-configuration",
  31                     "2017-01-10", "prefix-shards").intern();
  32     public static final QName SHARD_LIST_QNAME =
  33             QName.create(PREFIX_SHARDS_QNAME, "shard").intern();
  34     public static final QName SHARD_PREFIX_QNAME =
  35             QName.create(PREFIX_SHARDS_QNAME, "prefix").intern();
  36     public static final QName SHARD_REPLICAS_QNAME =
  37             QName.create(PREFIX_SHARDS_QNAME, "replicas").intern();
  38     public static final QName SHARD_REPLICA_QNAME =
  39             QName.create(PREFIX_SHARDS_QNAME, "replica").intern();
  40
  41     public static final YangInstanceIdentifier PREFIX_SHARDS_PATH =
  42             YangInstanceIdentifier.of(PREFIX_SHARDS_QNAME).toOptimized();
  43     public static final YangInstanceIdentifier SHARD_LIST_PATH =
  44             PREFIX_SHARDS_PATH.node(SHARD_LIST_QNAME).toOptimized();
  45
  46     private ClusterUtils() {
  47     }
  48
  49     public static ShardIdentifier getShardIdentifier(final MemberName memberName, final DOMDataTreeIdentifier prefix) {
  50         final String type;
  51         switch (prefix.getDatastoreType()) {
  52             case OPERATIONAL:
  53                 type = "operational";
  54                 break;
  55             case CONFIGURATION:
  56                 type = "config";
  57                 break;
  58             default:
  59                 type = prefix.getDatastoreType().name();
  60                 LOG.warn("Unknown data store type {}", type);
  61         }
  62
  63         return ShardIdentifier.create(getCleanShardName(prefix.getRootIdentifier()), memberName, type);
  64     }
  65
  66     /**
  67      * Returns an encoded shard name based on the provided path that should doesn't contain characters that cannot be
  68      * present in akka actor paths.
  69      *
  70      * @param path Path on which to base the shard name
  71      * @return encoded name that doesn't contain characters that cannot be in actor path.
  72      */
  73     public static String getCleanShardName(final YangInstanceIdentifier path) {
  74         if (path.isEmpty()) {
  75             return "default";
  76         }
  77
  78         final StringBuilder builder = new StringBuilder();
  79         // TODO need a better mapping that includes namespace, but we'll need to cleanup the string beforehand
  80         // we have to fight both javax and akka url path restrictions..
  81         path.getPathArguments().forEach(p -> {
  82             builder.append(p.getNodeType().getLocalName());
  83             if (p instanceof NodeIdentifierWithPredicates) {
  84                 builder.append("-key_");
  85                 ((NodeIdentifierWithPredicates) p).getKeyValues().forEach((key, value) -> {
  86                     builder.append(key.getLocalName());
  87                     builder.append(value);
  88                     builder.append("-");
  89                 });
  90                 builder.append("_");
  91             }
  92             builder.append("!");
  93         });
  94         return builder.toString();
  95     }
  96 }