kafka.controller

ReplicaStateMachine

class ReplicaStateMachine extends Logging

This class represents the state machine for replicas. It defines the states that a replica can be in, and transitions to move the replica to another legal state. The different states that a replica can be in are - 1. NewReplica : The controller can create new replicas during partition reassignment. In this state, a replica can only get become follower state change request. Valid previous state is NonExistentReplica 2. OnlineReplica : Once a replica is started and part of the assigned replicas for its partition, it is in this state. In this state, it can get either become leader or become follower state change requests. Valid previous state are NewReplica, OnlineReplica or OfflineReplica 3. OfflineReplica : If a replica dies, it moves to this state. This happens when the broker hosting the replica is down. Valid previous state are NewReplica, OnlineReplica 4. ReplicaDeletionStarted: If replica deletion starts, it is moved to this state. Valid previous state is OfflineReplica 5. ReplicaDeletionSuccessful: If replica responds with no error code in response to a delete replica request, it is moved to this state. Valid previous state is ReplicaDeletionStarted 6. ReplicaDeletionIneligible: If replica deletion fails, it is moved to this state. Valid previous state is ReplicaDeletionStarted 7. NonExistentReplica: If a replica is deleted successfully, it is moved to this state. Valid previous state is ReplicaDeletionSuccessful

Inherited
  1. Hide All
  2. Show all
  1. Logging
  2. AnyRef
  3. Any
Visibility
  1. Public
  2. All

Instance constructors

  1. new ReplicaStateMachine(controller: KafkaController)

Type Members

  1. class BrokerChangeListener extends IZkChildListener with Logging

    This is the zookeeper listener that triggers all the state transitions for a replica

