RepNode (starrocks-bdb-je 18.3.17 API)

java.lang.Object
- java.lang.Thread
- - com.sleepycat.je.utilint.StoppableThread
  - - com.sleepycat.je.rep.impl.node.RepNode

All Implemented Interfaces:

Runnable
```
public class RepNode
extends StoppableThread
```
Represents a replication node. This class is the locus of operations that manage the state of the node, master, replica, etc. Once the state of a node has been established the thread of control passes over to the Replica or FeederManager instances. Note that both Feeders and the Replica instance may be active in future when we support r2r replication, in addition to m2r replication. For now however, either the FeederManager is active, or the Replica is and the same common thread control can be shared between the two.

Nested Class Summary
- Nested classes/interfaces inherited from class java.lang.Thread
  Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields
Modifier and Type	Field and Description
`static TestHook<String>`	`beforeFindRestoreSupplierHook` If not null, a test hook that is called with the name of the current node before attempting to contact each network restore supplier, for unit testing.
`static TestHook<String>`	`queryGroupForMembershipBeforeQueryForMaster` If not null, called by queryGroupForMembership with the name of the current node before querying learners for the master -- for unit testing.
`static TestHook<String>`	`queryGroupForMembershipBeforeSleepHook` If not null, a test hook that is called with the name of the current node during the query for group membership before the node sleeps after failing to obtain information about the group master -- for unit testing.

