opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/Shard.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.controller.cluster.datastore;
   9
  10 import akka.actor.ActorRef;
  11 import akka.actor.ActorSelection;
  12 import akka.actor.Cancellable;
  13 import akka.actor.ExtendedActorSystem;
  14 import akka.actor.Props;
  15 import akka.actor.Status;
  16 import akka.actor.Status.Failure;
  17 import akka.serialization.JavaSerializer;
  18 import akka.serialization.Serialization;
  19 import com.google.common.annotations.VisibleForTesting;
  20 import com.google.common.base.Optional;
  21 import com.google.common.base.Preconditions;
  22 import com.google.common.base.Ticker;
  23 import com.google.common.base.Verify;
  24 import com.google.common.collect.ImmutableList;
  25 import com.google.common.collect.ImmutableMap;
  26 import com.google.common.collect.Range;
  27 import java.io.IOException;
  28 import java.util.Arrays;
  29 import java.util.Collection;
  30 import java.util.Collections;
  31 import java.util.Map;
  32 import java.util.concurrent.TimeUnit;
  33 import javax.annotation.Nonnull;
  34 import javax.annotation.Nullable;
  35 import org.opendaylight.controller.cluster.access.ABIVersion;
  36 import org.opendaylight.controller.cluster.access.commands.ConnectClientRequest;
  37 import org.opendaylight.controller.cluster.access.commands.ConnectClientSuccess;
  38 import org.opendaylight.controller.cluster.access.commands.LocalHistoryRequest;
  39 import org.opendaylight.controller.cluster.access.commands.NotLeaderException;
  40 import org.opendaylight.controller.cluster.access.commands.OutOfSequenceEnvelopeException;
  41 import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
  42 import org.opendaylight.controller.cluster.access.concepts.ClientIdentifier;
  43 import org.opendaylight.controller.cluster.access.concepts.FrontendIdentifier;
  44 import org.opendaylight.controller.cluster.access.concepts.LocalHistoryIdentifier;
  45 import org.opendaylight.controller.cluster.access.concepts.Request;
  46 import org.opendaylight.controller.cluster.access.concepts.RequestEnvelope;
  47 import org.opendaylight.controller.cluster.access.concepts.RequestException;
  48 import org.opendaylight.controller.cluster.access.concepts.RequestSuccess;
  49 import org.opendaylight.controller.cluster.access.concepts.RetiredGenerationException;
  50 import org.opendaylight.controller.cluster.access.concepts.RuntimeRequestException;
  51 import org.opendaylight.controller.cluster.access.concepts.SliceableMessage;
  52 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  53 import org.opendaylight.controller.cluster.access.concepts.UnsupportedRequestException;
  54 import org.opendaylight.controller.cluster.common.actor.CommonConfig;
  55 import org.opendaylight.controller.cluster.common.actor.Dispatchers;
  56 import org.opendaylight.controller.cluster.common.actor.Dispatchers.DispatcherType;
  57 import org.opendaylight.controller.cluster.common.actor.MessageTracker;
  58 import org.opendaylight.controller.cluster.common.actor.MessageTracker.Error;
  59 import org.opendaylight.controller.cluster.common.actor.MeteringBehavior;
  60 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
  61 import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
  62 import org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard.ShardDataTreeListenerInfoMXBeanImpl;
  63 import org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard.ShardMBeanFactory;
  64 import org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard.ShardStats;
  65 import org.opendaylight.controller.cluster.datastore.messages.AbortTransaction;
  66 import org.opendaylight.controller.cluster.datastore.messages.ActorInitialized;
  67 import org.opendaylight.controller.cluster.datastore.messages.BatchedModifications;
  68 import org.opendaylight.controller.cluster.datastore.messages.CanCommitTransaction;
  69 import org.opendaylight.controller.cluster.datastore.messages.CloseTransactionChain;
  70 import org.opendaylight.controller.cluster.datastore.messages.CommitTransaction;
  71 import org.opendaylight.controller.cluster.datastore.messages.CreateTransaction;
  72 import org.opendaylight.controller.cluster.datastore.messages.CreateTransactionReply;
  73 import org.opendaylight.controller.cluster.datastore.messages.ForwardedReadyTransaction;
  74 import org.opendaylight.controller.cluster.datastore.messages.GetShardDataTree;
  75 import org.opendaylight.controller.cluster.datastore.messages.MakeLeaderLocal;
  76 import org.opendaylight.controller.cluster.datastore.messages.OnDemandShardState;
  77 import org.opendaylight.controller.cluster.datastore.messages.PeerAddressResolved;
  78 import org.opendaylight.controller.cluster.datastore.messages.PersistAbortTransactionPayload;
  79 import org.opendaylight.controller.cluster.datastore.messages.ReadyLocalTransaction;
  80 import org.opendaylight.controller.cluster.datastore.messages.RegisterDataTreeChangeListener;
  81 import org.opendaylight.controller.cluster.datastore.messages.ShardLeaderStateChanged;
  82 import org.opendaylight.controller.cluster.datastore.messages.UpdateSchemaContext;
  83 import org.opendaylight.controller.cluster.datastore.persisted.AbortTransactionPayload;
  84 import org.opendaylight.controller.cluster.datastore.persisted.DatastoreSnapshot;
  85 import org.opendaylight.controller.cluster.datastore.persisted.DatastoreSnapshot.ShardSnapshot;
  86 import org.opendaylight.controller.cluster.datastore.persisted.PurgeTransactionPayload;
  87 import org.opendaylight.controller.cluster.messaging.MessageAssembler;
  88 import org.opendaylight.controller.cluster.messaging.MessageSlicer;
  89 import org.opendaylight.controller.cluster.messaging.SliceOptions;
  90 import org.opendaylight.controller.cluster.notifications.LeaderStateChanged;
  91 import org.opendaylight.controller.cluster.notifications.RegisterRoleChangeListener;
  92 import org.opendaylight.controller.cluster.notifications.RoleChangeNotifier;
  93 import org.opendaylight.controller.cluster.raft.LeadershipTransferFailedException;
  94 import org.opendaylight.controller.cluster.raft.RaftActor;
  95 import org.opendaylight.controller.cluster.raft.RaftActorRecoveryCohort;
  96 import org.opendaylight.controller.cluster.raft.RaftActorSnapshotCohort;
  97 import org.opendaylight.controller.cluster.raft.RaftState;
  98 import org.opendaylight.controller.cluster.raft.base.messages.FollowerInitialSyncUpStatus;
  99 import org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState;
 100 import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
 101 import org.opendaylight.controller.cluster.raft.messages.RequestLeadership;
 102 import org.opendaylight.controller.cluster.raft.messages.ServerRemoved;
 103 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
 104 import org.opendaylight.yangtools.concepts.Identifier;
 105 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
 106 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
 107 import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType;
 108 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
 109 import org.opendaylight.yangtools.yang.model.api.SchemaContextProvider;
 110 import scala.concurrent.duration.FiniteDuration;
 111
 112 /**
 113  * A Shard represents a portion of the logical data tree.
 114  *
 115  * <p>
 116  * Our Shard uses InMemoryDataTree as it's internal representation and delegates all requests it
 117  */
 118 public class Shard extends RaftActor {
 119
 120     @VisibleForTesting
 121     static final Object TX_COMMIT_TIMEOUT_CHECK_MESSAGE = new Object() {
 122         @Override
 123         public String toString() {
 124             return "txCommitTimeoutCheck";
 125         }
 126     };
 127
 128     @VisibleForTesting
 129     static final Object GET_SHARD_MBEAN_MESSAGE = new Object() {
 130         @Override
 131         public String toString() {
 132             return "getShardMBeanMessage";
 133         }
 134     };
 135
 136     static final Object RESUME_NEXT_PENDING_TRANSACTION = new Object() {
 137         @Override
 138         public String toString() {
 139             return "resumeNextPendingTransaction";
 140         }
 141     };
 142
 143     // FIXME: shard names should be encapsulated in their own class and this should be exposed as a constant.
 144     public static final String DEFAULT_NAME = "default";
 145
 146     private static final Collection<ABIVersion> SUPPORTED_ABIVERSIONS;
 147
 148     static {
 149         final ABIVersion[] values = ABIVersion.values();
 150         final ABIVersion[] real = Arrays.copyOfRange(values, 1, values.length - 1);
 151         SUPPORTED_ABIVERSIONS = ImmutableList.copyOf(real).reverse();
 152     }
 153
 154     // FIXME: make this a dynamic property based on mailbox size and maximum number of clients
 155     private static final int CLIENT_MAX_MESSAGES = 1000;
 156
 157     // The state of this Shard
 158     private final ShardDataTree store;
 159
 160     /// The name of this shard
 161     private final String name;
 162
 163     private final String shardName;
 164
 165     private final ShardStats shardMBean;
 166
 167     private final ShardDataTreeListenerInfoMXBeanImpl listenerInfoMXBean;
 168
 169     private DatastoreContext datastoreContext;
 170
 171     private final ShardCommitCoordinator commitCoordinator;
 172
 173     private long transactionCommitTimeout;
 174
 175     private Cancellable txCommitTimeoutCheckSchedule;
 176
 177     private final Optional<ActorRef> roleChangeNotifier;
 178
 179     private final MessageTracker appendEntriesReplyTracker;
 180
 181     private final ShardTransactionActorFactory transactionActorFactory;
 182
 183     private final ShardSnapshotCohort snapshotCohort;
 184
 185     private final DataTreeChangeListenerSupport treeChangeSupport = new DataTreeChangeListenerSupport(this);
 186
 187     private ShardSnapshot restoreFromSnapshot;
 188
 189     private final ShardTransactionMessageRetrySupport messageRetrySupport;
 190
 191     private final FrontendMetadata frontendMetadata;
 192     private Map<FrontendIdentifier, LeaderFrontendState> knownFrontends = ImmutableMap.of();
 193     private boolean paused;
 194
 195     private final MessageSlicer responseMessageSlicer;
 196     private final Dispatchers dispatchers;
 197
 198     private final MessageAssembler requestMessageAssembler;
 199
 200     protected Shard(final AbstractBuilder<?, ?> builder) {
 201         super(builder.getId().toString(), builder.getPeerAddresses(),
 202                 Optional.of(builder.getDatastoreContext().getShardRaftConfig()), DataStoreVersions.CURRENT_VERSION);
 203
 204         this.name = builder.getId().toString();
 205         this.shardName = builder.getId().getShardName();
 206         this.datastoreContext = builder.getDatastoreContext();
 207         this.restoreFromSnapshot = builder.getRestoreFromSnapshot();
 208         this.frontendMetadata = new FrontendMetadata(name);
 209
 210         setPersistence(datastoreContext.isPersistent());
 211
 212         LOG.info("Shard created : {}, persistent : {}", name, datastoreContext.isPersistent());
 213
 214         ShardDataTreeChangeListenerPublisherActorProxy treeChangeListenerPublisher =
 215                 new ShardDataTreeChangeListenerPublisherActorProxy(getContext(), name + "-DTCL-publisher", name);
 216         if (builder.getDataTree() != null) {
 217             store = new ShardDataTree(this, builder.getSchemaContext(), builder.getDataTree(),
 218                     treeChangeListenerPublisher, name, frontendMetadata);
 219         } else {
 220             store = new ShardDataTree(this, builder.getSchemaContext(), builder.getTreeType(),
 221                     builder.getDatastoreContext().getStoreRoot(), treeChangeListenerPublisher, name, frontendMetadata);
 222         }
 223
 224         shardMBean = ShardMBeanFactory.getShardStatsMBean(name, datastoreContext.getDataStoreMXBeanType(), this);
 225
 226         if (isMetricsCaptureEnabled()) {
 227             getContext().become(new MeteringBehavior(this));
 228         }
 229
 230         commitCoordinator = new ShardCommitCoordinator(store, LOG, this.name);
 231
 232         setTransactionCommitTimeout();
 233
 234         // create a notifier actor for each cluster member
 235         roleChangeNotifier = createRoleChangeNotifier(name);
 236
 237         appendEntriesReplyTracker = new MessageTracker(AppendEntriesReply.class,
 238                 getRaftActorContext().getConfigParams().getIsolatedCheckIntervalInMillis());
 239
 240         dispatchers = new Dispatchers(context().system().dispatchers());
 241         transactionActorFactory = new ShardTransactionActorFactory(store, datastoreContext,
 242             dispatchers.getDispatcherPath(Dispatchers.DispatcherType.Transaction),
 243                 self(), getContext(), shardMBean, builder.getId().getShardName());
 244
 245         snapshotCohort = ShardSnapshotCohort.create(getContext(), builder.getId().getMemberName(), store, LOG,
 246             this.name);
 247
 248         messageRetrySupport = new ShardTransactionMessageRetrySupport(this);
 249
 250         responseMessageSlicer = MessageSlicer.builder().logContext(this.name)
 251                 .messageSliceSize(datastoreContext.getMaximumMessageSliceSize())
 252                 .fileBackedStreamFactory(getRaftActorContext().getFileBackedOutputStreamFactory())
 253                 .expireStateAfterInactivity(2, TimeUnit.MINUTES).build();
 254
 255         requestMessageAssembler = MessageAssembler.builder().logContext(this.name)
 256                 .fileBackedStreamFactory(getRaftActorContext().getFileBackedOutputStreamFactory())
 257                 .assembledMessageCallback((message, sender) -> self().tell(message, sender))
 258                 .expireStateAfterInactivity(datastoreContext.getRequestTimeout(), TimeUnit.NANOSECONDS).build();
 259
 260         listenerInfoMXBean = new ShardDataTreeListenerInfoMXBeanImpl(name, datastoreContext.getDataStoreMXBeanType(),
 261                 self());
 262         listenerInfoMXBean.register();
 263     }
 264
 265     private void setTransactionCommitTimeout() {
 266         transactionCommitTimeout = TimeUnit.MILLISECONDS.convert(
 267                 datastoreContext.getShardTransactionCommitTimeoutInSeconds(), TimeUnit.SECONDS) / 2;
 268     }
 269
 270     private Optional<ActorRef> createRoleChangeNotifier(final String shardId) {
 271         ActorRef shardRoleChangeNotifier = this.getContext().actorOf(
 272             RoleChangeNotifier.getProps(shardId), shardId + "-notifier");
 273         return Optional.of(shardRoleChangeNotifier);
 274     }
 275
 276     @Override
 277     public void postStop() {
 278         LOG.info("Stopping Shard {}", persistenceId());
 279
 280         super.postStop();
 281
 282         messageRetrySupport.close();
 283
 284         if (txCommitTimeoutCheckSchedule != null) {
 285             txCommitTimeoutCheckSchedule.cancel();
 286         }
 287
 288         commitCoordinator.abortPendingTransactions("Transaction aborted due to shutdown.", this);
 289
 290         shardMBean.unregisterMBean();
 291         listenerInfoMXBean.unregister();
 292     }
 293
 294     @Override
 295     protected void handleRecover(final Object message) {
 296         LOG.debug("{}: onReceiveRecover: Received message {} from {}", persistenceId(), message.getClass(),
 297             getSender());
 298
 299         super.handleRecover(message);
 300         if (LOG.isTraceEnabled()) {
 301             appendEntriesReplyTracker.begin();
 302         }
 303     }
 304
 305     @Override
 306     protected void handleNonRaftCommand(final Object message) {
 307         try (MessageTracker.Context context = appendEntriesReplyTracker.received(message)) {
 308             final Optional<Error> maybeError = context.error();
 309             if (maybeError.isPresent()) {
 310                 LOG.trace("{} : AppendEntriesReply failed to arrive at the expected interval {}", persistenceId(),
 311                     maybeError.get());
 312             }
 313
 314             store.resetTransactionBatch();
 315
 316             if (message instanceof RequestEnvelope) {
 317                 handleRequestEnvelope((RequestEnvelope)message);
 318             } else if (MessageAssembler.isHandledMessage(message)) {
 319                 handleRequestAssemblerMessage(message);
 320             } else if (message instanceof ConnectClientRequest) {
 321                 handleConnectClient((ConnectClientRequest)message);
 322             } else if (CreateTransaction.isSerializedType(message)) {
 323                 handleCreateTransaction(message);
 324             } else if (message instanceof BatchedModifications) {
 325                 handleBatchedModifications((BatchedModifications)message);
 326             } else if (message instanceof ForwardedReadyTransaction) {
 327                 handleForwardedReadyTransaction((ForwardedReadyTransaction) message);
 328             } else if (message instanceof ReadyLocalTransaction) {
 329                 handleReadyLocalTransaction((ReadyLocalTransaction)message);
 330             } else if (CanCommitTransaction.isSerializedType(message)) {
 331                 handleCanCommitTransaction(CanCommitTransaction.fromSerializable(message));
 332             } else if (CommitTransaction.isSerializedType(message)) {
 333                 handleCommitTransaction(CommitTransaction.fromSerializable(message));
 334             } else if (AbortTransaction.isSerializedType(message)) {
 335                 handleAbortTransaction(AbortTransaction.fromSerializable(message));
 336             } else if (CloseTransactionChain.isSerializedType(message)) {
 337                 closeTransactionChain(CloseTransactionChain.fromSerializable(message));
 338             } else if (message instanceof RegisterDataTreeChangeListener) {
 339                 treeChangeSupport.onMessage((RegisterDataTreeChangeListener) message, isLeader(), hasLeader());
 340             } else if (message instanceof UpdateSchemaContext) {
 341                 updateSchemaContext((UpdateSchemaContext) message);
 342             } else if (message instanceof PeerAddressResolved) {
 343                 PeerAddressResolved resolved = (PeerAddressResolved) message;
 344                 setPeerAddress(resolved.getPeerId(), resolved.getPeerAddress());
 345             } else if (TX_COMMIT_TIMEOUT_CHECK_MESSAGE.equals(message)) {
 346                 commitTimeoutCheck();
 347             } else if (message instanceof DatastoreContext) {
 348                 onDatastoreContext((DatastoreContext)message);
 349             } else if (message instanceof RegisterRoleChangeListener) {
 350                 roleChangeNotifier.get().forward(message, context());
 351             } else if (message instanceof FollowerInitialSyncUpStatus) {
 352                 shardMBean.setFollowerInitialSyncStatus(((FollowerInitialSyncUpStatus) message).isInitialSyncDone());
 353                 context().parent().tell(message, self());
 354             } else if (GET_SHARD_MBEAN_MESSAGE.equals(message)) {
 355                 sender().tell(getShardMBean(), self());
 356             } else if (message instanceof GetShardDataTree) {
 357                 sender().tell(store.getDataTree(), self());
 358             } else if (message instanceof ServerRemoved) {
 359                 context().parent().forward(message, context());
 360             } else if (ShardTransactionMessageRetrySupport.TIMER_MESSAGE_CLASS.isInstance(message)) {
 361                 messageRetrySupport.onTimerMessage(message);
 362             } else if (message instanceof DataTreeCohortActorRegistry.CohortRegistryCommand) {
 363                 store.processCohortRegistryCommand(getSender(),
 364                         (DataTreeCohortActorRegistry.CohortRegistryCommand) message);
 365             } else if (message instanceof PersistAbortTransactionPayload) {
 366                 final TransactionIdentifier txId = ((PersistAbortTransactionPayload) message).getTransactionId();
 367                 persistPayload(txId, AbortTransactionPayload.create(txId,
 368                     datastoreContext.getInitialPayloadSerializedBufferCapacity()), true);
 369                 persistPayload(txId, PurgeTransactionPayload.create(txId,
 370                     datastoreContext.getInitialPayloadSerializedBufferCapacity()), false);
 371             } else if (message instanceof MakeLeaderLocal) {
 372                 onMakeLeaderLocal();
 373             } else if (RESUME_NEXT_PENDING_TRANSACTION.equals(message)) {
 374                 store.resumeNextPendingTransaction();
 375             } else if (!responseMessageSlicer.handleMessage(message)) {
 376                 super.handleNonRaftCommand(message);
 377             }
 378         }
 379     }
 380
 381     private void handleRequestAssemblerMessage(final Object message) {
 382         dispatchers.getDispatcher(DispatcherType.Serialization).execute(() -> {
 383             JavaSerializer.currentSystem().value_$eq((ExtendedActorSystem) context().system());
 384             requestMessageAssembler.handleMessage(message, self());
 385         });
 386     }
 387
 388     @SuppressWarnings("checkstyle:IllegalCatch")
 389     private void handleRequestEnvelope(final RequestEnvelope envelope) {
 390         final long now = ticker().read();
 391         try {
 392             final RequestSuccess<?, ?> success = handleRequest(envelope, now);
 393             if (success != null) {
 394                 final long executionTimeNanos = ticker().read() - now;
 395                 if (success instanceof SliceableMessage) {
 396                     dispatchers.getDispatcher(DispatcherType.Serialization).execute(() ->
 397                         responseMessageSlicer.slice(SliceOptions.builder().identifier(success.getTarget())
 398                             .message(envelope.newSuccessEnvelope(success, executionTimeNanos))
 399                             .sendTo(envelope.getMessage().getReplyTo()).replyTo(self())
 400                             .onFailureCallback(t -> LOG.warn("Error slicing response {}", success, t)).build()));
 401                 } else {
 402                     envelope.sendSuccess(success, executionTimeNanos);
 403                 }
 404             }
 405         } catch (RequestException e) {
 406             LOG.debug("{}: request {} failed", persistenceId(), envelope, e);
 407             envelope.sendFailure(e, ticker().read() - now);
 408         } catch (Exception e) {
 409             LOG.debug("{}: request {} caused failure", persistenceId(), envelope, e);
 410             envelope.sendFailure(new RuntimeRequestException("Request failed to process", e),
 411                 ticker().read() - now);
 412         }
 413     }
 414
 415     private void commitTimeoutCheck() {
 416         store.checkForExpiredTransactions(transactionCommitTimeout, this::updateAccess);
 417         commitCoordinator.checkForExpiredTransactions(transactionCommitTimeout, this);
 418         requestMessageAssembler.checkExpiredAssembledMessageState();
 419     }
 420
 421     private Optional<Long> updateAccess(final SimpleShardDataTreeCohort cohort) {
 422         final FrontendIdentifier frontend = cohort.getIdentifier().getHistoryId().getClientId().getFrontendId();
 423         final LeaderFrontendState state = knownFrontends.get(frontend);
 424         if (state == null) {
 425             // Not tell-based protocol, do nothing
 426             return Optional.absent();
 427         }
 428
 429         if (isIsolatedLeader()) {
 430             // We are isolated and no new request can come through until we emerge from it. We are still updating
 431             // liveness of frontend when we see it attempting to communicate. Use the last access timer.
 432             return Optional.of(state.getLastSeenTicks());
 433         }
 434
 435         // If this frontend has freshly connected, give it some time to catch up before killing its transactions.
 436         return Optional.of(state.getLastConnectTicks());
 437     }
 438
 439     private void onMakeLeaderLocal() {
 440         LOG.debug("{}: onMakeLeaderLocal received", persistenceId());
 441         if (isLeader()) {
 442             getSender().tell(new Status.Success(null), getSelf());
 443             return;
 444         }
 445
 446         final ActorSelection leader = getLeader();
 447
 448         if (leader == null) {
 449             // Leader is not present. The cluster is most likely trying to
 450             // elect a leader and we should let that run its normal course
 451
 452             // TODO we can wait for the election to complete and retry the
 453             // request. We can also let the caller retry by sending a flag
 454             // in the response indicating the request is "reTryable".
 455             getSender().tell(new Failure(
 456                     new LeadershipTransferFailedException("We cannot initiate leadership transfer to local node. "
 457                             + "Currently there is no leader for " + persistenceId())),
 458                     getSelf());
 459             return;
 460         }
 461
 462         leader.tell(new RequestLeadership(getId(), getSender()), getSelf());
 463     }
 464
 465     // Acquire our frontend tracking handle and verify generation matches
 466     @Nullable
 467     private LeaderFrontendState findFrontend(final ClientIdentifier clientId) throws RequestException {
 468         final LeaderFrontendState existing = knownFrontends.get(clientId.getFrontendId());
 469         if (existing != null) {
 470             final int cmp = Long.compareUnsigned(existing.getIdentifier().getGeneration(), clientId.getGeneration());
 471             if (cmp == 0) {
 472                 existing.touch();
 473                 return existing;
 474             }
 475             if (cmp > 0) {
 476                 LOG.debug("{}: rejecting request from outdated client {}", persistenceId(), clientId);
 477                 throw new RetiredGenerationException(clientId.getGeneration(),
 478                     existing.getIdentifier().getGeneration());
 479             }
 480
 481             LOG.info("{}: retiring state {}, outdated by request from client {}", persistenceId(), existing, clientId);
 482             existing.retire();
 483             knownFrontends.remove(clientId.getFrontendId());
 484         } else {
 485             LOG.debug("{}: client {} is not yet known", persistenceId(), clientId);
 486         }
 487
 488         return null;
 489     }
 490
 491     private LeaderFrontendState getFrontend(final ClientIdentifier clientId) throws RequestException {
 492         final LeaderFrontendState ret = findFrontend(clientId);
 493         if (ret != null) {
 494             return ret;
 495         }
 496
 497         // TODO: a dedicated exception would be better, but this is technically true, too
 498         throw new OutOfSequenceEnvelopeException(0);
 499     }
 500
 501     @Nonnull
 502     private static ABIVersion selectVersion(final ConnectClientRequest message) {
 503         final Range<ABIVersion> clientRange = Range.closed(message.getMinVersion(), message.getMaxVersion());
 504         for (ABIVersion v : SUPPORTED_ABIVERSIONS) {
 505             if (clientRange.contains(v)) {
 506                 return v;
 507             }
 508         }
 509
 510         throw new IllegalArgumentException(String.format(
 511             "No common version between backend versions %s and client versions %s", SUPPORTED_ABIVERSIONS,
 512             clientRange));
 513     }
 514
 515     @SuppressWarnings("checkstyle:IllegalCatch")
 516     private void handleConnectClient(final ConnectClientRequest message) {
 517         try {
 518             final ClientIdentifier clientId = message.getTarget();
 519             final LeaderFrontendState existing = findFrontend(clientId);
 520             if (existing != null) {
 521                 existing.touch();
 522             }
 523
 524             if (!isLeader() || !isLeaderActive()) {
 525                 LOG.info("{}: not currently leader, rejecting request {}. isLeader: {}, isLeaderActive: {},"
 526                                 + "isLeadershipTransferInProgress: {}.",
 527                         persistenceId(), message, isLeader(), isLeaderActive(), isLeadershipTransferInProgress());
 528                 throw new NotLeaderException(getSelf());
 529             }
 530
 531             final ABIVersion selectedVersion = selectVersion(message);
 532             final LeaderFrontendState frontend;
 533             if (existing == null) {
 534                 frontend = new LeaderFrontendState(persistenceId(), clientId, store);
 535                 knownFrontends.put(clientId.getFrontendId(), frontend);
 536                 LOG.debug("{}: created state {} for client {}", persistenceId(), frontend, clientId);
 537             } else {
 538                 frontend = existing;
 539             }
 540
 541             frontend.reconnect();
 542             message.getReplyTo().tell(new ConnectClientSuccess(message.getTarget(), message.getSequence(), getSelf(),
 543                 ImmutableList.of(), store.getDataTree(), CLIENT_MAX_MESSAGES).toVersion(selectedVersion),
 544                 ActorRef.noSender());
 545         } catch (RequestException | RuntimeException e) {
 546             message.getReplyTo().tell(new Failure(e), ActorRef.noSender());
 547         }
 548     }
 549
 550     @Nullable
 551     private RequestSuccess<?, ?> handleRequest(final RequestEnvelope envelope, final long now)
 552             throws RequestException {
 553         // We are not the leader, hence we want to fail-fast.
 554         if (!isLeader() || paused || !isLeaderActive()) {
 555             LOG.debug("{}: not currently active leader, rejecting request {}. isLeader: {}, isLeaderActive: {},"
 556                             + "isLeadershipTransferInProgress: {}, paused: {}",
 557                     persistenceId(), envelope, isLeader(), isLeaderActive(), isLeadershipTransferInProgress(), paused);
 558             throw new NotLeaderException(getSelf());
 559         }
 560
 561         final Request<?, ?> request = envelope.getMessage();
 562         if (request instanceof TransactionRequest) {
 563             final TransactionRequest<?> txReq = (TransactionRequest<?>)request;
 564             final ClientIdentifier clientId = txReq.getTarget().getHistoryId().getClientId();
 565             return getFrontend(clientId).handleTransactionRequest(txReq, envelope, now);
 566         } else if (request instanceof LocalHistoryRequest) {
 567             final LocalHistoryRequest<?> lhReq = (LocalHistoryRequest<?>)request;
 568             final ClientIdentifier clientId = lhReq.getTarget().getClientId();
 569             return getFrontend(clientId).handleLocalHistoryRequest(lhReq, envelope, now);
 570         } else {
 571             LOG.warn("{}: rejecting unsupported request {}", persistenceId(), request);
 572             throw new UnsupportedRequestException(request);
 573         }
 574     }
 575
 576     private boolean hasLeader() {
 577         return getLeaderId() != null;
 578     }
 579
 580     public int getPendingTxCommitQueueSize() {
 581         return store.getQueueSize();
 582     }
 583
 584     public int getCohortCacheSize() {
 585         return commitCoordinator.getCohortCacheSize();
 586     }
 587
 588     @Override
 589     protected Optional<ActorRef> getRoleChangeNotifier() {
 590         return roleChangeNotifier;
 591     }
 592
 593     String getShardName() {
 594         return shardName;
 595     }
 596
 597     @Override
 598     protected LeaderStateChanged newLeaderStateChanged(final String memberId, final String leaderId,
 599             final short leaderPayloadVersion) {
 600         return isLeader() ? new ShardLeaderStateChanged(memberId, leaderId, store.getDataTree(), leaderPayloadVersion)
 601                 : new ShardLeaderStateChanged(memberId, leaderId, leaderPayloadVersion);
 602     }
 603
 604     protected void onDatastoreContext(final DatastoreContext context) {
 605         datastoreContext = context;
 606
 607         setTransactionCommitTimeout();
 608
 609         setPersistence(datastoreContext.isPersistent());
 610
 611         updateConfigParams(datastoreContext.getShardRaftConfig());
 612     }
 613
 614     // applyState() will be invoked once consensus is reached on the payload
 615     void persistPayload(final Identifier id, final Payload payload, final boolean batchHint) {
 616         boolean canSkipPayload = !hasFollowers() && !persistence().isRecoveryApplicable();
 617         if (canSkipPayload) {
 618             applyState(self(), id, payload);
 619         } else {
 620             // We are faking the sender
 621             persistData(self(), id, payload, batchHint);
 622         }
 623     }
 624
 625     private void handleCommitTransaction(final CommitTransaction commit) {
 626         if (isLeader()) {
 627             commitCoordinator.handleCommit(commit.getTransactionId(), getSender(), this);
 628         } else {
 629             ActorSelection leader = getLeader();
 630             if (leader == null) {
 631                 messageRetrySupport.addMessageToRetry(commit, getSender(),
 632                         "Could not commit transaction " + commit.getTransactionId());
 633             } else {
 634                 LOG.debug("{}: Forwarding CommitTransaction to leader {}", persistenceId(), leader);
 635                 leader.forward(commit, getContext());
 636             }
 637         }
 638     }
 639
 640     private void handleCanCommitTransaction(final CanCommitTransaction canCommit) {
 641         LOG.debug("{}: Can committing transaction {}", persistenceId(), canCommit.getTransactionId());
 642
 643         if (isLeader()) {
 644             commitCoordinator.handleCanCommit(canCommit.getTransactionId(), getSender(), this);
 645         } else {
 646             ActorSelection leader = getLeader();
 647             if (leader == null) {
 648                 messageRetrySupport.addMessageToRetry(canCommit, getSender(),
 649                         "Could not canCommit transaction " + canCommit.getTransactionId());
 650             } else {
 651                 LOG.debug("{}: Forwarding CanCommitTransaction to leader {}", persistenceId(), leader);
 652                 leader.forward(canCommit, getContext());
 653             }
 654         }
 655     }
 656
 657     @SuppressWarnings("checkstyle:IllegalCatch")
 658     protected void handleBatchedModificationsLocal(final BatchedModifications batched, final ActorRef sender) {
 659         try {
 660             commitCoordinator.handleBatchedModifications(batched, sender, this);
 661         } catch (Exception e) {
 662             LOG.error("{}: Error handling BatchedModifications for Tx {}", persistenceId(),
 663                     batched.getTransactionId(), e);
 664             sender.tell(new Failure(e), getSelf());
 665         }
 666     }
 667
 668     private void handleBatchedModifications(final BatchedModifications batched) {
 669         // This message is sent to prepare the modifications transaction directly on the Shard as an
 670         // optimization to avoid the extra overhead of a separate ShardTransaction actor. On the last
 671         // BatchedModifications message, the caller sets the ready flag in the message indicating
 672         // modifications are complete. The reply contains the cohort actor path (this actor) for the caller
 673         // to initiate the 3-phase commit. This also avoids the overhead of sending an additional
 674         // ReadyTransaction message.
 675
 676         // If we're not the leader then forward to the leader. This is a safety measure - we shouldn't
 677         // normally get here if we're not the leader as the front-end (TransactionProxy) should determine
 678         // the primary/leader shard. However with timing and caching on the front-end, there's a small
 679         // window where it could have a stale leader during leadership transitions.
 680         //
 681         boolean isLeaderActive = isLeaderActive();
 682         if (isLeader() && isLeaderActive) {
 683             handleBatchedModificationsLocal(batched, getSender());
 684         } else {
 685             ActorSelection leader = getLeader();
 686             if (!isLeaderActive || leader == null) {
 687                 messageRetrySupport.addMessageToRetry(batched, getSender(),
 688                         "Could not process BatchedModifications " + batched.getTransactionId());
 689             } else {
 690                 // If this is not the first batch and leadership changed in between batched messages,
 691                 // we need to reconstruct previous BatchedModifications from the transaction
 692                 // DataTreeModification, honoring the max batched modification count, and forward all the
 693                 // previous BatchedModifications to the new leader.
 694                 Collection<BatchedModifications> newModifications = commitCoordinator
 695                         .createForwardedBatchedModifications(batched,
 696                                 datastoreContext.getShardBatchedModificationCount());
 697
 698                 LOG.debug("{}: Forwarding {} BatchedModifications to leader {}", persistenceId(),
 699                         newModifications.size(), leader);
 700
 701                 for (BatchedModifications bm : newModifications) {
 702                     leader.forward(bm, getContext());
 703                 }
 704             }
 705         }
 706     }
 707
 708     private boolean failIfIsolatedLeader(final ActorRef sender) {
 709         if (isIsolatedLeader()) {
 710             sender.tell(new Failure(new NoShardLeaderException(String.format(
 711                     "Shard %s was the leader but has lost contact with all of its followers. Either all"
 712                     + " other follower nodes are down or this node is isolated by a network partition.",
 713                     persistenceId()))), getSelf());
 714             return true;
 715         }
 716
 717         return false;
 718     }
 719
 720     protected boolean isIsolatedLeader() {
 721         return getRaftState() == RaftState.IsolatedLeader;
 722     }
 723
 724     @SuppressWarnings("checkstyle:IllegalCatch")
 725     private void handleReadyLocalTransaction(final ReadyLocalTransaction message) {
 726         LOG.debug("{}: handleReadyLocalTransaction for {}", persistenceId(), message.getTransactionId());
 727
 728         boolean isLeaderActive = isLeaderActive();
 729         if (isLeader() && isLeaderActive) {
 730             try {
 731                 commitCoordinator.handleReadyLocalTransaction(message, getSender(), this);
 732             } catch (Exception e) {
 733                 LOG.error("{}: Error handling ReadyLocalTransaction for Tx {}", persistenceId(),
 734                         message.getTransactionId(), e);
 735                 getSender().tell(new Failure(e), getSelf());
 736             }
 737         } else {
 738             ActorSelection leader = getLeader();
 739             if (!isLeaderActive || leader == null) {
 740                 messageRetrySupport.addMessageToRetry(message, getSender(),
 741                         "Could not process ready local transaction " + message.getTransactionId());
 742             } else {
 743                 LOG.debug("{}: Forwarding ReadyLocalTransaction to leader {}", persistenceId(), leader);
 744                 message.setRemoteVersion(getCurrentBehavior().getLeaderPayloadVersion());
 745                 leader.forward(message, getContext());
 746             }
 747         }
 748     }
 749
 750     private void handleForwardedReadyTransaction(final ForwardedReadyTransaction forwardedReady) {
 751         LOG.debug("{}: handleForwardedReadyTransaction for {}", persistenceId(), forwardedReady.getTransactionId());
 752
 753         boolean isLeaderActive = isLeaderActive();
 754         if (isLeader() && isLeaderActive) {
 755             commitCoordinator.handleForwardedReadyTransaction(forwardedReady, getSender(), this);
 756         } else {
 757             ActorSelection leader = getLeader();
 758             if (!isLeaderActive || leader == null) {
 759                 messageRetrySupport.addMessageToRetry(forwardedReady, getSender(),
 760                         "Could not process forwarded ready transaction " + forwardedReady.getTransactionId());
 761             } else {
 762                 LOG.debug("{}: Forwarding ForwardedReadyTransaction to leader {}", persistenceId(), leader);
 763
 764                 ReadyLocalTransaction readyLocal = new ReadyLocalTransaction(forwardedReady.getTransactionId(),
 765                         forwardedReady.getTransaction().getSnapshot(), forwardedReady.isDoImmediateCommit(),
 766                         forwardedReady.getParticipatingShardNames());
 767                 readyLocal.setRemoteVersion(getCurrentBehavior().getLeaderPayloadVersion());
 768                 leader.forward(readyLocal, getContext());
 769             }
 770         }
 771     }
 772
 773     private void handleAbortTransaction(final AbortTransaction abort) {
 774         doAbortTransaction(abort.getTransactionId(), getSender());
 775     }
 776
 777     void doAbortTransaction(final Identifier transactionID, final ActorRef sender) {
 778         commitCoordinator.handleAbort(transactionID, sender, this);
 779     }
 780
 781     private void handleCreateTransaction(final Object message) {
 782         if (isLeader()) {
 783             createTransaction(CreateTransaction.fromSerializable(message));
 784         } else if (getLeader() != null) {
 785             getLeader().forward(message, getContext());
 786         } else {
 787             getSender().tell(new Failure(new NoShardLeaderException(
 788                     "Could not create a shard transaction", persistenceId())), getSelf());
 789         }
 790     }
 791
 792     private void closeTransactionChain(final CloseTransactionChain closeTransactionChain) {
 793         if (isLeader()) {
 794             final LocalHistoryIdentifier id = closeTransactionChain.getIdentifier();
 795             // FIXME: CONTROLLER-1628: stage purge once no transactions are present
 796             store.closeTransactionChain(id, null);
 797             store.purgeTransactionChain(id, null);
 798         } else if (getLeader() != null) {
 799             getLeader().forward(closeTransactionChain, getContext());
 800         } else {
 801             LOG.warn("{}: Could not close transaction {}", persistenceId(), closeTransactionChain.getIdentifier());
 802         }
 803     }
 804
 805     @SuppressWarnings("checkstyle:IllegalCatch")
 806     private void createTransaction(final CreateTransaction createTransaction) {
 807         try {
 808             if (TransactionType.fromInt(createTransaction.getTransactionType()) != TransactionType.READ_ONLY
 809                     && failIfIsolatedLeader(getSender())) {
 810                 return;
 811             }
 812
 813             ActorRef transactionActor = createTransaction(createTransaction.getTransactionType(),
 814                 createTransaction.getTransactionId());
 815
 816             getSender().tell(new CreateTransactionReply(Serialization.serializedActorPath(transactionActor),
 817                     createTransaction.getTransactionId(), createTransaction.getVersion()).toSerializable(), getSelf());
 818         } catch (Exception e) {
 819             getSender().tell(new Failure(e), getSelf());
 820         }
 821     }
 822
 823     private ActorRef createTransaction(final int transactionType, final TransactionIdentifier transactionId) {
 824         LOG.debug("{}: Creating transaction : {} ", persistenceId(), transactionId);
 825         return transactionActorFactory.newShardTransaction(TransactionType.fromInt(transactionType),
 826             transactionId);
 827     }
 828
 829     private void updateSchemaContext(final UpdateSchemaContext message) {
 830         updateSchemaContext(message.getSchemaContext());
 831     }
 832
 833     @VisibleForTesting
 834     void updateSchemaContext(final SchemaContext schemaContext) {
 835         store.updateSchemaContext(schemaContext);
 836     }
 837
 838     private boolean isMetricsCaptureEnabled() {
 839         CommonConfig config = new CommonConfig(getContext().system().settings().config());
 840         return config.isMetricCaptureEnabled();
 841     }
 842
 843     @Override
 844     @VisibleForTesting
 845     public RaftActorSnapshotCohort getRaftActorSnapshotCohort() {
 846         return snapshotCohort;
 847     }
 848
 849     @Override
 850     @Nonnull
 851     protected RaftActorRecoveryCohort getRaftActorRecoveryCohort() {
 852         if (restoreFromSnapshot == null) {
 853             return ShardRecoveryCoordinator.create(store, persistenceId(), LOG);
 854         }
 855
 856         return ShardRecoveryCoordinator.forSnapshot(store, persistenceId(), LOG, restoreFromSnapshot.getSnapshot());
 857     }
 858
 859     @Override
 860     protected void onRecoveryComplete() {
 861         restoreFromSnapshot = null;
 862
 863         //notify shard manager
 864         getContext().parent().tell(new ActorInitialized(), getSelf());
 865
 866         // Being paranoid here - this method should only be called once but just in case...
 867         if (txCommitTimeoutCheckSchedule == null) {
 868             // Schedule a message to be periodically sent to check if the current in-progress
 869             // transaction should be expired and aborted.
 870             FiniteDuration period = FiniteDuration.create(transactionCommitTimeout / 3, TimeUnit.MILLISECONDS);
 871             txCommitTimeoutCheckSchedule = getContext().system().scheduler().schedule(
 872                     period, period, getSelf(),
 873                     TX_COMMIT_TIMEOUT_CHECK_MESSAGE, getContext().dispatcher(), ActorRef.noSender());
 874         }
 875     }
 876
 877     @Override
 878     protected void applyState(final ActorRef clientActor, final Identifier identifier, final Object data) {
 879         if (data instanceof Payload) {
 880             try {
 881                 store.applyReplicatedPayload(identifier, (Payload)data);
 882             } catch (DataValidationFailedException | IOException e) {
 883                 LOG.error("{}: Error applying replica {}", persistenceId(), identifier, e);
 884             }
 885         } else {
 886             LOG.error("{}: Unknown state for {} received {}", persistenceId(), identifier, data);
 887         }
 888     }
 889
 890     @Override
 891     protected void onStateChanged() {
 892         boolean isLeader = isLeader();
 893         boolean hasLeader = hasLeader();
 894         treeChangeSupport.onLeadershipChange(isLeader, hasLeader);
 895
 896         // If this actor is no longer the leader close all the transaction chains
 897         if (!isLeader) {
 898             if (LOG.isDebugEnabled()) {
 899                 LOG.debug(
 900                     "{}: onStateChanged: Closing all transaction chains because shard {} is no longer the leader",
 901                     persistenceId(), getId());
 902             }
 903
 904             paused = false;
 905             store.purgeLeaderState();
 906         }
 907
 908         if (hasLeader && !isIsolatedLeader()) {
 909             messageRetrySupport.retryMessages();
 910         }
 911     }
 912
 913     @Override
 914     protected void onLeaderChanged(final String oldLeader, final String newLeader) {
 915         shardMBean.incrementLeadershipChangeCount();
 916         paused = false;
 917
 918         if (!isLeader()) {
 919             if (!knownFrontends.isEmpty()) {
 920                 LOG.debug("{}: removing frontend state for {}", persistenceId(), knownFrontends.keySet());
 921                 knownFrontends = ImmutableMap.of();
 922             }
 923
 924             requestMessageAssembler.close();
 925
 926             if (!hasLeader()) {
 927                 // No leader anywhere, nothing else to do
 928                 return;
 929             }
 930
 931             // Another leader was elected. If we were the previous leader and had pending transactions, convert
 932             // them to transaction messages and send to the new leader.
 933             ActorSelection leader = getLeader();
 934             if (leader != null) {
 935                 Collection<?> messagesToForward = convertPendingTransactionsToMessages();
 936
 937                 if (!messagesToForward.isEmpty()) {
 938                     LOG.debug("{}: Forwarding {} pending transaction messages to leader {}", persistenceId(),
 939                             messagesToForward.size(), leader);
 940
 941                     for (Object message : messagesToForward) {
 942                         LOG.debug("{}: Forwarding pending transaction message {}", persistenceId(), message);
 943
 944                         leader.tell(message, self());
 945                     }
 946                 }
 947             } else {
 948                 commitCoordinator.abortPendingTransactions("The transacton was aborted due to inflight leadership "
 949                         + "change and the leader address isn't available.", this);
 950             }
 951         } else {
 952             // We have become the leader, we need to reconstruct frontend state
 953             knownFrontends = Verify.verifyNotNull(frontendMetadata.toLeaderState(this));
 954             LOG.debug("{}: became leader with frontend state for {}", persistenceId(), knownFrontends.keySet());
 955         }
 956
 957         if (!isIsolatedLeader()) {
 958             messageRetrySupport.retryMessages();
 959         }
 960     }
 961
 962     /**
 963      * Clears all pending transactions and converts them to messages to be forwarded to a new leader.
 964      *
 965      * @return the converted messages
 966      */
 967     public Collection<?> convertPendingTransactionsToMessages() {
 968         return commitCoordinator.convertPendingTransactionsToMessages(
 969                 datastoreContext.getShardBatchedModificationCount());
 970     }
 971
 972     @Override
 973     protected void pauseLeader(final Runnable operation) {
 974         LOG.debug("{}: In pauseLeader, operation: {}", persistenceId(), operation);
 975         paused = true;
 976
 977         // Tell-based protocol can replay transaction state, so it is safe to blow it up when we are paused.
 978         knownFrontends.values().forEach(LeaderFrontendState::retire);
 979         knownFrontends = ImmutableMap.of();
 980
 981         store.setRunOnPendingTransactionsComplete(operation);
 982     }
 983
 984     @Override
 985     protected void unpauseLeader() {
 986         LOG.debug("{}: In unpauseLeader", persistenceId());
 987         paused = false;
 988
 989         store.setRunOnPendingTransactionsComplete(null);
 990
 991         // Restore tell-based protocol state as if we were becoming the leader
 992         knownFrontends = Verify.verifyNotNull(frontendMetadata.toLeaderState(this));
 993     }
 994
 995     @Override
 996     protected OnDemandRaftState.AbstractBuilder<?, ?> newOnDemandRaftStateBuilder() {
 997         return OnDemandShardState.newBuilder().treeChangeListenerActors(treeChangeSupport.getListenerActors())
 998                 .commitCohortActors(store.getCohortActors());
 999     }
1000
1001     @Override
1002     public String persistenceId() {
1003         return this.name;
1004     }
1005
1006     @VisibleForTesting
1007     ShardCommitCoordinator getCommitCoordinator() {
1008         return commitCoordinator;
1009     }
1010
1011     public DatastoreContext getDatastoreContext() {
1012         return datastoreContext;
1013     }
1014
1015     @VisibleForTesting
1016     public ShardDataTree getDataStore() {
1017         return store;
1018     }
1019
1020     @VisibleForTesting
1021     ShardStats getShardMBean() {
1022         return shardMBean;
1023     }
1024
1025     public static Builder builder() {
1026         return new Builder();
1027     }
1028
1029     public abstract static class AbstractBuilder<T extends AbstractBuilder<T, S>, S extends Shard> {
1030         private final Class<S> shardClass;
1031         private ShardIdentifier id;
1032         private Map<String, String> peerAddresses = Collections.emptyMap();
1033         private DatastoreContext datastoreContext;
1034         private SchemaContextProvider schemaContextProvider;
1035         private DatastoreSnapshot.ShardSnapshot restoreFromSnapshot;
1036         private DataTree dataTree;
1037         private volatile boolean sealed;
1038
1039         protected AbstractBuilder(final Class<S> shardClass) {
1040             this.shardClass = shardClass;
1041         }
1042
1043         protected void checkSealed() {
1044             Preconditions.checkState(!sealed, "Builder isalready sealed - further modifications are not allowed");
1045         }
1046
1047         @SuppressWarnings("unchecked")
1048         private T self() {
1049             return (T) this;
1050         }
1051
1052         public T id(final ShardIdentifier newId) {
1053             checkSealed();
1054             this.id = newId;
1055             return self();
1056         }
1057
1058         public T peerAddresses(final Map<String, String> newPeerAddresses) {
1059             checkSealed();
1060             this.peerAddresses = newPeerAddresses;
1061             return self();
1062         }
1063
1064         public T datastoreContext(final DatastoreContext newDatastoreContext) {
1065             checkSealed();
1066             this.datastoreContext = newDatastoreContext;
1067             return self();
1068         }
1069
1070         public T schemaContextProvider(final SchemaContextProvider newSchemaContextProvider) {
1071             checkSealed();
1072             this.schemaContextProvider = Preconditions.checkNotNull(newSchemaContextProvider);
1073             return self();
1074         }
1075
1076         public T restoreFromSnapshot(final DatastoreSnapshot.ShardSnapshot newRestoreFromSnapshot) {
1077             checkSealed();
1078             this.restoreFromSnapshot = newRestoreFromSnapshot;
1079             return self();
1080         }
1081
1082         public T dataTree(final DataTree newDataTree) {
1083             checkSealed();
1084             this.dataTree = newDataTree;
1085             return self();
1086         }
1087
1088         public ShardIdentifier getId() {
1089             return id;
1090         }
1091
1092         public Map<String, String> getPeerAddresses() {
1093             return peerAddresses;
1094         }
1095
1096         public DatastoreContext getDatastoreContext() {
1097             return datastoreContext;
1098         }
1099
1100         public SchemaContext getSchemaContext() {
1101             return Verify.verifyNotNull(schemaContextProvider.getSchemaContext());
1102         }
1103
1104         public DatastoreSnapshot.ShardSnapshot getRestoreFromSnapshot() {
1105             return restoreFromSnapshot;
1106         }
1107
1108         public DataTree getDataTree() {
1109             return dataTree;
1110         }
1111
1112         public TreeType getTreeType() {
1113             switch (datastoreContext.getLogicalStoreType()) {
1114                 case CONFIGURATION:
1115                     return TreeType.CONFIGURATION;
1116                 case OPERATIONAL:
1117                     return TreeType.OPERATIONAL;
1118                 default:
1119                     throw new IllegalStateException("Unhandled logical store type "
1120                             + datastoreContext.getLogicalStoreType());
1121             }
1122         }
1123
1124         protected void verify() {
1125             Preconditions.checkNotNull(id, "id should not be null");
1126             Preconditions.checkNotNull(peerAddresses, "peerAddresses should not be null");
1127             Preconditions.checkNotNull(datastoreContext, "dataStoreContext should not be null");
1128             Preconditions.checkNotNull(schemaContextProvider, "schemaContextProvider should not be null");
1129         }
1130
1131         public Props props() {
1132             sealed = true;
1133             verify();
1134             return Props.create(shardClass, this);
1135         }
1136     }
1137
1138     public static class Builder extends AbstractBuilder<Builder, Shard> {
1139         Builder() {
1140             super(Shard.class);
1141         }
1142     }
1143
1144     Ticker ticker() {
1145         return Ticker.systemTicker();
1146     }
1147
1148     void scheduleNextPendingTransaction() {
1149         self().tell(RESUME_NEXT_PENDING_TRANSACTION, ActorRef.noSender());
1150     }
1151 }