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