Fields inherited from class com.sleepycat.je.utilint.StoppableThread
envImpl

Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors
Constructor and Description
`RepNode()`
`RepNode(NameIdPair nameIdPair)`
`RepNode(NameIdPair nameIdPair, ServiceDispatcher serviceDispatcher)`
`RepNode(RepImpl repImpl, Replay replay, NodeState nodeState)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTransientIdNode(RepNodeImpl node)` Adds a transient ID node to the group.
`void`	`clearActiveTransfer()` Called by the RepNode when a transition to replica status has completely finished.
`void`	`clearedCachedFileChecksum(String fileName)` Clears the cached checksum for a file when it may be overwritten (e.g., entries may be erased).
`String`	`dumpAckFeederState()` Dumps the state associated with all active Feeders that supply acknowledgments.
`String`	`dumpState()` Dumps the states associated with any active Feeders as well as the composition of the group itself.
`FeederManager`	`feederManager()`
`void`	`findRestoreSuppliers(Set<InetSocketAddress> helpers)` Sets up a Network Restore, as part of the process of restoring an entire group from backup, by producing an appropriate `InsufficientLogException` if possible.
`void`	`forceMaster(boolean force)`
`MasterTransfer`	`getActiveTransfer()`
`long`	`getAnyDTVLSN()` Returns a DTVLSN (possibly null) for logging/debugging purposes.
`byte[]`	`getAppState()` Return the application state that defined in user specified AppStateMonitor.
`Arbiter`	`getArbiter()`
`ChannelTimeoutTask`	`getChannelTimeoutTask()`
`RepUtils.Clock`	`getClock()`
`VLSN`	`getCurrentTxnEndVLSN()` Returns the latest VLSN associated with a replicated commit.
`long`	`getDTVLSN()` Returns the instantaneous non-null DTVLSN value.
`DurabilityQuorum`	`getDurabilityQuorum()`
`QuorumPolicy`	`getElectionPolicy()`
`int`	`getElectionPriority()`
`ElectionQuorum`	`getElectionQuorum()`
`Elections`	`getElections()`
`FeederTxns`	`getFeederTxns()`
`VLSN`	`getGlobalCBVLSN()` Returns the global CBVLSN if it is not defunct, and otherwise a null VLSN.
`RepGroupImpl`	`getGroup()` Retrieves the node's current snapshot image of the group definition.
`int`	`getHeartbeatInterval()`
`String`	`getHostName()`
`Logger`	`getLogger()`
`LogManager`	`getLogManager()`
`RepNodeImpl[]`	`getLogProviders()` Returns an array of nodes suitable for feeding log files for a network restore.
`int`	`getLogVersion()`
`String`	`getMasterName()`
`MasterStatus`	`getMasterStatus()`
`JEVersion`	`getMinJEVersion()` Get the group minimum JE version.
`MonitorEventManager`	`getMonitorEventManager()`
`NameIdPair`	`getNameIdPair()`
`int`	`getNodeId()` Returns the nodeId associated with this replication node.
`String`	`getNodeName()` Returns the nodeName associated with this replication node.
`NodeType`	`getNodeType()` Returns the node type of this node.
`int`	`getPort()`
`RepUtils.ExceptionAwareCountDownLatch`	`getReadyLatch()`
`RepGroupDB`	`getRepGroupDB()`
`RepImpl`	`getRepImpl()`
`Replica`	`getReplica()`
`VLSN`	`getRestoreResponseVLSN(VLSNRange range)` Returns a VLSN appropriate for the RestoreResponse.cbvlsn field when the GlobalCBVLSN is not defunct, and otherwise a null VLSN.
`ServiceDispatcher`	`getServiceDispatcher()`
`InetSocketAddress`	`getSocket()`
`ReplicatedEnvironmentStats`	`getStats(StatsConfig config)` Returns the accumulated statistics for this node.
`MasterSuggestionGenerator`	`getSuggestionGenerator()`
`int`	`getThreadWaitInterval()`
`Timer`	`getTimer()` Returns the timer associated with this RepNode
`UUID`	`getUUID()` Returns the UUID associated with the replicated environment.
`CommitFreezeLatch`	`getVLSNFreezeLatch()`
`VLSNIndex`	`getVLSNIndex()`
`protected int`	`initiateSoftShutdown()` Soft shutdown for the RepNode thread.
`boolean`	`isAuthoritativeMaster()` Returns a definitive answer to whether this node is currently the master by checking both its status as a master and whether the group agrees that it is the master.
`boolean`	`isGlobalCBVLSNDefunct()` Returns whether the GlobalCBVLSN is defunct -- see `GlobalCBVLSN`.
`boolean`	`isMaster()`
`boolean`	`isNeedsAcks()` Returns true if acks are needed by the group for durability.
`boolean`	`isShutdownOrInvalid()` Returns true if the node has been shutdown or if the underlying environment has been invalidated.
`ReplicatedEnvironment.State`	`joinGroup(ReplicaConsistencyPolicy consistency, QuorumPolicy initialElectionPolicy)` JoinGroup ensures that a RepNode is actively participating in a replication group.
`void`	`recalculateGlobalCBVLSN()` When the GlobalVLSN is not defunct, recalculates it.
`RepGroupImpl`	`refreshCachedGroup()` This method must be invoked when a RepNode is first initialized and subsequently every time there is a change to the replication group.
`void`	`registerAppStateMonitor(AppStateMonitor stateMonitor)` Register an AppStateMonitor with this RepNode.
`void`	`removeMember(String nodeName)` Removes a node so that it's no longer a member of the group.
`void`	`removeMember(String nodeName, boolean delete)` Remove or delete a node from the group.
`void`	`removeTransientNode(RepNodeImpl node)` Removes a node with transient id from the group.
`Replica`	`replica()`
`void`	`resetReadyLatch(Exception exception)`
`void`	`resetStats()`
`void`	`restartNetworkBackup()` Restarts the network backup service after a rollback has been completed and the log files are once again in a consistent state.
`void`	`run()` The top level Master/Feeder or Replica loop in support of replication.
`void`	`setConvertHook(TestHook<Integer> hook)`
`long`	`setDTVLSN(long newDTVLSN)` Sets the DTVLSN to a specific value.
`void`	`setGroup(RepGroupImpl repGroupImpl)` Sets the group metadata associated with the RepNode and updates any local derived data.
`void`	`setMinJEVersion(JEVersion newMinJEVersion)` Checks if all data nodes in the replication group support the specified JE version.
`void`	`setVersion(int version)`
`void`	`shutdown()` Used to shutdown all activity associated with this replication stream.
`void`	`shutdownGroupOnClose(long timeoutMs)` Must be invoked on the Master via the last open handle.
`void`	`shutdownNetworkBackup()` Shuts down the Network backup service before a rollback is initiated as part of syncup, thus ensuring that NetworkRestore does not see an inconsistent set of log files.
`void`	`syncupEnded(FileProtector.ProtectedFileSet fileSet)`
`FileProtector.ProtectedFileSet`	`syncupStarted(NameIdPair syncupNode)` Marks the start of the search for a matchpoint that happens during a syncup.
`void`	`trackSyncableVLSN(VLSN syncableVLSN, long lsn)` Should be called whenever a new VLSN is associated with a log entry suitable for Replica/Feeder syncup.
`String`	`transferMaster(Set<String> replicas, long timeout, boolean force)` Transfer the master role to one of the specified replicas.
`void`	`updateAddress(String nodeName, String newHostName, int newPort)` Update the network address of a node.
`long`	`updateDTVLSN(long candidateDTVLSN)` Updates the DTVLSN with a potentially new DTVLSN value.
`void`	`updateGroupInfo(NameIdPair updateNameIdPair, CleanerBarrierState barrierState)` Updates the cached group info for the node, avoiding a database read, if the global CBVLSN is not defunct.

