opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/entityownership/DistributedEntityOwnershipService.java

   1 /*
   2  * Copyright (c) 2015 Brocade Communications 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 package org.opendaylight.controller.cluster.datastore.entityownership;
   9
  10 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_OWNER_NODE_ID;
  11 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityPath;
  12 import akka.actor.ActorRef;
  13 import akka.dispatch.OnComplete;
  14 import akka.pattern.Patterns;
  15 import akka.util.Timeout;
  16 import com.google.common.annotations.VisibleForTesting;
  17 import com.google.common.base.Optional;
  18 import com.google.common.base.Preconditions;
  19 import com.google.common.base.Strings;
  20 import java.util.Collection;
  21 import java.util.concurrent.ConcurrentHashMap;
  22 import java.util.concurrent.ConcurrentMap;
  23 import java.util.concurrent.TimeUnit;
  24 import org.opendaylight.controller.cluster.datastore.DistributedDataStore;
  25 import org.opendaylight.controller.cluster.datastore.config.Configuration;
  26 import org.opendaylight.controller.cluster.datastore.config.ModuleShardConfiguration;
  27 import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterCandidateLocal;
  28 import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterListenerLocal;
  29 import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterCandidateLocal;
  30 import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterListenerLocal;
  31 import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
  32 import org.opendaylight.controller.cluster.datastore.messages.CreateShard;
  33 import org.opendaylight.controller.cluster.datastore.messages.GetShardDataTree;
  34 import org.opendaylight.controller.cluster.datastore.shardstrategy.ModuleShardStrategy;
  35 import org.opendaylight.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException;
  36 import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
  37 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration;
  38 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener;
  39 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListenerRegistration;
  40 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
  41 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipState;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.clustering.entity.owners.rev150804.EntityOwners;
  43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  44 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  45 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  46 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  47 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50 import scala.concurrent.Await;
  51 import scala.concurrent.Future;
  52 import scala.concurrent.duration.Duration;
  53
  54 /**
  55  * The distributed implementation of the EntityOwnershipService.
  56  *
  57  * @author Thomas Pantelis
  58  */
  59 public class DistributedEntityOwnershipService implements EntityOwnershipService, AutoCloseable {
  60     private static final Logger LOG = LoggerFactory.getLogger(DistributedEntityOwnershipService.class);
  61     static final String ENTITY_OWNERSHIP_SHARD_NAME = "entity-ownership";
  62     private static final Timeout MESSAGE_TIMEOUT = new Timeout(1, TimeUnit.MINUTES);
  63
  64     private final DistributedDataStore datastore;
  65     private final ConcurrentMap<Entity, Entity> registeredEntities = new ConcurrentHashMap<>();
  66     private volatile ActorRef localEntityOwnershipShard;
  67     private volatile DataTree localEntityOwnershipShardDataTree;
  68
  69     public DistributedEntityOwnershipService(DistributedDataStore datastore) {
  70         this.datastore = datastore;
  71     }
  72
  73     public void start() {
  74         ActorRef shardManagerActor = datastore.getActorContext().getShardManager();
  75
  76         Configuration configuration = datastore.getActorContext().getConfiguration();
  77         Collection<String> entityOwnersMemberNames = configuration.getUniqueMemberNamesForAllShards();
  78         CreateShard createShard = new CreateShard(new ModuleShardConfiguration(EntityOwners.QNAME.getNamespace(),
  79                 "entity-owners", ENTITY_OWNERSHIP_SHARD_NAME, ModuleShardStrategy.NAME, entityOwnersMemberNames),
  80                         newShardBuilder(), null);
  81
  82         Future<Object> createFuture = datastore.getActorContext().executeOperationAsync(shardManagerActor,
  83                 createShard, MESSAGE_TIMEOUT);
  84
  85         createFuture.onComplete(new OnComplete<Object>() {
  86             @Override
  87             public void onComplete(Throwable failure, Object response) {
  88                 if(failure != null) {
  89                     LOG.error("Failed to create {} shard", ENTITY_OWNERSHIP_SHARD_NAME);
  90                 } else {
  91                     LOG.info("Successfully created {} shard", ENTITY_OWNERSHIP_SHARD_NAME);
  92                 }
  93             }
  94         }, datastore.getActorContext().getClientDispatcher());
  95     }
  96
  97     private void executeEntityOwnershipShardOperation(final ActorRef shardActor, final Object message) {
  98         Future<Object> future = datastore.getActorContext().executeOperationAsync(shardActor, message, MESSAGE_TIMEOUT);
  99         future.onComplete(new OnComplete<Object>() {
 100             @Override
 101             public void onComplete(Throwable failure, Object response) {
 102                 if(failure != null) {
 103                     LOG.debug("Error sending message {} to {}", message, shardActor, failure);
 104                 } else {
 105                     LOG.debug("{} message to {} succeeded", message, shardActor, failure);
 106                 }
 107             }
 108         }, datastore.getActorContext().getClientDispatcher());
 109     }
 110
 111     private void executeLocalEntityOwnershipShardOperation(final Object message) {
 112         if(localEntityOwnershipShard == null) {
 113             Future<ActorRef> future = datastore.getActorContext().findLocalShardAsync(ENTITY_OWNERSHIP_SHARD_NAME);
 114             future.onComplete(new OnComplete<ActorRef>() {
 115                 @Override
 116                 public void onComplete(Throwable failure, ActorRef shardActor) {
 117                     if(failure != null) {
 118                         LOG.error("Failed to find local {} shard", ENTITY_OWNERSHIP_SHARD_NAME, failure);
 119                     } else {
 120                         localEntityOwnershipShard = shardActor;
 121                         executeEntityOwnershipShardOperation(localEntityOwnershipShard, message);
 122                     }
 123                 }
 124             }, datastore.getActorContext().getClientDispatcher());
 125
 126         } else {
 127             executeEntityOwnershipShardOperation(localEntityOwnershipShard, message);
 128         }
 129     }
 130
 131     @Override
 132     public EntityOwnershipCandidateRegistration registerCandidate(Entity entity)
 133             throws CandidateAlreadyRegisteredException {
 134         Preconditions.checkNotNull(entity, "entity cannot be null");
 135
 136         if(registeredEntities.putIfAbsent(entity, entity) != null) {
 137             throw new CandidateAlreadyRegisteredException(entity);
 138         }
 139
 140         RegisterCandidateLocal registerCandidate = new RegisterCandidateLocal(entity);
 141
 142         LOG.debug("Registering candidate with message: {}", registerCandidate);
 143
 144         executeLocalEntityOwnershipShardOperation(registerCandidate);
 145         return new DistributedEntityOwnershipCandidateRegistration(entity, this);
 146     }
 147
 148     void unregisterCandidate(Entity entity) {
 149         LOG.debug("Unregistering candidate for {}", entity);
 150
 151         executeLocalEntityOwnershipShardOperation(new UnregisterCandidateLocal(entity));
 152         registeredEntities.remove(entity);
 153     }
 154
 155     @Override
 156     public EntityOwnershipListenerRegistration registerListener(String entityType, EntityOwnershipListener listener) {
 157         Preconditions.checkNotNull(entityType, "entityType cannot be null");
 158         Preconditions.checkNotNull(listener, "listener cannot be null");
 159
 160         RegisterListenerLocal registerListener = new RegisterListenerLocal(listener, entityType);
 161
 162         LOG.debug("Registering listener with message: {}", registerListener);
 163
 164         executeLocalEntityOwnershipShardOperation(registerListener);
 165         return new DistributedEntityOwnershipListenerRegistration(listener, entityType, this);
 166     }
 167
 168     @Override
 169     public Optional<EntityOwnershipState> getOwnershipState(Entity forEntity) {
 170         Preconditions.checkNotNull(forEntity, "forEntity cannot be null");
 171
 172         DataTree dataTree = getLocalEntityOwnershipShardDataTree();
 173         if(dataTree == null) {
 174             return Optional.absent();
 175         }
 176
 177         Optional<NormalizedNode<?, ?>> entityNode = dataTree.takeSnapshot().readNode(
 178                 entityPath(forEntity.getType(), forEntity.getId()));
 179         if(!entityNode.isPresent()) {
 180             return Optional.absent();
 181         }
 182
 183         String localMemberName = datastore.getActorContext().getCurrentMemberName();
 184         Optional<DataContainerChild<? extends PathArgument, ?>> ownerLeaf = ((MapEntryNode)entityNode.get()).
 185                 getChild(ENTITY_OWNER_NODE_ID);
 186         String owner = ownerLeaf.isPresent() ? ownerLeaf.get().getValue().toString() : null;
 187         boolean hasOwner = !Strings.isNullOrEmpty(owner);
 188         boolean isOwner = hasOwner && localMemberName.equals(owner);
 189
 190         return Optional.of(new EntityOwnershipState(isOwner, hasOwner));
 191     }
 192
 193     private DataTree getLocalEntityOwnershipShardDataTree() {
 194         if(localEntityOwnershipShardDataTree == null) {
 195             try {
 196                 if(localEntityOwnershipShard == null) {
 197                     localEntityOwnershipShard = Await.result(datastore.getActorContext().findLocalShardAsync(
 198                             ENTITY_OWNERSHIP_SHARD_NAME), Duration.Inf());
 199                 }
 200
 201                 localEntityOwnershipShardDataTree = (DataTree) Await.result(Patterns.ask(localEntityOwnershipShard,
 202                         GetShardDataTree.INSTANCE, MESSAGE_TIMEOUT), Duration.Inf());
 203             } catch (Exception e) {
 204                 LOG.error("Failed to find local {} shard", ENTITY_OWNERSHIP_SHARD_NAME, e);
 205             }
 206         }
 207
 208         return localEntityOwnershipShardDataTree;
 209     }
 210
 211     void unregisterListener(String entityType, EntityOwnershipListener listener) {
 212         LOG.debug("Unregistering listener {} for entity type {}", listener, entityType);
 213
 214         executeLocalEntityOwnershipShardOperation(new UnregisterListenerLocal(listener, entityType));
 215     }
 216
 217     @Override
 218     public void close() {
 219     }
 220
 221     protected EntityOwnershipShard.Builder newShardBuilder() {
 222         return EntityOwnershipShard.newBuilder().localMemberName(datastore.getActorContext().getCurrentMemberName())
 223                 .ownerSelectionStrategyConfig(EntityOwnerSelectionStrategyConfig.newBuilder().build());
 224     }
 225
 226     @VisibleForTesting
 227     ActorRef getLocalEntityOwnershipShard() {
 228         return localEntityOwnershipShard;
 229     }
 230 }