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=1cb744670e7e5eb6e1c2e32f70e816b38f39bd2a;hp=af35ebdc0566decdb9aca231330a4332b11aef85;hb=02d2891da4b71fe01ea8027a88ac6ddd353c2bcd;hpb=30507b196fa240a4176ba12102ac0469280feff9 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 af35ebdc05..1cb744670e 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,103 +7,133 @@ */ package org.opendaylight.controller.cluster.datastore.entityownership; +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.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentMap; import java.util.concurrent.TimeUnit; -import org.opendaylight.controller.cluster.datastore.DistributedDataStore; +import javax.annotation.Nonnull; +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; +import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterListenerLocal; import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterCandidateLocal; +import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterListenerLocal; +import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig; 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.EntityOwnershipCandidate; -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.cluster.datastore.utils.ActorContext; +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; import org.slf4j.LoggerFactory; +import scala.concurrent.Await; import scala.concurrent.Future; +import scala.concurrent.duration.Duration; /** * The distributed implementation of the EntityOwnershipService. * * @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 ConcurrentMap registeredEntities = new ConcurrentHashMap<>(); + private final ConcurrentMap registeredEntities = new ConcurrentHashMap<>(); + private final ActorContext context; + private volatile ActorRef localEntityOwnershipShard; + private volatile DataTree localEntityOwnershipShardDataTree; - public DistributedEntityOwnershipService(DistributedDataStore datastore) { - this.datastore = datastore; + DistributedEntityOwnershipService(final ActorContext context) { + this.context = Preconditions.checkNotNull(context); } - public void start() { - ActorRef shardManagerActor = datastore.getActorContext().getShardManager(); + public static DistributedEntityOwnershipService start(final ActorContext 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), - newShardPropsCreator(), null); + newShardBuilder(context, strategyConfig), null); - Future createFuture = datastore.getActorContext().executeOperationAsync(shardManagerActor, + 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) { + public void onComplete(final Throwable failure, final Object response) { + if (failure != null) { LOG.debug("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) { 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); @@ -111,41 +141,117 @@ public class DistributedEntityOwnershipService implements EntityOwnershipService } @Override - public EntityOwnershipCandidateRegistration registerCandidate(Entity entity, EntityOwnershipCandidate candidate) + public DOMEntityOwnershipCandidateRegistration registerCandidate(final DOMEntity entity) throws CandidateAlreadyRegisteredException { + Preconditions.checkNotNull(entity, "entity cannot be null"); - EntityOwnershipCandidate currentCandidate = registeredEntities.putIfAbsent(entity, candidate); - if(currentCandidate != null) { - throw new CandidateAlreadyRegisteredException(entity, currentCandidate); + if (registeredEntities.putIfAbsent(entity, entity) != null) { + throw new CandidateAlreadyRegisteredException(entity); } - RegisterCandidateLocal registerCandidate = new RegisterCandidateLocal(candidate, entity); + RegisterCandidateLocal registerCandidate = new RegisterCandidateLocal(entity); LOG.debug("Registering candidate with message: {}", registerCandidate); executeLocalEntityOwnershipShardOperation(registerCandidate); - return new DistributedEntityOwnershipCandidateRegistration(candidate, entity, this); + return new DistributedEntityOwnershipCandidateRegistration(entity, this); } - void unregisterCandidate(Entity entity, EntityOwnershipCandidate entityOwnershipCandidate) { + void unregisterCandidate(final DOMEntity entity) { LOG.debug("Unregistering candidate for {}", entity); - executeLocalEntityOwnershipShardOperation(new UnregisterCandidateLocal(entityOwnershipCandidate, entity)); + executeLocalEntityOwnershipShardOperation(new UnregisterCandidateLocal(entity)); registeredEntities.remove(entity); } @Override - public EntityOwnershipListenerRegistration registerListener(Entity entity, EntityOwnershipListener listener) { - // TODO Auto-generated method stub - return null; + public DOMEntityOwnershipListenerRegistration registerListener(final String entityType, + final DOMEntityOwnershipListener listener) { + Preconditions.checkNotNull(entityType, "entityType cannot be null"); + Preconditions.checkNotNull(listener, "listener cannot be null"); + + RegisterListenerLocal registerListener = new RegisterListenerLocal(listener, entityType); + + LOG.debug("Registering listener with message: {}", registerListener); + + executeLocalEntityOwnershipShardOperation(registerListener); + return new DistributedEntityOwnershipListenerRegistration(listener, entityType, this); + } + + @Override + public Optional getOwnershipState(final DOMEntity forEntity) { + Preconditions.checkNotNull(forEntity, "forEntity cannot be null"); + + DataTree dataTree = getLocalEntityOwnershipShardDataTree(); + if (dataTree == null) { + return Optional.absent(); + } + + java.util.Optional> entityNode = dataTree.takeSnapshot().readNode( + entityPath(forEntity.getType(), forEntity.getIdentifier())); + if (!entityNode.isPresent()) { + return Optional.absent(); + } + + // Check if there are any candidates, if there are none we do not really have ownership state + final MapEntryNode entity = (MapEntryNode) entityNode.get(); + final java.util.Optional> optionalCandidates = + entity.getChild(CANDIDATE_NODE_ID); + final boolean hasCandidates = optionalCandidates.isPresent() + && ((MapNode) optionalCandidates.get()).getValue().size() > 0; + if (!hasCandidates) { + return Optional.absent(); + } + + MemberName localMemberName = context.getCurrentMemberName(); + java.util.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.getName().equals(owner); + + return Optional.of(EntityOwnershipState.from(isOwner, hasOwner)); + } + + @Override + public boolean isCandidateRegistered(@Nonnull final DOMEntity entity) { + return registeredEntities.get(entity) != null; + } + + @VisibleForTesting + @SuppressWarnings("checkstyle:IllegalCatch") + DataTree getLocalEntityOwnershipShardDataTree() { + if (localEntityOwnershipShardDataTree == null) { + try { + if (localEntityOwnershipShard == null) { + localEntityOwnershipShard = Await.result(context.findLocalShardAsync( + ENTITY_OWNERSHIP_SHARD_NAME), Duration.Inf()); + } + + localEntityOwnershipShardDataTree = (DataTree) Await.result(Patterns.ask(localEntityOwnershipShard, + GetShardDataTree.INSTANCE, MESSAGE_TIMEOUT), Duration.Inf()); + } catch (Exception e) { + LOG.error("Failed to find local {} shard", ENTITY_OWNERSHIP_SHARD_NAME, e); + } + } + + return localEntityOwnershipShardDataTree; + } + + void unregisterListener(final String entityType, final DOMEntityOwnershipListener listener) { + LOG.debug("Unregistering listener {} for entity type {}", listener, entityType); + + executeLocalEntityOwnershipShardOperation(new UnregisterListenerLocal(listener, entityType)); } @Override public void close() { } - protected EntityOwnershipShardPropsCreator newShardPropsCreator() { - return new EntityOwnershipShardPropsCreator(datastore.getActorContext().getCurrentMemberName()); + private static EntityOwnershipShard.Builder newShardBuilder(final ActorContext context, + final EntityOwnerSelectionStrategyConfig strategyConfig) { + return EntityOwnershipShard.newBuilder().localMemberName(context.getCurrentMemberName()) + .ownerSelectionStrategyConfig(strategyConfig); } @VisibleForTesting