Methods inherited from class com.sleepycat.je.utilint.StoppableThread
cleanup, getSavedShutdownException, getTotalCpuTime, getTotalUserTime, handleUncaughtException, isShutdown, saveShutdownException, shutdownDone, shutdownThread

Methods inherited from class java.lang.Thread
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - queryGroupForMembershipBeforeSleepHook
```
public static volatile TestHook<String> queryGroupForMembershipBeforeSleepHook
```
    If not null, a test hook that is called with the name of the current node during the query for group membership before the node sleeps after failing to obtain information about the group master -- for unit testing.
  - queryGroupForMembershipBeforeQueryForMaster
```
public static volatile TestHook<String> queryGroupForMembershipBeforeQueryForMaster
```
    If not null, called by queryGroupForMembership with the name of the current node before querying learners for the master -- for unit testing.
  - beforeFindRestoreSupplierHook
```
public static volatile TestHook<String> beforeFindRestoreSupplierHook
```
    If not null, a test hook that is called with the name of the current node before attempting to contact each network restore supplier, for unit testing.
- Constructor Detail
  - RepNode
```
public RepNode(RepImpl repImpl,
               Replay replay,
               NodeState nodeState)
        throws IOException,
               DatabaseException
```
    Throws:
    
    IOException
    
    DatabaseException
  - RepNode
```
public RepNode(NameIdPair nameIdPair)
```
  - RepNode
```
public RepNode()
```
  - RepNode
```
public RepNode(NameIdPair nameIdPair,
               ServiceDispatcher serviceDispatcher)
```
- Method Detail
  - getLogger
```
public Logger getLogger()
```
    Specified by:
    
    getLogger in class StoppableThread
    
    Returns:
    
    a logger to use when logging uncaught exceptions.
  - getNodeType
```
public NodeType getNodeType()
```
    Returns the node type of this node.
  - getTimer
```
public Timer getTimer()
```
    Returns the timer associated with this RepNode
  - getServiceDispatcher
```
public ServiceDispatcher getServiceDispatcher()
```
  - getStats
```
public ReplicatedEnvironmentStats getStats(StatsConfig config)
```
    Returns the accumulated statistics for this node. The method encapsulates the statistics associated with its two principal components the FeederManager and the Replica.
  - resetStats
```
public void resetStats()
```
  - getReadyLatch
```
public RepUtils.ExceptionAwareCountDownLatch getReadyLatch()
```
  - getVLSNFreezeLatch
```
public CommitFreezeLatch getVLSNFreezeLatch()
```
  - resetReadyLatch
```
public void resetReadyLatch(Exception exception)
```
  - feederManager
```
public FeederManager feederManager()
```
  - replica
```
public Replica replica()
```
  - getClock
```
public RepUtils.Clock getClock()
```
  - getReplica
```
public Replica getReplica()
```
  - getRepGroupDB
```
public RepGroupDB getRepGroupDB()
```
  - getGroup
