Package org.apache.bookkeeper.replication

Class Auditor

java.lang.Object

org.apache.bookkeeper.replication.Auditor

All Implemented Interfaces:

AutoCloseable

public class Auditor
extends Object
implements AutoCloseable

Auditor is a single entity in the entire Bookie cluster and will be watching all the bookies under 'ledgerrootpath/available' zkpath. When any of the bookie failed or disconnected from zk, he will start initiating the re-replication activities by keeping all the corresponding ledgers of the failed bookie as underreplicated znode in zk.

TODO: eliminate the direct usage of zookeeper here {@link https://github.com/apache/bookkeeper/issues/1332}

Field Summary

Fields

Modifier and Type	Field	Description
protected AuditorBookieCheckTask	auditorBookieCheckTask
protected AuditorTask	auditorCheckAllLedgersTask
protected AuditorTask	auditorPlacementPolicyCheckTask
protected AuditorTask	auditorReplicasCheckTask
protected Future<?>	auditTask

Constructor Summary

Constructors

Constructor	Description
Auditor(String bookieIdentifier, ServerConfiguration conf, BookKeeper bkc, boolean ownBkc, BookKeeperAdmin admin, boolean ownAdmin, StatsLogger statsLogger)
Auditor(String bookieIdentifier, ServerConfiguration conf, BookKeeper bkc, boolean ownBkc, StatsLogger statsLogger)
Auditor(String bookieIdentifier, ServerConfiguration conf, StatsLogger statsLogger)

Method Summary

Modifier and Type	Method	Description
void	close()
(package private) static BookKeeper	createBookKeeperClient(ServerConfiguration conf)
(package private) static BookKeeper	createBookKeeperClient(ServerConfiguration conf, StatsLogger statsLogger)
(package private) static BookKeeper	createBookKeeperClientThrowUnavailableException(ServerConfiguration conf)
(package private) Future<?>	getAuditTask()
protected List<String>	getAvailableBookies()
(package private) int	getLostBookieRecoveryDelayBeforeChange()
boolean	isRunning()	Return true if auditor is running otherwise return false.
void	shutdown()	Shutdown the auditor.
void	start()
(package private) Future<?>	submitAuditTask()
protected void	submitBookieCheckTask()
(package private) Future<?>	submitLostBookieRecoveryDelayChangedEvent()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

auditTask

protected volatile Future<?> auditTask

auditorBookieCheckTask

protected AuditorBookieCheckTask auditorBookieCheckTask

auditorCheckAllLedgersTask

protected AuditorTask auditorCheckAllLedgersTask

auditorPlacementPolicyCheckTask

protected AuditorTask auditorPlacementPolicyCheckTask

auditorReplicasCheckTask

protected AuditorTask auditorReplicasCheckTask

Constructor Details

Auditor

public Auditor(String bookieIdentifier,
 ServerConfiguration conf,
 StatsLogger statsLogger)
        throws ReplicationException.UnavailableException

Throws:

ReplicationException.UnavailableException

Auditor

public Auditor(String bookieIdentifier,
 ServerConfiguration conf,
 BookKeeper bkc,
 boolean ownBkc,
 StatsLogger statsLogger)
        throws ReplicationException.UnavailableException

Throws:

ReplicationException.UnavailableException

Auditor

public Auditor(String bookieIdentifier,
 ServerConfiguration conf,
 BookKeeper bkc,
 boolean ownBkc,
 BookKeeperAdmin admin,
 boolean ownAdmin,
 StatsLogger statsLogger)
        throws ReplicationException.UnavailableException

Throws:

ReplicationException.UnavailableException

Method Details

createBookKeeperClient

static BookKeeper createBookKeeperClient(ServerConfiguration conf)
                                  throws InterruptedException,
IOException

Throws:

InterruptedException

IOException

createBookKeeperClient

static BookKeeper createBookKeeperClient(ServerConfiguration conf,
 StatsLogger statsLogger)
                                  throws InterruptedException,
IOException

Throws:

InterruptedException

IOException

createBookKeeperClientThrowUnavailableException

static BookKeeper createBookKeeperClientThrowUnavailableException(ServerConfiguration conf)
                                                           throws ReplicationException.UnavailableException

Throws:

ReplicationException.UnavailableException

submitAuditTask

Future<?> submitAuditTask()

submitLostBookieRecoveryDelayChangedEvent

Future<?> submitLostBookieRecoveryDelayChangedEvent()

start

public void start()

submitBookieCheckTask

protected void submitBookieCheckTask()

getAvailableBookies

protected List<String> getAvailableBookies()
                                    throws BKException

Throws:

BKException

shutdown

public void shutdown()

Shutdown the auditor.

close

public void close()

Specified by:

close in interface AutoCloseable

isRunning

public boolean isRunning()

Return true if auditor is running otherwise return false.

Returns:

auditor status

getLostBookieRecoveryDelayBeforeChange

int getLostBookieRecoveryDelayBeforeChange()

getAuditTask

Future<?> getAuditTask()