X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-distributed-datastore%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fdatastore%2Fentityownership%2FDistributedEntityOwnershipService.java;h=42ac5a4e396971f49ee25f92cd91792f42f8f8b1;hp=f1d9b43aba35105c2098bf4910f2736302d9b73c;hb=bdce894fa73714aa9f68eadad3524cfc94dc71d2;hpb=a623206f49e3c376e1a8494ba584ea0018468f12 diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/entityownership/DistributedEntityOwnershipService.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/entityownership/DistributedEntityOwnershipService.java index f1d9b43aba..42ac5a4e39 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/entityownership/DistributedEntityOwnershipService.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/entityownership/DistributedEntityOwnershipService.java @@ -7,21 +7,23 @@ */ package org.opendaylight.controller.cluster.datastore.entityownership; +import static java.util.Objects.requireNonNull; +import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.CANDIDATE_NODE_ID; import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_OWNER_NODE_ID; import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityPath; + import akka.actor.ActorRef; import akka.dispatch.OnComplete; import akka.pattern.Patterns; import akka.util.Timeout; import com.google.common.annotations.VisibleForTesting; -import com.google.common.base.Optional; -import com.google.common.base.Preconditions; import com.google.common.base.Strings; import java.util.Collection; +import java.util.Optional; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentMap; import java.util.concurrent.TimeUnit; -import org.opendaylight.controller.cluster.datastore.DistributedDataStore; +import org.opendaylight.controller.cluster.access.concepts.MemberName; import org.opendaylight.controller.cluster.datastore.config.Configuration; import org.opendaylight.controller.cluster.datastore.config.ModuleShardConfiguration; import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterCandidateLocal; @@ -32,17 +34,19 @@ import org.opendaylight.controller.cluster.datastore.entityownership.selectionst import org.opendaylight.controller.cluster.datastore.messages.CreateShard; import org.opendaylight.controller.cluster.datastore.messages.GetShardDataTree; import org.opendaylight.controller.cluster.datastore.shardstrategy.ModuleShardStrategy; -import org.opendaylight.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException; -import org.opendaylight.controller.md.sal.common.api.clustering.Entity; -import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration; -import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener; -import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListenerRegistration; -import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService; -import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipState; +import org.opendaylight.controller.cluster.datastore.utils.ActorUtils; +import org.opendaylight.mdsal.eos.common.api.CandidateAlreadyRegisteredException; +import org.opendaylight.mdsal.eos.common.api.EntityOwnershipState; +import org.opendaylight.mdsal.eos.dom.api.DOMEntity; +import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipCandidateRegistration; +import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListener; +import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListenerRegistration; +import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipService; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.clustering.entity.owners.rev150804.EntityOwners; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument; import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild; import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode; +import org.opendaylight.yangtools.yang.data.api.schema.MapNode; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree; import org.slf4j.Logger; @@ -56,74 +60,79 @@ import scala.concurrent.duration.Duration; * * @author Thomas Pantelis */ -public class DistributedEntityOwnershipService implements EntityOwnershipService, AutoCloseable { - private static final Logger LOG = LoggerFactory.getLogger(DistributedEntityOwnershipService.class); +public class DistributedEntityOwnershipService implements DOMEntityOwnershipService, AutoCloseable { + @VisibleForTesting static final String ENTITY_OWNERSHIP_SHARD_NAME = "entity-ownership"; + + private static final Logger LOG = LoggerFactory.getLogger(DistributedEntityOwnershipService.class); private static final Timeout MESSAGE_TIMEOUT = new Timeout(1, TimeUnit.MINUTES); - private final DistributedDataStore datastore; - private final EntityOwnerSelectionStrategyConfig strategyConfig; - private final ConcurrentMap registeredEntities = new ConcurrentHashMap<>(); + private final ConcurrentMap registeredEntities = new ConcurrentHashMap<>(); + private final ActorUtils context; + private volatile ActorRef localEntityOwnershipShard; private volatile DataTree localEntityOwnershipShardDataTree; - public DistributedEntityOwnershipService(DistributedDataStore datastore, EntityOwnerSelectionStrategyConfig strategyConfig) { - this.datastore = Preconditions.checkNotNull(datastore); - this.strategyConfig = Preconditions.checkNotNull(strategyConfig); + DistributedEntityOwnershipService(final ActorUtils context) { + this.context = requireNonNull(context); } - public void start() { - ActorRef shardManagerActor = datastore.getActorContext().getShardManager(); + public static DistributedEntityOwnershipService start(final ActorUtils context, + final EntityOwnerSelectionStrategyConfig strategyConfig) { + ActorRef shardManagerActor = context.getShardManager(); - Configuration configuration = datastore.getActorContext().getConfiguration(); - Collection entityOwnersMemberNames = configuration.getUniqueMemberNamesForAllShards(); + Configuration configuration = context.getConfiguration(); + Collection entityOwnersMemberNames = configuration.getUniqueMemberNamesForAllShards(); CreateShard createShard = new CreateShard(new ModuleShardConfiguration(EntityOwners.QNAME.getNamespace(), "entity-owners", ENTITY_OWNERSHIP_SHARD_NAME, ModuleShardStrategy.NAME, entityOwnersMemberNames), - newShardBuilder(), null); - - Future createFuture = datastore.getActorContext().executeOperationAsync(shardManagerActor, - createShard, MESSAGE_TIMEOUT); + newShardBuilder(context, strategyConfig), null); + Future createFuture = context.executeOperationAsync(shardManagerActor, createShard, MESSAGE_TIMEOUT); createFuture.onComplete(new OnComplete() { @Override - public void onComplete(Throwable failure, Object response) { - if(failure != null) { - LOG.error("Failed to create {} shard", ENTITY_OWNERSHIP_SHARD_NAME); + public void onComplete(final Throwable failure, final Object response) { + if (failure != null) { + LOG.error("Failed to create {} shard", ENTITY_OWNERSHIP_SHARD_NAME, failure); } else { LOG.info("Successfully created {} shard", ENTITY_OWNERSHIP_SHARD_NAME); } } - }, datastore.getActorContext().getClientDispatcher()); + }, context.getClientDispatcher()); + + return new DistributedEntityOwnershipService(context); } private void executeEntityOwnershipShardOperation(final ActorRef shardActor, final Object message) { - Future future = datastore.getActorContext().executeOperationAsync(shardActor, message, MESSAGE_TIMEOUT); + Future future = context.executeOperationAsync(shardActor, message, MESSAGE_TIMEOUT); future.onComplete(new OnComplete() { @Override - public void onComplete(Throwable failure, Object response) { - if(failure != null) { - LOG.debug("Error sending message {} to {}", message, shardActor, failure); + public void onComplete(final Throwable failure, final Object response) { + if (failure != null) { + // FIXME: CONTROLLER-1904: reduce the severity to info once we have a retry mechanism + LOG.error("Error sending message {} to {}", message, shardActor, failure); } else { - LOG.debug("{} message to {} succeeded", message, shardActor, failure); + LOG.debug("{} message to {} succeeded", message, shardActor); } } - }, datastore.getActorContext().getClientDispatcher()); + }, context.getClientDispatcher()); } - private void executeLocalEntityOwnershipShardOperation(final Object message) { - if(localEntityOwnershipShard == null) { - Future future = datastore.getActorContext().findLocalShardAsync(ENTITY_OWNERSHIP_SHARD_NAME); + @VisibleForTesting + void executeLocalEntityOwnershipShardOperation(final Object message) { + if (localEntityOwnershipShard == null) { + Future future = context.findLocalShardAsync(ENTITY_OWNERSHIP_SHARD_NAME); future.onComplete(new OnComplete() { @Override - public void onComplete(Throwable failure, ActorRef shardActor) { - if(failure != null) { + public void onComplete(final Throwable failure, final ActorRef shardActor) { + if (failure != null) { + // FIXME: CONTROLLER-1904: reduce the severity to info once we have a retry mechanism LOG.error("Failed to find local {} shard", ENTITY_OWNERSHIP_SHARD_NAME, failure); } else { localEntityOwnershipShard = shardActor; executeEntityOwnershipShardOperation(localEntityOwnershipShard, message); } } - }, datastore.getActorContext().getClientDispatcher()); + }, context.getClientDispatcher()); } else { executeEntityOwnershipShardOperation(localEntityOwnershipShard, message); @@ -131,11 +140,11 @@ public class DistributedEntityOwnershipService implements EntityOwnershipService } @Override - public EntityOwnershipCandidateRegistration registerCandidate(Entity entity) + public DOMEntityOwnershipCandidateRegistration registerCandidate(final DOMEntity entity) throws CandidateAlreadyRegisteredException { - Preconditions.checkNotNull(entity, "entity cannot be null"); + requireNonNull(entity, "entity cannot be null"); - if(registeredEntities.putIfAbsent(entity, entity) != null) { + if (registeredEntities.putIfAbsent(entity, entity) != null) { throw new CandidateAlreadyRegisteredException(entity); } @@ -147,7 +156,7 @@ public class DistributedEntityOwnershipService implements EntityOwnershipService return new DistributedEntityOwnershipCandidateRegistration(entity, this); } - void unregisterCandidate(Entity entity) { + void unregisterCandidate(final DOMEntity entity) { LOG.debug("Unregistering candidate for {}", entity); executeLocalEntityOwnershipShardOperation(new UnregisterCandidateLocal(entity)); @@ -155,10 +164,8 @@ public class DistributedEntityOwnershipService implements EntityOwnershipService } @Override - public EntityOwnershipListenerRegistration registerListener(String entityType, EntityOwnershipListener listener) { - Preconditions.checkNotNull(entityType, "entityType cannot be null"); - Preconditions.checkNotNull(listener, "listener cannot be null"); - + public DOMEntityOwnershipListenerRegistration registerListener(final String entityType, + final DOMEntityOwnershipListener listener) { RegisterListenerLocal registerListener = new RegisterListenerLocal(listener, entityType); LOG.debug("Registering listener with message: {}", registerListener); @@ -168,35 +175,51 @@ public class DistributedEntityOwnershipService implements EntityOwnershipService } @Override - public Optional getOwnershipState(Entity forEntity) { - Preconditions.checkNotNull(forEntity, "forEntity cannot be null"); + public Optional getOwnershipState(final DOMEntity forEntity) { + requireNonNull(forEntity, "forEntity cannot be null"); DataTree dataTree = getLocalEntityOwnershipShardDataTree(); - if(dataTree == null) { - return Optional.absent(); + if (dataTree == null) { + return Optional.empty(); } Optional> entityNode = dataTree.takeSnapshot().readNode( - entityPath(forEntity.getType(), forEntity.getId())); - if(!entityNode.isPresent()) { - return Optional.absent(); + entityPath(forEntity.getType(), forEntity.getIdentifier())); + if (!entityNode.isPresent()) { + return Optional.empty(); + } + + // Check if there are any candidates, if there are none we do not really have ownership state + final MapEntryNode entity = (MapEntryNode) entityNode.get(); + final Optional> optionalCandidates = + entity.getChild(CANDIDATE_NODE_ID); + final boolean hasCandidates = optionalCandidates.isPresent() + && ((MapNode) optionalCandidates.get()).getValue().size() > 0; + if (!hasCandidates) { + return Optional.empty(); } - String localMemberName = datastore.getActorContext().getCurrentMemberName(); - Optional> ownerLeaf = ((MapEntryNode)entityNode.get()). - getChild(ENTITY_OWNER_NODE_ID); + MemberName localMemberName = context.getCurrentMemberName(); + Optional> ownerLeaf = entity.getChild(ENTITY_OWNER_NODE_ID); String owner = ownerLeaf.isPresent() ? ownerLeaf.get().getValue().toString() : null; boolean hasOwner = !Strings.isNullOrEmpty(owner); - boolean isOwner = hasOwner && localMemberName.equals(owner); + boolean isOwner = hasOwner && localMemberName.getName().equals(owner); - return Optional.of(new EntityOwnershipState(isOwner, hasOwner)); + return Optional.of(EntityOwnershipState.from(isOwner, hasOwner)); } - private DataTree getLocalEntityOwnershipShardDataTree() { - if(localEntityOwnershipShardDataTree == null) { + @Override + public boolean isCandidateRegistered(final DOMEntity entity) { + return registeredEntities.get(entity) != null; + } + + @VisibleForTesting + @SuppressWarnings("checkstyle:IllegalCatch") + DataTree getLocalEntityOwnershipShardDataTree() { + if (localEntityOwnershipShardDataTree == null) { try { - if(localEntityOwnershipShard == null) { - localEntityOwnershipShard = Await.result(datastore.getActorContext().findLocalShardAsync( + if (localEntityOwnershipShard == null) { + localEntityOwnershipShard = Await.result(context.findLocalShardAsync( ENTITY_OWNERSHIP_SHARD_NAME), Duration.Inf()); } @@ -210,7 +233,7 @@ public class DistributedEntityOwnershipService implements EntityOwnershipService return localEntityOwnershipShardDataTree; } - void unregisterListener(String entityType, EntityOwnershipListener listener) { + void unregisterListener(final String entityType, final DOMEntityOwnershipListener listener) { LOG.debug("Unregistering listener {} for entity type {}", listener, entityType); executeLocalEntityOwnershipShardOperation(new UnregisterListenerLocal(listener, entityType)); @@ -220,9 +243,10 @@ public class DistributedEntityOwnershipService implements EntityOwnershipService public void close() { } - protected EntityOwnershipShard.Builder newShardBuilder() { - return EntityOwnershipShard.newBuilder().localMemberName(datastore.getActorContext().getCurrentMemberName()) - .ownerSelectionStrategyConfig(this.strategyConfig); + private static EntityOwnershipShard.Builder newShardBuilder(final ActorUtils context, + final EntityOwnerSelectionStrategyConfig strategyConfig) { + return EntityOwnershipShard.newBuilder().localMemberName(context.getCurrentMemberName()) + .ownerSelectionStrategyConfig(strategyConfig); } @VisibleForTesting