```
public RepGroupImpl getGroup()
```
    Retrieves the node's current snapshot image of the group definition.
    There is a very brief period of time, during node start-up, where this can be null. But after that it should always return a valid object.
  - getUUID
```
public UUID getUUID()
```
    Returns the UUID associated with the replicated environment.
  - getNodeName
```
public String getNodeName()
```
    Returns the nodeName associated with this replication node.
    
    Returns:
    
    the nodeName
  - getNodeId
```
public int getNodeId()
```
    Returns the nodeId associated with this replication node.
    
    Returns:
    
    the nodeId
  - getNameIdPair
```
public NameIdPair getNameIdPair()
```
  - getSocket
```
public InetSocketAddress getSocket()
```
  - getHostName
```
public String getHostName()
```
  - getPort
```
public int getPort()
```
  - getMasterStatus
```
public MasterStatus getMasterStatus()
```
  - isAuthoritativeMaster
```
public boolean isAuthoritativeMaster()
```
    Returns a definitive answer to whether this node is currently the master by checking both its status as a master and whether the group agrees that it is the master. Such an authoritative answer is needed in a network partition situation to detect a master that may be isolated on the minority side of a network partition.
    
    Returns:
    
    true if the node is definitely the master. False if it's not or we cannot be sure.
  - getHeartbeatInterval
```
public int getHeartbeatInterval()
```
  - setVersion
```
public void setVersion(int version)
```
  - getLogVersion
```
public int getLogVersion()
```
  - getElectionPriority
```
public int getElectionPriority()
```
  - getThreadWaitInterval
```
public int getThreadWaitInterval()
```
  - getRepImpl
```
public RepImpl getRepImpl()
```
  - getLogManager
```
public LogManager getLogManager()
```
  - getVLSNIndex
```
public VLSNIndex getVLSNIndex()
```
  - getFeederTxns
```
public FeederTxns getFeederTxns()
```
  - getElections
```
public Elections getElections()
```
  - getSuggestionGenerator
```
public MasterSuggestionGenerator getSuggestionGenerator()
```
  - getElectionPolicy
```
public QuorumPolicy getElectionPolicy()
```
  - getLogProviders
```
public RepNodeImpl[] getLogProviders()
```
    Returns an array of nodes suitable for feeding log files for a network restore.
    
    Returns:
    
    an array of feeder nodes
  - getChannelTimeoutTask
```
public ChannelTimeoutTask getChannelTimeoutTask()
```
  - isMaster
```
public boolean isMaster()
```
  - getMonitorEventManager
```
public MonitorEventManager getMonitorEventManager()
```
  - registerAppStateMonitor
```
public void registerAppStateMonitor(AppStateMonitor stateMonitor)
```
    Register an AppStateMonitor with this RepNode.
  - getAppState
```
public byte[] getAppState()
```
    Return the application state that defined in user specified AppStateMonitor.
  - getMasterName
```
public String getMasterName()
```
  - getCurrentTxnEndVLSN
```
public VLSN getCurrentTxnEndVLSN()
```
    Returns the latest VLSN associated with a replicated commit. Note that since the lastTxnEndVLSN is computed outside the write log latch, via EnvironmentImpl.registerVLSN(LogItem) it's possible for it to be behind on an instantaneous basis, but it will eventually catch up when the updates quiesce.
  - getDTVLSN
```
public long getDTVLSN()
```
    Returns the instantaneous non-null DTVLSN value. The value should be non null once initialization has been completed. The returned value can be VLSN.UNINITIALIZED_VLSN_SEQUENCE if the node is a replica in a pre-dtvlsn log segment, or a master that has not as yet seen any acknowledged transactions.
  - getAnyDTVLSN
```
public long getAnyDTVLSN()
```
    Returns a DTVLSN (possibly null) for logging/debugging purposes.
  - updateDTVLSN
