package org.opendaylight.controller.cluster.datastore.utils;
import static akka.pattern.Patterns.ask;
+
import akka.actor.ActorPath;
import akka.actor.ActorRef;
import akka.actor.ActorSelection;
@Override
public Throwable apply(Throwable failure) {
Throwable actualFailure = failure;
- if(failure instanceof AskTimeoutException) {
+ if (failure instanceof AskTimeoutException) {
// A timeout exception most likely means the shard isn't initialized.
actualFailure = new NotInitializedException(
- "Timed out trying to find the primary shard. Most likely cause is the " +
- "shard is not initialized yet.");
+ "Timed out trying to find the primary shard. Most likely cause is the "
+ + "shard is not initialized yet.");
}
return actualFailure;
private final Dispatchers dispatchers;
private volatile SchemaContext schemaContext;
+
+ // Used as a write memory barrier.
+ @SuppressWarnings("unused")
private volatile boolean updated;
- private final MetricRegistry metricRegistry = MetricsReporter.getInstance(DatastoreContext.METRICS_DOMAIN).getMetricsRegistry();
+
+ private final MetricRegistry metricRegistry = MetricsReporter.getInstance(DatastoreContext.METRICS_DOMAIN)
+ .getMetricsRegistry();
private final PrimaryShardInfoFutureCache primaryShardInfoCache;
private final ShardStrategyFactory shardStrategyFactory;
public void setSchemaContext(SchemaContext schemaContext) {
this.schemaContext = schemaContext;
- if(shardManager != null) {
+ if (shardManager != null) {
shardManager.tell(new UpdateSchemaContext(schemaContext), ActorRef.noSender());
}
}
updated = true;
- if(shardManager != null) {
+ if (shardManager != null) {
shardManager.tell(contextFactory, ActorRef.noSender());
}
}
public Future<PrimaryShardInfo> findPrimaryShardAsync(final String shardName) {
Future<PrimaryShardInfo> ret = primaryShardInfoCache.getIfPresent(shardName);
- if(ret != null){
+ if (ret != null) {
return ret;
}
Future<Object> future = executeOperationAsync(shardManager,
return future.transform(new Mapper<Object, PrimaryShardInfo>() {
@Override
- public PrimaryShardInfo checkedApply(Object response) throws Exception {
- if(response instanceof RemotePrimaryShardFound) {
+ public PrimaryShardInfo checkedApply(Object response) throws UnknownMessageException {
+ if (response instanceof RemotePrimaryShardFound) {
LOG.debug("findPrimaryShardAsync received: {}", response);
RemotePrimaryShardFound found = (RemotePrimaryShardFound)response;
return onPrimaryShardFound(shardName, found.getPrimaryPath(), found.getPrimaryVersion(), null);
- } else if(response instanceof LocalPrimaryShardFound) {
+ } else if (response instanceof LocalPrimaryShardFound) {
LOG.debug("findPrimaryShardAsync received: {}", response);
LocalPrimaryShardFound found = (LocalPrimaryShardFound)response;
return onPrimaryShardFound(shardName, found.getPrimaryPath(), DataStoreVersions.CURRENT_VERSION,
found.getLocalShardDataTree());
- } else if(response instanceof NotInitializedException) {
+ } else if (response instanceof NotInitializedException) {
throw (NotInitializedException)response;
- } else if(response instanceof PrimaryNotFoundException) {
+ } else if (response instanceof PrimaryNotFoundException) {
throw (PrimaryNotFoundException)response;
- } else if(response instanceof NoShardLeaderException) {
+ } else if (response instanceof NoShardLeaderException) {
throw (NoShardLeaderException)response;
}
}
/**
- * Finds a local shard given its shard name and return it's ActorRef
+ * Finds a local shard given its shard name and return it's ActorRef.
*
* @param shardName the name of the local shard that needs to be found
* @return a reference to a local shard actor which represents the shard
return future.map(new Mapper<Object, ActorRef>() {
@Override
public ActorRef checkedApply(Object response) throws Throwable {
- if(response instanceof LocalShardFound) {
+ if (response instanceof LocalShardFound) {
LocalShardFound found = (LocalShardFound)response;
LOG.debug("Local shard found {}", found.getPath());
return found.getPath();
- } else if(response instanceof NotInitializedException) {
+ } else if (response instanceof NotInitializedException) {
throw (NotInitializedException)response;
- } else if(response instanceof LocalShardNotFound) {
+ } else if (response instanceof LocalShardNotFound) {
throw new LocalShardNotFoundException(
String.format("Local shard for %s does not exist.", shardName));
}
}
/**
- * Executes an operation on a local actor and wait for it's response
+ * Executes an operation on a local actor and wait for it's response.
*
- * @param actor
- * @param message
+ * @param actor the actor
+ * @param message the message to send
* @return The response of the operation
*/
+ @SuppressWarnings("checkstyle:IllegalCatch")
public Object executeOperation(ActorRef actor, Object message) {
Future<Object> future = executeOperationAsync(actor, message, operationTimeout);
try {
return Await.result(future, operationDuration);
} catch (Exception e) {
- throw new TimeoutException("Sending message " + message.getClass().toString() +
- " to actor " + actor.toString() + " failed. Try again later.", e);
+ throw new TimeoutException("Sending message " + message.getClass().toString()
+ + " to actor " + actor.toString() + " failed. Try again later.", e);
}
}
- public Future<Object> executeOperationAsync(ActorRef actor, Object message, Timeout timeout) {
- Preconditions.checkArgument(actor != null, "actor must not be null");
- Preconditions.checkArgument(message != null, "message must not be null");
-
- LOG.debug("Sending message {} to {}", message.getClass(), actor);
- return doAsk(actor, message, timeout);
- }
-
/**
- * Execute an operation on a remote actor and wait for it's response
+ * Execute an operation on a remote actor and wait for it's response.
*
- * @param actor
- * @param message
- * @return
+ * @param actor the actor
+ * @param message the message
+ * @return the response message
*/
+ @SuppressWarnings("checkstyle:IllegalCatch")
public Object executeOperation(ActorSelection actor, Object message) {
Future<Object> future = executeOperationAsync(actor, message);
try {
return Await.result(future, operationDuration);
} catch (Exception e) {
- throw new TimeoutException("Sending message " + message.getClass().toString() +
- " to actor " + actor.toString() + " failed. Try again later.", e);
+ throw new TimeoutException("Sending message " + message.getClass().toString()
+ + " to actor " + actor.toString() + " failed. Try again later.", e);
}
}
+ public Future<Object> executeOperationAsync(ActorRef actor, Object message, Timeout timeout) {
+ Preconditions.checkArgument(actor != null, "actor must not be null");
+ Preconditions.checkArgument(message != null, "message must not be null");
+
+ LOG.debug("Sending message {} to {}", message.getClass(), actor);
+ return doAsk(actor, message, timeout);
+ }
+
/**
* Execute an operation on a remote actor asynchronously.
*
actor.tell(message, ActorRef.noSender());
}
+ @SuppressWarnings("checkstyle:IllegalCatch")
public void shutdown() {
FiniteDuration duration = datastoreContext.getShardRaftConfig().getElectionTimeOutInterval().$times(3);
try {
Await.ready(Patterns.gracefulStop(shardManager, duration, Shutdown.INSTANCE), duration);
- } catch(Exception e) {
+ } catch (Exception e) {
LOG.warn("ShardManager for {} data store did not shutdown gracefully", getDataStoreName(), e);
}
}
return clusterWrapper;
}
- public MemberName getCurrentMemberName(){
+ public MemberName getCurrentMemberName() {
return clusterWrapper.getCurrentMemberName();
}
/**
- * Send the message to each and every shard
- *
- * @param message
+ * Send the message to each and every shard.
*/
- public void broadcast(final Function<Short, Object> messageSupplier){
- for(final String shardName : configuration.getAllShardNames()){
+ public void broadcast(final Function<Short, Object> messageSupplier, Class<?> messageClass) {
+ for (final String shardName : configuration.getAllShardNames()) {
Future<PrimaryShardInfo> primaryFuture = findPrimaryShardAsync(shardName);
primaryFuture.onComplete(new OnComplete<PrimaryShardInfo>() {
@Override
public void onComplete(Throwable failure, PrimaryShardInfo primaryShardInfo) {
- Object message = messageSupplier.apply(primaryShardInfo.getPrimaryShardVersion());
- if(failure != null) {
+ if (failure != null) {
LOG.warn("broadcast failed to send message {} to shard {}: {}",
- message.getClass().getSimpleName(), shardName, failure);
+ messageClass.getSimpleName(), shardName, failure);
} else {
+ Object message = messageSupplier.apply(primaryShardInfo.getPrimaryShardVersion());
primaryShardInfo.getPrimaryShardActor().tell(message, ActorRef.noSender());
}
}
* This is a utility method that lets us get a Timer object for any operation. This is a little open-ended to allow
* us to create a timer for pretty much anything.
*
- * @param operationName
- * @return
+ * @param operationName the name of the operation
+ * @return the Timer instance
*/
- public Timer getOperationTimer(String operationName){
+ public Timer getOperationTimer(String operationName) {
return getOperationTimer(datastoreContext.getDataStoreName(), operationName);
}
- public Timer getOperationTimer(String dataStoreType, String operationName){
+ public Timer getOperationTimer(String dataStoreType, String operationName) {
final String rate = MetricRegistry.name(DISTRIBUTED_DATA_STORE_METRIC_REGISTRY, dataStoreType,
operationName, METRIC_RATE);
return metricRegistry.timer(rate);
}
/**
- * Get the name of the data store to which this ActorContext belongs
+ * Get the name of the data store to which this ActorContext belongs.
*
- * @return
+ * @return the data store name
*/
public String getDataStoreName() {
return datastoreContext.getDataStoreName();
}
/**
- * Get the current transaction creation rate limit
- * @return
+ * Get the current transaction creation rate limit.
+ *
+ * @return the rate limit
*/
- public double getTxCreationLimit(){
+ public double getTxCreationLimit() {
return txRateLimiter.getTxCreationLimit();
}
/**
* Try to acquire a transaction creation permit. Will block if no permits are available.
*/
- public void acquireTxCreationPermit(){
+ public void acquireTxCreationPermit() {
txRateLimiter.acquire();
}
/**
- * Return the operation timeout to be used when committing transactions
- * @return
+ * Returns the operation timeout to be used when committing transactions.
+ *
+ * @return the operation timeout
*/
- public Timeout getTransactionCommitOperationTimeout(){
+ public Timeout getTransactionCommitOperationTimeout() {
return transactionCommitOperationTimeout;
}
/**
* An akka dispatcher that is meant to be used when processing ask Futures which were triggered by client
- * code on the datastore
- * @return
+ * code on the datastore.
+ *
+ * @return the dispatcher
*/
public ExecutionContext getClientDispatcher() {
return this.dispatchers.getDispatcher(Dispatchers.DispatcherType.Client);
}
- public String getNotificationDispatcherPath(){
+ public String getNotificationDispatcherPath() {
return this.dispatchers.getDispatcherPath(Dispatchers.DispatcherType.Notification);
}
return shardStrategyFactory;
}
- protected Future<Object> doAsk(ActorRef actorRef, Object message, Timeout timeout){
+ protected Future<Object> doAsk(ActorRef actorRef, Object message, Timeout timeout) {
return ask(actorRef, message, timeout);
}
- protected Future<Object> doAsk(ActorSelection actorRef, Object message, Timeout timeout){
+ protected Future<Object> doAsk(ActorSelection actorRef, Object message, Timeout timeout) {
return ask(actorRef, message, timeout);
}
Code Review / controller.git / blobdiff