package org.opendaylight.controller.md.sal.common.api.clustering;
+import com.google.common.base.Optional;
import javax.annotation.Nonnull;
/**
*/
EntityOwnershipListenerRegistration registerListener(@Nonnull String entityType, @Nonnull EntityOwnershipListener listener);
+ /**
+ * Gets the current ownership state information for an entity.
+ *
+ * @param forEntity the entity to query.
+ * @return an Optional EntityOwnershipState whose instance is present if the entity is found
+ */
+ Optional<EntityOwnershipState> getOwnershipState(@Nonnull Entity forEntity);
}
--- /dev/null
+/*
+ * Copyright (c) 2015 Brocade Communications Systems, Inc. and others. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.controller.md.sal.common.api.clustering;
+
+/**
+ * A DTO that encapsulates ownership state for an entity.
+ *
+ * @author Thomas Pantelis
+ */
+public class EntityOwnershipState {
+ private final boolean isOwner;
+ private final boolean hasOwner;
+
+ public EntityOwnershipState(boolean isOwner, boolean hasOwner) {
+ this.isOwner = isOwner;
+ this.hasOwner = hasOwner;
+ }
+
+ /**
+ * Returns the current ownership status of the entity for this process instance.
+ * @return true if this process is the owner of the entity
+ */
+ public boolean isOwner() {
+ return isOwner;
+ }
+
+ /**
+ * Returns the current ownership status of the entity across all process instances.
+ * @return true if the entity has an owner which may or may not be this process. If false, then
+ * the entity has no candidates and thus no owner.
+ */
+ public boolean hasOwner() {
+ return hasOwner;
+ }
+
+ @Override
+ public String toString() {
+ return "EntityOwnershipState [isOwner=" + isOwner + ", hasOwner=" + hasOwner + "]";
+ }
+}
import org.opendaylight.controller.cluster.datastore.messages.CreateTransaction;
import org.opendaylight.controller.cluster.datastore.messages.CreateTransactionReply;
import org.opendaylight.controller.cluster.datastore.messages.ForwardedReadyTransaction;
+import org.opendaylight.controller.cluster.datastore.messages.GetShardDataTree;
import org.opendaylight.controller.cluster.datastore.messages.PeerAddressResolved;
import org.opendaylight.controller.cluster.datastore.messages.ReadyLocalTransaction;
import org.opendaylight.controller.cluster.datastore.messages.RegisterChangeListener;
context().parent().tell(message, self());
} else if(GET_SHARD_MBEAN_MESSAGE.equals(message)){
sender().tell(getShardMBean(), self());
+ } else if(message instanceof GetShardDataTree){
+ sender().tell(store.getDataTree(), self());
} else {
super.onReceiveCommand(message);
}
*/
package org.opendaylight.controller.cluster.datastore.entityownership;
+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 org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterCandidateLocal;
import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterListenerLocal;
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.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.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.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.
private final DistributedDataStore datastore;
private final ConcurrentMap<Entity, Entity> registeredEntities = new ConcurrentHashMap<>();
private volatile ActorRef localEntityOwnershipShard;
+ private volatile DataTree localEntityOwnershipShardDataTree;
public DistributedEntityOwnershipService(DistributedDataStore datastore) {
this.datastore = datastore;
return new DistributedEntityOwnershipListenerRegistration(listener, entityType, this);
}
+ @Override
+ public Optional<EntityOwnershipState> getOwnershipState(Entity forEntity) {
+ Preconditions.checkNotNull(forEntity, "forEntity cannot be null");
+
+ DataTree dataTree = getLocalEntityOwnershipShardDataTree();
+ if(dataTree == null) {
+ return Optional.absent();
+ }
+
+ Optional<NormalizedNode<?, ?>> entityNode = dataTree.takeSnapshot().readNode(
+ entityPath(forEntity.getType(), forEntity.getId()));
+ if(!entityNode.isPresent()) {
+ return Optional.absent();
+ }
+
+ String localMemberName = datastore.getActorContext().getCurrentMemberName();
+ Optional<DataContainerChild<? extends PathArgument, ?>> ownerLeaf = ((MapEntryNode)entityNode.get()).
+ 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);
+
+ return Optional.of(new EntityOwnershipState(isOwner, hasOwner));
+ }
+
+ private DataTree getLocalEntityOwnershipShardDataTree() {
+ if(localEntityOwnershipShardDataTree == null) {
+ try {
+ if(localEntityOwnershipShard == null) {
+ localEntityOwnershipShard = Await.result(datastore.getActorContext().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(String entityType, EntityOwnershipListener listener) {
LOG.debug("Unregistering listener {} for entity type {}", listener, entityType);
return ImmutableNodes.mapEntry(Candidate.QNAME, CANDIDATE_NAME_QNAME, candidateName);
}
- static NormalizedNode<?, ?> entityEntryWithOwner(YangInstanceIdentifier entityId, String owner) {
+ static MapEntryNode entityEntryWithOwner(YangInstanceIdentifier entityId, String owner) {
return ImmutableNodes.mapEntryBuilder(ENTITY_QNAME, ENTITY_ID_QNAME, entityId).addChild(
ImmutableNodes.leafNode(ENTITY_OWNER_QNAME, owner)).build();
}
--- /dev/null
+/*
+ * Copyright (c) 2015 Brocade Communications Systems, Inc. and others. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.controller.cluster.datastore.messages;
+
+/**
+ * Local message sent to a Shard to retrieve its data tree instance.
+ *
+ * @author Thomas Pantelis
+ */
+public class GetShardDataTree {
+ public static final GetShardDataTree INSTANCE = new GetShardDataTree();
+
+ private GetShardDataTree() {
+ }
+}
import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener;
+import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipState;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.clustering.entity.owners.rev150804.entity.owners.entity.type.entity.Candidate;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
reset(leaderMockListener, follower1MockListener);
+ verifyGetOwnershipState(leaderEntityOwnershipService, ENTITY1, true, true);
+ verifyGetOwnershipState(follower1EntityOwnershipService, ENTITY1, false, true);
+
// Register leader candidate for entity1_2 (same id, different type) and verify it becomes owner
leaderEntityOwnershipService.registerCandidate(ENTITY1_2);
verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, false));
}
+ private void verifyGetOwnershipState(DistributedEntityOwnershipService service, Entity entity,
+ boolean isOwner, boolean hasOwner) {
+ Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
+ assertEquals("getOwnershipState present", true, state.isPresent());
+ assertEquals("isOwner", isOwner, state.get().isOwner());
+ assertEquals("hasOwner", hasOwner, state.get().hasOwner());
+ }
+
private void verifyCandidates(DistributedDataStore dataStore, Entity entity, String... expCandidates) throws Exception {
AssertionError lastError = null;
Stopwatch sw = Stopwatch.createStarted();
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.mockito.Mockito.mock;
+import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_ID_QNAME;
+import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_OWNERS_PATH;
+import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_QNAME;
+import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityEntryWithOwner;
+import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityOwnersWithEntityTypeEntry;
+import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityPath;
+import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityTypeEntryWithEntityEntry;
import akka.actor.ActorRef;
import akka.actor.PoisonPill;
import akka.actor.Props;
import com.google.common.base.Function;
+import com.google.common.base.Optional;
import com.google.common.util.concurrent.Uninterruptibles;
import java.util.Collections;
import java.util.Map;
import org.junit.Test;
import org.opendaylight.controller.cluster.datastore.DatastoreContext;
import org.opendaylight.controller.cluster.datastore.DistributedDataStore;
+import org.opendaylight.controller.cluster.datastore.ShardDataTree;
import org.opendaylight.controller.cluster.datastore.config.Configuration;
import org.opendaylight.controller.cluster.datastore.config.ConfigurationImpl;
import org.opendaylight.controller.cluster.datastore.config.ModuleConfig;
import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterCandidateLocal;
import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterListenerLocal;
import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
+import org.opendaylight.controller.cluster.datastore.messages.GetShardDataTree;
import org.opendaylight.controller.cluster.datastore.utils.MockClusterWrapper;
import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
import org.opendaylight.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException;
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.EntityOwnershipState;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
+import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
import org.opendaylight.yangtools.yang.model.api.SchemaContext;
import scala.concurrent.Await;
import scala.concurrent.Future;
service.close();
}
+ @Test
+ public void testGetOwnershipState() throws Exception {
+ final TestShardPropsCreator shardPropsCreator = new TestShardPropsCreator();
+ DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore) {
+ @Override
+ protected EntityOwnershipShardPropsCreator newShardPropsCreator() {
+ return shardPropsCreator;
+ }
+ };
+
+ service.start();
+
+ ShardDataTree shardDataTree = new ShardDataTree(SchemaContextHelper.entityOwners());
+ shardPropsCreator.setDataTree(shardDataTree.getDataTree());
+
+ Entity entity1 = new Entity(ENTITY_TYPE, "one");
+ writeNode(ENTITY_OWNERS_PATH, entityOwnersWithEntityTypeEntry(entityTypeEntryWithEntityEntry(entity1.getType(),
+ entityEntryWithOwner(entity1.getId(), "member-1"))), shardDataTree);
+ verifyGetOwnershipState(service, entity1, true, true);
+
+ writeNode(entityPath(entity1.getType(), entity1.getId()), entityEntryWithOwner(entity1.getId(), "member-2"),
+ shardDataTree);
+ verifyGetOwnershipState(service, entity1, false, true);
+
+ writeNode(entityPath(entity1.getType(), entity1.getId()), entityEntryWithOwner(entity1.getId(), ""),
+ shardDataTree);
+ verifyGetOwnershipState(service, entity1, false, false);
+
+ Entity entity2 = new Entity(ENTITY_TYPE, "two");
+ Optional<EntityOwnershipState> state = service.getOwnershipState(entity2);
+ assertEquals("getOwnershipState present", false, state.isPresent());
+
+ writeNode(entityPath(entity2.getType(), entity2.getId()), ImmutableNodes.mapEntry(ENTITY_QNAME,
+ ENTITY_ID_QNAME, entity2.getId()), shardDataTree);
+ verifyGetOwnershipState(service, entity2, false, false);
+
+ service.close();
+ }
+
+ private void verifyGetOwnershipState(DistributedEntityOwnershipService service, Entity entity,
+ boolean isOwner, boolean hasOwner) {
+ Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
+ assertEquals("getOwnershipState present", true, state.isPresent());
+ assertEquals("isOwner", isOwner, state.get().isOwner());
+ assertEquals("hasOwner", hasOwner, state.get().hasOwner());
+ }
+
private void verifyEntityCandidate(ActorRef entityOwnershipShard, String entityType,
YangInstanceIdentifier entityId, String candidateName) {
verifyEntityCandidate(entityType, entityId, candidateName,
private final AtomicReference<CountDownLatch> messageReceived = new AtomicReference<>();
private final AtomicReference<Object> receivedMessage = new AtomicReference<>();
private final AtomicReference<Class<?>> messageClass = new AtomicReference<>();
+ private final AtomicReference<DataTree> dataTree = new AtomicReference<>();
@Override
public Props newProps(ShardIdentifier shardId, Map<String, String> peerAddresses,
DatastoreContext datastoreContext, SchemaContext schemaContext) {
return Props.create(TestEntityOwnershipShard.class, shardId, peerAddresses, datastoreContext,
- schemaContext, "member-1", messageClass, messageReceived, receivedMessage);
+ schemaContext, "member-1", messageClass, messageReceived, receivedMessage, dataTree);
}
@SuppressWarnings("unchecked")
receivedMessage.set(null);
messageClass.set(ofType);
}
+
+ void setDataTree(DataTree tree) {
+ this.dataTree.set(tree);
+ }
}
static class TestEntityOwnershipShard extends EntityOwnershipShard {
private final AtomicReference<CountDownLatch> messageReceived;
private final AtomicReference<Object> receivedMessage;
private final AtomicReference<Class<?>> messageClass;
+ private final AtomicReference<DataTree> dataTree;
protected TestEntityOwnershipShard(ShardIdentifier name, Map<String, String> peerAddresses,
DatastoreContext datastoreContext, SchemaContext schemaContext, String localMemberName,
AtomicReference<Class<?>> messageClass, AtomicReference<CountDownLatch> messageReceived,
- AtomicReference<Object> receivedMessage) {
+ AtomicReference<Object> receivedMessage, AtomicReference<DataTree> dataTree) {
super(name, peerAddresses, datastoreContext, schemaContext, localMemberName);
this.messageClass = messageClass;
this.messageReceived = messageReceived;
this.receivedMessage = receivedMessage;
+ this.dataTree = dataTree;
}
@Override
public void onReceiveCommand(final Object message) throws Exception {
try {
- super.onReceiveCommand(message);
+ if(dataTree.get() != null && message instanceof GetShardDataTree) {
+ sender().tell(dataTree.get(), self());
+ } else {
+ super.onReceiveCommand(message);
+ }
} finally {
Class<?> expMsgClass = messageClass.get();
if(expMsgClass != null && expMsgClass.equals(message.getClass())) {