```
public long updateDTVLSN(long candidateDTVLSN)
```
    Updates the DTVLSN with a potentially new DTVLSN value. Note that this method is only invoked when the node is a Master. The Replica simply sets the DTVLSN to a specific value.
    
    Parameters:
    
    candidateDTVLSN - the new candidate DTVLSN
    
    Returns:
    
    the new DTVLSN which is either the candidatDTVLSN or a more recent DTVLSN > candidateDTVLSN
  - setDTVLSN
```
public long setDTVLSN(long newDTVLSN)
```
    Sets the DTVLSN to a specific value. This method is used exclusively by the Replica as it maintains the DTVLSN based upon the contents of the replication stream.
    
    Returns:
    
    the previous DTVLSN value
  - setGroup
```
public void setGroup(RepGroupImpl repGroupImpl)
```
    Sets the group metadata associated with the RepNode and updates any local derived data.
  - forceMaster
```
public void forceMaster(boolean force)
                 throws InterruptedException,
                        DatabaseException
```
    Throws:
    
    InterruptedException
    
    DatabaseException
  - refreshCachedGroup
```
public RepGroupImpl refreshCachedGroup()
                                throws DatabaseException
```
    This method must be invoked when a RepNode is first initialized and subsequently every time there is a change to the replication group.
    The Master should invoke this method each time a member is added or removed, and a replica should invoke it each time it detects the commit of a transaction that modifies the membership database.
    In addition, it must be invoked after a syncup operation, since it may revert changes made to the membership table.
    
    Throws:
    
    DatabaseException
  - removeMember
```
public void removeMember(String nodeName)
```
    Removes a node so that it's no longer a member of the group. Note that names referring to removed nodes cannot be reused.
    
    Parameters:
    
    nodeName - identifies the node to be removed
    
    Throws:
    
    MemberNotFoundException - if the node denoted by memberName is not a member of the replication group.
    
    MasterStateException - if the member being removed is currently the Master
    
    See Also:
    
    Member Deletion
  - removeMember
```
public void removeMember(String nodeName,
                         boolean delete)
```
    Remove or delete a node from the group. If deleting a node, the node must not be active.
    Note that names referring to removed nodes cannot be reused, but names for deleted nodes can be.
    
    Parameters:
    
    nodeName - identifies the node to be removed or deleted
    
    delete - whether to delete the node rather than just remove it
    
    Throws:
    
    MemberActiveException - if delete is true and the node is currently active
    
    MemberNotFoundException - if the node denoted by memberName is not a member of the replication group.
    
    MasterStateException - if the member being removed or deleted is currently the Master
  - updateAddress
```
public void updateAddress(String nodeName,
                          String newHostName,
                          int newPort)
```
    Update the network address of a node. Note that an alive node's address can't be updated, we'll throw an ReplicaStateException for this case.
    
    Parameters:
    
    nodeName - identifies the node to be updated
    
    newHostName - the new host name of this node
    
    newPort - the new port of this node
  - transferMaster
```
public String transferMaster(Set<String> replicas,
                             long timeout,
                             boolean force)
```
    Transfer the master role to one of the specified replicas.
    We delegate most of the real work to an instance of the MasterTransfer class. Here, after some simple initial validity checking, we're concerned with coordinating the potential for multiple overlapping Master Transfer operation attempts. The possible outcomes are:
    1. complete success (done == true)
      
      don't unblock txns here; that'll happen automatically as part of the usual handling when the environment transitions from master->replica state.
      don't clear xfrInProgress, because we don't want to allow another attempt to supersede
    2. timeout before establishing a winner (no superseder)
      
      unblock txns
      clear xfrInProgress
    3. superseded (see setUpTransfer(java.util.Set<java.lang.String>, long, boolean))
      
      abort existing op (if permitted), unblock txns before unleashing the new one
      replace xfrInProgress
    4. env is closed (or invalidated because of an error) during the operation
      
      release the block
      leave xfrInProgress as is.
    Parameters:
    
    replicas - candidate targets for new master role
    
    timeout - time limit, in msec
    
    force - whether to replace any existing, in-progress transfer operation
  - getActiveTransfer
```
public MasterTransfer getActiveTransfer()
```
  - clearActiveTransfer
```
public void clearActiveTransfer()
```
    Called by the RepNode when a transition to replica status has completely finished.
  - updateGroupInfo