Value Members

  1. def !=(arg0: AnyRef): Boolean

    attributes: final
    definition classes: AnyRef
  2. def !=(arg0: Any): Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ##(): Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf[T0](): T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf[T0](): Boolean

    attributes: final
    definition classes: AnyRef
  6. def ==(arg0: AnyRef): Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def ==(arg0: Any): Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. def areAllReplicasForTopicDeleted(topic: String): Boolean

  9. def asInstanceOf[T0]: T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  10. val brokerRequestBatch: ControllerBrokerRequestBatch

  11. def clone(): AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  12. def debug(msg: ⇒ String, e: ⇒ Throwable): Unit

    definition classes: Logging
  13. def debug(e: ⇒ Throwable): Any

    definition classes: Logging
  14. def debug(msg: ⇒ String): Unit

    definition classes: Logging
  15. def eq(arg0: AnyRef): Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  16. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  17. def error(msg: ⇒ String, e: ⇒ Throwable): Unit

    definition classes: Logging
  18. def error(e: ⇒ Throwable): Any

    definition classes: Logging
  19. def error(msg: ⇒ String): Unit

    definition classes: Logging
  20. def fatal(msg: ⇒ String, e: ⇒ Throwable): Unit

    definition classes: Logging
  21. def fatal(e: ⇒ Throwable): Any

    definition classes: Logging
  22. def fatal(msg: ⇒ String): Unit

    definition classes: Logging
  23. def finalize(): Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  24. def getClass(): java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  25. def handleStateChange(partitionAndReplica: PartitionAndReplica, targetState: ReplicaState, callbacks: Callbacks): Unit

    This API exercises the replica's state machine.

    This API exercises the replica's state machine. It ensures that every state transition happens from a legal previous state to the target state. Valid state transitions are: NonExistentReplica --> NewReplica --send LeaderAndIsr request with current leader and isr to the new replica and UpdateMetadata request for the partition to every live broker

    NewReplica -> OnlineReplica --add the new replica to the assigned replica list if needed

    OnlineReplica,OfflineReplica -> OnlineReplica --send LeaderAndIsr request with current leader and isr to the new replica and UpdateMetadata request for the partition to every live broker

    NewReplica,OnlineReplica,OfflineReplica,ReplicaDeletionIneligible -> OfflineReplica --send StopReplicaRequest to the replica (w/o deletion) --remove this replica from the isr and send LeaderAndIsr request (with new isr) to the leader replica and UpdateMetadata request for the partition to every live broker.

    OfflineReplica -> ReplicaDeletionStarted --send StopReplicaRequest to the replica (with deletion)

    ReplicaDeletionStarted -> ReplicaDeletionSuccessful -- mark the state of the replica in the state machine

    ReplicaDeletionStarted -> ReplicaDeletionIneligible -- mark the state of the replica in the state machine

    ReplicaDeletionSuccessful -> NonExistentReplica -- remove the replica from the in memory partition replica assignment cache

    partitionAndReplica

    The replica for which the state transition is invoked

    targetState

    The end state that the replica should be moved to

  26. def handleStateChanges(replicas: Set[PartitionAndReplica], targetState: ReplicaState, callbacks: Callbacks = new kafka.controller.Callbacks.CallbackBuilder().build): Unit

    This API is invoked by the broker change controller callbacks and the startup API of the state machine

    This API is invoked by the broker change controller callbacks and the startup API of the state machine

    replicas

    The list of replicas (brokers) that need to be transitioned to the target state

    targetState

    The state that the replicas should be moved to The controller's allLeaders cache should have been updated before this

  27. def hashCode(): Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  28. def info(msg: ⇒ String, e: ⇒ Throwable): Unit

    definition classes: Logging
  29. def info(e: ⇒ Throwable): Any

    definition classes: Logging
  30. def info(msg: ⇒ String): Unit

    definition classes: Logging
  31. def isAtLeastOneReplicaInDeletionStartedState(topic: String): Boolean

  32. def isInstanceOf[T0]: Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  33. var logIdent: String

    attributes: protected
    definition classes: Logging
  34. lazy val logger: Logger

    definition classes: Logging
  35. val loggerName: String

    definition classes: Logging
  36. def ne(arg0: AnyRef): Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  37. def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  38. def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  39. def partitionsAssignedToBroker(topics: Seq[String], brokerId: Int): Seq[TopicAndPartition]

  40. def registerListeners(): Unit

  41. var replicaState: Map[PartitionAndReplica, ReplicaState]

  42. def replicasInDeletionStates(topic: String): Set[PartitionAndReplica]

  43. def replicasInState(topic: String, state: ReplicaState): Set[PartitionAndReplica]

  44. def shutdown(): Unit

    Invoked on controller shutdown.

    Invoked on controller shutdown.

  45. def startup(): Unit

    Invoked on successful controller election.

    Invoked on successful controller election. First registers a broker change listener since that triggers all state transitions for replicas. Initializes the state of replicas for all partitions by reading from zookeeper. Then triggers the OnlineReplica state change for all replicas.

  46. def swallow(action: ⇒ Unit): Unit

    definition classes: Logging
  47. def swallowDebug(action: ⇒ Unit): Unit

    definition classes: Logging
  48. def swallowError(action: ⇒ Unit): Unit

    definition classes: Logging
  49. def swallowInfo(action: ⇒ Unit): Unit

    definition classes: Logging
  50. def swallowTrace(action: ⇒ Unit): Unit

    definition classes: Logging
  51. def swallowWarn(action: ⇒ Unit): Unit

    definition classes: Logging
  52. def synchronized[T0](arg0: T0): T0

    attributes: final
    definition classes: AnyRef
  53. def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  54. def trace(msg: ⇒ String, e: ⇒ Throwable): Unit

    definition classes: Logging
  55. def trace(e: ⇒ Throwable): Any

    definition classes: Logging
  56. def trace(msg: ⇒ String): Unit

    definition classes: Logging
  57. def wait(): Unit

    attributes: final
    definition classes: AnyRef
  58. def wait(arg0: Long, arg1: Int): Unit

    attributes: final
    definition classes: AnyRef
  59. def wait(arg0: Long): Unit

    attributes: final
    definition classes: AnyRef
  60. def warn(msg: ⇒ String, e: ⇒ Throwable): Unit

    definition classes: Logging
  61. def warn(e: ⇒ Throwable): Any

    definition classes: Logging
  62. def warn(msg: ⇒ String): Unit

    definition classes: Logging