2 * Copyright (c) 2015 Brocade Communications Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.cluster.datastore.entityownership;
10 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.CANDIDATE_NODE_ID;
11 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_OWNER_NODE_ID;
12 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityPath;
14 import akka.actor.ActorRef;
15 import akka.dispatch.OnComplete;
16 import akka.pattern.Patterns;
17 import akka.util.Timeout;
18 import com.google.common.annotations.VisibleForTesting;
19 import com.google.common.base.Preconditions;
20 import com.google.common.base.Strings;
21 import java.util.Collection;
22 import java.util.Optional;
23 import java.util.concurrent.ConcurrentHashMap;
24 import java.util.concurrent.ConcurrentMap;
25 import java.util.concurrent.TimeUnit;
26 import org.opendaylight.controller.cluster.access.concepts.MemberName;
27 import org.opendaylight.controller.cluster.datastore.config.Configuration;
28 import org.opendaylight.controller.cluster.datastore.config.ModuleShardConfiguration;
29 import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterCandidateLocal;
30 import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterListenerLocal;
31 import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterCandidateLocal;
32 import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterListenerLocal;
33 import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
34 import org.opendaylight.controller.cluster.datastore.messages.CreateShard;
35 import org.opendaylight.controller.cluster.datastore.messages.GetShardDataTree;
36 import org.opendaylight.controller.cluster.datastore.shardstrategy.ModuleShardStrategy;
37 import org.opendaylight.controller.cluster.datastore.utils.ActorUtils;
38 import org.opendaylight.mdsal.eos.common.api.CandidateAlreadyRegisteredException;
39 import org.opendaylight.mdsal.eos.common.api.EntityOwnershipState;
40 import org.opendaylight.mdsal.eos.dom.api.DOMEntity;
41 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipCandidateRegistration;
42 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListener;
43 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListenerRegistration;
44 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipService;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.clustering.entity.owners.rev150804.EntityOwners;
46 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
47 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
48 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
49 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
50 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
51 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
52 import org.slf4j.Logger;
53 import org.slf4j.LoggerFactory;
54 import scala.concurrent.Await;
55 import scala.concurrent.Future;
56 import scala.concurrent.duration.Duration;
59 * The distributed implementation of the EntityOwnershipService.
61 * @author Thomas Pantelis
63 public class DistributedEntityOwnershipService implements DOMEntityOwnershipService, AutoCloseable {
65 static final String ENTITY_OWNERSHIP_SHARD_NAME = "entity-ownership";
67 private static final Logger LOG = LoggerFactory.getLogger(DistributedEntityOwnershipService.class);
68 private static final Timeout MESSAGE_TIMEOUT = new Timeout(1, TimeUnit.MINUTES);
70 private final ConcurrentMap<DOMEntity, DOMEntity> registeredEntities = new ConcurrentHashMap<>();
71 private final ActorUtils context;
73 private volatile ActorRef localEntityOwnershipShard;
74 private volatile DataTree localEntityOwnershipShardDataTree;
76 DistributedEntityOwnershipService(final ActorUtils context) {
77 this.context = Preconditions.checkNotNull(context);
80 public static DistributedEntityOwnershipService start(final ActorUtils context,
81 final EntityOwnerSelectionStrategyConfig strategyConfig) {
82 ActorRef shardManagerActor = context.getShardManager();
84 Configuration configuration = context.getConfiguration();
85 Collection<MemberName> entityOwnersMemberNames = configuration.getUniqueMemberNamesForAllShards();
86 CreateShard createShard = new CreateShard(new ModuleShardConfiguration(EntityOwners.QNAME.getNamespace(),
87 "entity-owners", ENTITY_OWNERSHIP_SHARD_NAME, ModuleShardStrategy.NAME, entityOwnersMemberNames),
88 newShardBuilder(context, strategyConfig), null);
90 Future<Object> createFuture = context.executeOperationAsync(shardManagerActor,
91 createShard, MESSAGE_TIMEOUT);
93 createFuture.onComplete(new OnComplete<Object>() {
95 public void onComplete(final Throwable failure, final Object response) {
96 if (failure != null) {
97 LOG.error("Failed to create {} shard", ENTITY_OWNERSHIP_SHARD_NAME, failure);
99 LOG.info("Successfully created {} shard", ENTITY_OWNERSHIP_SHARD_NAME);
102 }, context.getClientDispatcher());
104 return new DistributedEntityOwnershipService(context);
107 private void executeEntityOwnershipShardOperation(final ActorRef shardActor, final Object message) {
108 Future<Object> future = context.executeOperationAsync(shardActor, message, MESSAGE_TIMEOUT);
109 future.onComplete(new OnComplete<Object>() {
111 public void onComplete(final Throwable failure, final Object response) {
112 if (failure != null) {
113 LOG.debug("Error sending message {} to {}", message, shardActor, failure);
115 LOG.debug("{} message to {} succeeded", message, shardActor);
118 }, context.getClientDispatcher());
122 void executeLocalEntityOwnershipShardOperation(final Object message) {
123 if (localEntityOwnershipShard == null) {
124 Future<ActorRef> future = context.findLocalShardAsync(ENTITY_OWNERSHIP_SHARD_NAME);
125 future.onComplete(new OnComplete<ActorRef>() {
127 public void onComplete(final Throwable failure, final ActorRef shardActor) {
128 if (failure != null) {
129 LOG.error("Failed to find local {} shard", ENTITY_OWNERSHIP_SHARD_NAME, failure);
131 localEntityOwnershipShard = shardActor;
132 executeEntityOwnershipShardOperation(localEntityOwnershipShard, message);
135 }, context.getClientDispatcher());
138 executeEntityOwnershipShardOperation(localEntityOwnershipShard, message);
143 public DOMEntityOwnershipCandidateRegistration registerCandidate(final DOMEntity entity)
144 throws CandidateAlreadyRegisteredException {
145 Preconditions.checkNotNull(entity, "entity cannot be null");
147 if (registeredEntities.putIfAbsent(entity, entity) != null) {
148 throw new CandidateAlreadyRegisteredException(entity);
151 RegisterCandidateLocal registerCandidate = new RegisterCandidateLocal(entity);
153 LOG.debug("Registering candidate with message: {}", registerCandidate);
155 executeLocalEntityOwnershipShardOperation(registerCandidate);
156 return new DistributedEntityOwnershipCandidateRegistration(entity, this);
159 void unregisterCandidate(final DOMEntity entity) {
160 LOG.debug("Unregistering candidate for {}", entity);
162 executeLocalEntityOwnershipShardOperation(new UnregisterCandidateLocal(entity));
163 registeredEntities.remove(entity);
167 public DOMEntityOwnershipListenerRegistration registerListener(final String entityType,
168 final DOMEntityOwnershipListener listener) {
169 Preconditions.checkNotNull(entityType, "entityType cannot be null");
170 Preconditions.checkNotNull(listener, "listener cannot be null");
172 RegisterListenerLocal registerListener = new RegisterListenerLocal(listener, entityType);
174 LOG.debug("Registering listener with message: {}", registerListener);
176 executeLocalEntityOwnershipShardOperation(registerListener);
177 return new DistributedEntityOwnershipListenerRegistration(listener, entityType, this);
181 public Optional<EntityOwnershipState> getOwnershipState(final DOMEntity forEntity) {
182 Preconditions.checkNotNull(forEntity, "forEntity cannot be null");
184 DataTree dataTree = getLocalEntityOwnershipShardDataTree();
185 if (dataTree == null) {
186 return Optional.empty();
189 Optional<NormalizedNode<?, ?>> entityNode = dataTree.takeSnapshot().readNode(
190 entityPath(forEntity.getType(), forEntity.getIdentifier()));
191 if (!entityNode.isPresent()) {
192 return Optional.empty();
195 // Check if there are any candidates, if there are none we do not really have ownership state
196 final MapEntryNode entity = (MapEntryNode) entityNode.get();
197 final Optional<DataContainerChild<? extends PathArgument, ?>> optionalCandidates =
198 entity.getChild(CANDIDATE_NODE_ID);
199 final boolean hasCandidates = optionalCandidates.isPresent()
200 && ((MapNode) optionalCandidates.get()).getValue().size() > 0;
201 if (!hasCandidates) {
202 return Optional.empty();
205 MemberName localMemberName = context.getCurrentMemberName();
206 Optional<DataContainerChild<? extends PathArgument, ?>> ownerLeaf = entity.getChild(ENTITY_OWNER_NODE_ID);
207 String owner = ownerLeaf.isPresent() ? ownerLeaf.get().getValue().toString() : null;
208 boolean hasOwner = !Strings.isNullOrEmpty(owner);
209 boolean isOwner = hasOwner && localMemberName.getName().equals(owner);
211 return Optional.of(EntityOwnershipState.from(isOwner, hasOwner));
215 public boolean isCandidateRegistered(final DOMEntity entity) {
216 return registeredEntities.get(entity) != null;
220 @SuppressWarnings("checkstyle:IllegalCatch")
221 DataTree getLocalEntityOwnershipShardDataTree() {
222 if (localEntityOwnershipShardDataTree == null) {
224 if (localEntityOwnershipShard == null) {
225 localEntityOwnershipShard = Await.result(context.findLocalShardAsync(
226 ENTITY_OWNERSHIP_SHARD_NAME), Duration.Inf());
229 localEntityOwnershipShardDataTree = (DataTree) Await.result(Patterns.ask(localEntityOwnershipShard,
230 GetShardDataTree.INSTANCE, MESSAGE_TIMEOUT), Duration.Inf());
231 } catch (Exception e) {
232 LOG.error("Failed to find local {} shard", ENTITY_OWNERSHIP_SHARD_NAME, e);
236 return localEntityOwnershipShardDataTree;
239 void unregisterListener(final String entityType, final DOMEntityOwnershipListener listener) {
240 LOG.debug("Unregistering listener {} for entity type {}", listener, entityType);
242 executeLocalEntityOwnershipShardOperation(new UnregisterListenerLocal(listener, entityType));
246 public void close() {
249 private static EntityOwnershipShard.Builder newShardBuilder(final ActorUtils context,
250 final EntityOwnerSelectionStrategyConfig strategyConfig) {
251 return EntityOwnershipShard.newBuilder().localMemberName(context.getCurrentMemberName())
252 .ownerSelectionStrategyConfig(strategyConfig);
256 ActorRef getLocalEntityOwnershipShard() {
257 return localEntityOwnershipShard;