```
public void updateGroupInfo(NameIdPair updateNameIdPair,
                            CleanerBarrierState barrierState)
```
    Updates the cached group info for the node, avoiding a database read, if the global CBVLSN is not defunct. If it is defunct, does nothing.
    
    Parameters:
    
    updateNameIdPair - the node whose localCBVLSN must be updated.
    
    barrierState - the new node syncup state
  - recalculateGlobalCBVLSN
```
public void recalculateGlobalCBVLSN()
```
    When the GlobalVLSN is not defunct, recalculates it. Provoked by Replay to ensure that the replica's GlobalVLSN is up to date. When the GlobalVLSN is defunct, does nothing.
  - findRestoreSuppliers
```
public void findRestoreSuppliers(Set<InetSocketAddress> helpers)
                          throws InterruptedException
```
    Sets up a Network Restore, as part of the process of restoring an entire group from backup, by producing an appropriate InsufficientLogException if possible.
    Queries each of the supplied helper hosts for their notion of the group make-up. If any of them consider us to be already in the group, then instead of joining the group as a new node we ought to try a Network Restore; and the node(s) that do already know of us are the suitable suppliers for it.
    
    Throws:
    
    InsufficientLogException - in the successful case, if one or more suitable suppliers for a Network Restore can be found; otherwise just returns.
    
    InterruptedException - if the node was shutdown or invalidated while we were looking for a network restore supplier
  - run
```
public void run()
```
    The top level Master/Feeder or Replica loop in support of replication. It's responsible for driving the node level state changes resulting from elections initiated either by this node, or by other members of the group.
    The thread is terminated via an orderly shutdown initiated as a result of an interrupt issued by the shutdown() method. Any exception that is not handled by the run method itself is caught by the thread's uncaught exception handler, and results in the RepImpl being made invalid. In that case, the application is responsible for closing the Replicated Environment, which will provoke the shutdown.
    Note: This method currently runs either the feeder loop or the replica loop. With R to R support, it would be possible for a Replica to run both. This will be a future feature.
    
    Specified by:
    
    run in interface Runnable
    
    Overrides:
    
    run in class Thread
  - isShutdownOrInvalid
```
public boolean isShutdownOrInvalid()
```
    Returns true if the node has been shutdown or if the underlying environment has been invalidated. It's used as the basis for exiting the FeederManager or the Replica.
  - shutdown
```
public void shutdown()
              throws InterruptedException,
                     DatabaseException
```
    Used to shutdown all activity associated with this replication stream. If method is invoked from different thread of control, it will wait until the rep node thread exits. If it's from the same thread, it's the caller's responsibility to exit the thread upon return from this method.
    
    Throws:
    
    InterruptedException
    
    DatabaseException
  - initiateSoftShutdown
```
protected int initiateSoftShutdown()
```
    Soft shutdown for the RepNode thread. Note that since the thread is shared by the FeederManager and the Replica, the FeederManager or Replica specific soft shutdown actions should already have been done earlier.
    
    Overrides:
    
    initiateSoftShutdown in class StoppableThread
    
    Returns:
    
    the amount of time in ms that the shutdownThread method will wait for the thread to exit. A -ve value means that the method will not wait. A zero value means it will wait indefinitely.
  - shutdownGroupOnClose
```
public void shutdownGroupOnClose(long timeoutMs)
                          throws IllegalStateException
```
    Must be invoked on the Master via the last open handle. Note that the method itself does not shutdown the group. It merely sets replicaCloseCatchupMs, indicating that the ensuing handle close should shutdown the Replicas. The actual coordination with the closing of the handle is implemented by ReplicatedEnvironment.shutdownGroup().
    
    Throws:
    
    IllegalStateException
    
    See Also:
    
    ReplicatedEnvironment.shutdownGroup(long, TimeUnit)
  - joinGroup
```
public ReplicatedEnvironment.State joinGroup(ReplicaConsistencyPolicy consistency,
                                             QuorumPolicy initialElectionPolicy)
                                      throws ReplicaConsistencyException,
                                             DatabaseException
```
    JoinGroup ensures that a RepNode is actively participating in a replication group. It's invoked each time a replicated environment handle is created. If the node is already participating in a replication group, because it's not the first handle to the environment, it will return without having to wait. Otherwise it will wait until a master is elected and this node is active, either as a Master, or as a Replica. If the node joins as a replica, it will wait further until it has become sufficiently consistent as defined by its consistency argument. By default it uses PointConsistencyPolicy to ensure that it is at least as consistent as the master as of the time the handle was opened. A node can also join in the Unknown state if it has been configured to do so via ENV_UNKNOWN_STATE_TIMEOUT.
    
    Returns:
    
    MASTER, REPLICA, or UNKNOWN (if ENV_UNKNOWN_STATE_TIMEOUT is set)
    
    Throws:
    
    UnknownMasterException - If a master cannot be established within ENV_SETUP_TIMEOUT, unless ENV_UNKNOWN_STATE_TIMEOUT has been set to allow the creation of a handle while in the UNKNOWN state.
    
    ReplicaConsistencyException
    
    DatabaseException
  - trackSyncableVLSN
```
public void trackSyncableVLSN(VLSN syncableVLSN,
                              long lsn)
```
    Should be called whenever a new VLSN is associated with a log entry suitable for Replica/Feeder syncup. If GlobalCBVLSN is defunct, does nothing.
  - getGlobalCBVLSN
```
public VLSN getGlobalCBVLSN()
```
    Returns the global CBVLSN if it is not defunct, and otherwise a null VLSN.
    
    See Also:
    
    GlobalCBVLSN.getCBVLSN()
  - isGlobalCBVLSNDefunct
```
public boolean isGlobalCBVLSNDefunct()
```
    Returns whether the GlobalCBVLSN is defunct -- see GlobalCBVLSN.
  - getRestoreResponseVLSN
```
public VLSN getRestoreResponseVLSN(VLSNRange range)
```
    Returns a VLSN appropriate for the RestoreResponse.cbvlsn field when the GlobalCBVLSN is not defunct, and otherwise a null VLSN.
    
    See Also:
    
    GlobalCBVLSN.getRestoreResponseVLSN(com.sleepycat.je.rep.vlsn.VLSNRange)
  - syncupStarted
```
public FileProtector.ProtectedFileSet syncupStarted(NameIdPair syncupNode)
```
    Marks the start of the search for a matchpoint that happens during a syncup. The lower bound of the VLSN range must remain stable during syncup to prevent deleting files that are being read by a syncup file reader.
    A feeder may have multiple syncups in action. The caller should call syncupEnded(com.sleepycat.je.cleaner.FileProtector.ProtectedFileSet) when the syncup is done, passing the value returned by this method.
    
    Parameters:
    
    syncupNode - identifies the other node involved in the the syncup, and is the name to be used in LogSizeStats.
    
    Returns:
    
    the ProtectedFileSet protecting the VLSNIndex range and identifying the syncup in LogSizeStats.
  - syncupEnded
```
public void syncupEnded(FileProtector.ProtectedFileSet fileSet)
```
  - getArbiter
```
public Arbiter getArbiter()
```
  - shutdownNetworkBackup
```
public final void shutdownNetworkBackup()
```
    Shuts down the Network backup service *before* a rollback is initiated as part of syncup, thus ensuring that NetworkRestore does not see an inconsistent set of log files. Any network backup operations that are in progress at this node are aborted. The client of the service will experience network connection failures and will retry with this node (when the service is re-established at this node), or with some other node.
    restartNetworkBackup() is then used to restart the service after it was shut down.
  - restartNetworkBackup
```
public final void restartNetworkBackup()
```
    Restarts the network backup service *after* a rollback has been completed and the log files are once again in a consistent state.
  - clearedCachedFileChecksum
```
public void clearedCachedFileChecksum(String fileName)
```
    Clears the cached checksum for a file when it may be overwritten (e.g., entries may be erased).
  - dumpState
```
public String dumpState()
```
    Dumps the states associated with any active Feeders as well as the composition of the group itself.
  - dumpAckFeederState
```
public String dumpAckFeederState()
```
    Dumps the state associated with all active Feeders that supply acknowledgments.
  - getElectionQuorum
```
public ElectionQuorum getElectionQuorum()
```
  - getDurabilityQuorum
```
public DurabilityQuorum getDurabilityQuorum()
```
  - setConvertHook
```
public void setConvertHook(TestHook<Integer> hook)
```
  - getMinJEVersion
```
public JEVersion getMinJEVersion()
```
    Get the group minimum JE version.
    Returns the minimum JE version that is required for all nodes that join this node's replication group. The version returned is supported by all current and future group members. The minimum JE version is guaranteed to only increase over time, so long as the data for the environment is not rolled back or lost.
    
    Returns:
    
    the group minimum JE version
  - setMinJEVersion
```
public void setMinJEVersion(JEVersion newMinJEVersion)
                     throws MinJEVersionUnsupportedException
```
    Checks if all data nodes in the replication group support the specified JE version. Updates the group minimum JE version, and the group format version, as needed to require all nodes joining the group to be running at least the specified JE version.
    This method should only be called on the master, because attempts to update the rep group DB on an replica will fail.
    
    Parameters:
    
    newMinJEVersion - the new minimum JE version
    
    Throws:
    
    DatabaseException - if an error occurs when accessing the replication group database
    
    MinJEVersionUnsupportedException - if the version is not supported by one or more current group members
  - isNeedsAcks
```
public boolean isNeedsAcks()
```
    Returns true if acks are needed by the group for durability. This is the case if the rep group has > 1 data node that's also electable.
  - addTransientIdNode
```
public void addTransientIdNode(RepNodeImpl node)
```
    Adds a transient ID node to the group. Assign a node ID and add the node to the RepGroupImpl. Don't notify the monitor: transient ID nodes do not generate GroupChangeEvents.
    
    Parameters:
    
    node - the node
    
    Throws:
    
    IllegalStateException - if the store does not currently support secondary nodes or the node doesn't meet the current minimum JE version
    
    RepGroupImpl.NodeConflictException - if the node conflicts with an existing persistent node
  - removeTransientNode
```
public void removeTransientNode(RepNodeImpl node)
```
    Removes a node with transient id from the group. Remove the node from the RepGroupImpl and deallocate the node ID.
    
    Parameters:
    
    node - the node

Class RepNode

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Field Summary

Fields inherited from class com.sleepycat.je.utilint.StoppableThread

Fields inherited from class java.lang.Thread

Constructor Summary

Method Summary

Methods inherited from class com.sleepycat.je.utilint.StoppableThread

Methods inherited from class java.lang.Thread

Methods inherited from class java.lang.Object

Field Detail

queryGroupForMembershipBeforeSleepHook

queryGroupForMembershipBeforeQueryForMaster

beforeFindRestoreSupplierHook

Constructor Detail

RepNode

RepNode

RepNode

RepNode

Method Detail

getLogger

getNodeType

getTimer

getServiceDispatcher

getStats

resetStats

getReadyLatch

getVLSNFreezeLatch

resetReadyLatch

feederManager

replica

getClock

getReplica

getRepGroupDB

getGroup

getUUID

getNodeName

getNodeId

getNameIdPair

getSocket

getHostName

getPort

getMasterStatus

isAuthoritativeMaster

getHeartbeatInterval

setVersion

getLogVersion

getElectionPriority

getThreadWaitInterval

getRepImpl

getLogManager

getVLSNIndex

getFeederTxns

getElections

getSuggestionGenerator

getElectionPolicy

getLogProviders

getChannelTimeoutTask

isMaster

getMonitorEventManager

registerAppStateMonitor

getAppState

getMasterName

getCurrentTxnEndVLSN

getDTVLSN

getAnyDTVLSN

updateDTVLSN

setDTVLSN

setGroup

forceMaster

refreshCachedGroup

removeMember

removeMember

updateAddress

transferMaster

getActiveTransfer

clearActiveTransfer

updateGroupInfo

recalculateGlobalCBVLSN