Package org.apache.bookkeeper.bookie

Class BookieStateManager

java.lang.Object

org.apache.bookkeeper.bookie.BookieStateManager

All Implemented Interfaces:

AutoCloseable, StateManager

@StatsDoc(name="bookie",
          category="server",
          help="Bookie state manager related stats")
public class BookieStateManager
extends Object
implements StateManager

An implementation of StateManager.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.bookkeeper.bookie.StateManager

StateManager.ShutdownHandler

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final ScheduledExecutorService	stateService

Constructor Summary

Constructors

Constructor	Description
BookieStateManager(ServerConfiguration conf, RegistrationManager registrationManager)
BookieStateManager(ServerConfiguration conf, StatsLogger statsLogger, RegistrationManager rm, List<File> statusDirs, Supplier<BookieId> bookieIdSupplier, Supplier<BookieServiceInfo> bookieServiceInfoProvider)
BookieStateManager(ServerConfiguration conf, StatsLogger statsLogger, RegistrationManager rm, LedgerDirsManager ledgerDirsManager, Supplier<BookieServiceInfo> bookieServiceInfoProvider)

Method Summary

Modifier and Type	Method	Description
void	close()	Close the manager, release its resources.
(package private) void	doRegisterBookie()
void	doTransitionToReadOnlyMode()
void	doTransitionToReadOnlyMode(boolean isManuallyModify)
void	doTransitionToWritableMode()
void	doTransitionToWritableMode(boolean isManuallyModify)
void	forceToReadOnly()	Turn state to the read only, just flag.
void	forceToShuttingDown()	Turn state to the shutting down progress,just the flag.
void	forceToUnregistered()	Turn state to not registered, just the flag.
StateManager.ShutdownHandler	getShutdownHandler()
void	initState()	Init state of Bookie when launch bookie.
boolean	isAvailableForHighPriorityWrites()	Check if the bookie is available for high priority writes or not.
boolean	isForceReadOnly()	Check is forceReadOnly.
boolean	isReadOnly()	Check is ReadOnly.
boolean	isReadOnlyModeEnabled()	Check is readOnlyModeEnabled.
(package private) boolean	isRegistered()
boolean	isRunning()	Check is Running.
boolean	isShuttingDown()	Check is Shutting down.
Future<Void>	registerBookie(boolean throwException)	Register the bookie to RegistrationManager.
void	setHighPriorityWritesAvailability(boolean available)	Enable/Disable the availability for high priority writes.
void	setShutdownHandler(StateManager.ShutdownHandler handler)
Future<Void>	transitionToReadOnlyMode(boolean isManuallyModify)	Change the state of bookie to ReadOnly mode.
Future<Void>	transitionToWritableMode(boolean isManuallyModify)	Change the state of bookie to Writable mode.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.bookkeeper.bookie.StateManager

transitionToReadOnlyMode, transitionToWritableMode

Field Details

stateService

final ScheduledExecutorService stateService

Constructor Details

BookieStateManager

public BookieStateManager(ServerConfiguration conf,
 StatsLogger statsLogger,
 RegistrationManager rm,
 LedgerDirsManager ledgerDirsManager,
 Supplier<BookieServiceInfo> bookieServiceInfoProvider)
                   throws IOException

Throws:

IOException

BookieStateManager

public BookieStateManager(ServerConfiguration conf,
 StatsLogger statsLogger,
 RegistrationManager rm,
 List<File> statusDirs,
 Supplier<BookieId> bookieIdSupplier,
 Supplier<BookieServiceInfo> bookieServiceInfoProvider)
                   throws IOException

Throws:

IOException

BookieStateManager

BookieStateManager(ServerConfiguration conf,
 RegistrationManager registrationManager)
            throws IOException

Throws:

IOException

Method Details

initState

public void initState()

Description copied from interface: StateManager

Init state of Bookie when launch bookie.

Specified by:

initState in interface StateManager

forceToShuttingDown

public void forceToShuttingDown()

Description copied from interface: StateManager

Turn state to the shutting down progress,just the flag.

Specified by:

forceToShuttingDown in interface StateManager

forceToReadOnly

public void forceToReadOnly()

Description copied from interface: StateManager

Turn state to the read only, just flag.

Specified by:

forceToReadOnly in interface StateManager

forceToUnregistered

public void forceToUnregistered()

Description copied from interface: StateManager

Turn state to not registered, just the flag.

Specified by:

forceToUnregistered in interface StateManager

isReadOnly

public boolean isReadOnly()

Description copied from interface: StateManager

Check is ReadOnly.

Specified by:

isReadOnly in interface StateManager

isForceReadOnly

public boolean isForceReadOnly()

Description copied from interface: StateManager

Check is forceReadOnly.

Specified by:

isForceReadOnly in interface StateManager

isReadOnlyModeEnabled

public boolean isReadOnlyModeEnabled()

Description copied from interface: StateManager

Check is readOnlyModeEnabled.

Specified by:

isReadOnlyModeEnabled in interface StateManager

isAvailableForHighPriorityWrites

public boolean isAvailableForHighPriorityWrites()

Description copied from interface: StateManager

Check if the bookie is available for high priority writes or not.

Specified by:

isAvailableForHighPriorityWrites in interface StateManager

Returns:

true if the bookie is available for high priority writes; otherwise false.

setHighPriorityWritesAvailability

public void setHighPriorityWritesAvailability(boolean available)

Description copied from interface: StateManager

Enable/Disable the availability for high priority writes.

Specified by:

setHighPriorityWritesAvailability in interface StateManager

Parameters:

available - the flag to enable/disable the availability for high priority writes.

isRunning

public boolean isRunning()

Description copied from interface: StateManager

Check is Running.

Specified by:

isRunning in interface StateManager

isShuttingDown

public boolean isShuttingDown()

Description copied from interface: StateManager

Check is Shutting down.

Specified by:

isShuttingDown in interface StateManager

close

public void close()

Description copied from interface: StateManager

Close the manager, release its resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface StateManager

registerBookie

public Future<Void> registerBookie(boolean throwException)

Description copied from interface: StateManager

Register the bookie to RegistrationManager.

Specified by:

registerBookie in interface StateManager

transitionToWritableMode

public Future<Void> transitionToWritableMode(boolean isManuallyModify)

Description copied from interface: StateManager

Change the state of bookie to Writable mode.

Specified by:

transitionToWritableMode in interface StateManager

transitionToReadOnlyMode

public Future<Void> transitionToReadOnlyMode(boolean isManuallyModify)

Description copied from interface: StateManager

Change the state of bookie to ReadOnly mode.

Specified by:

transitionToReadOnlyMode in interface StateManager

doRegisterBookie

void doRegisterBookie()
               throws IOException

Throws:

IOException

doTransitionToWritableMode

public void doTransitionToWritableMode()

doTransitionToWritableMode

public void doTransitionToWritableMode(boolean isManuallyModify)

doTransitionToReadOnlyMode

public void doTransitionToReadOnlyMode()

doTransitionToReadOnlyMode

public void doTransitionToReadOnlyMode(boolean isManuallyModify)

setShutdownHandler

public void setShutdownHandler(StateManager.ShutdownHandler handler)

Specified by:

setShutdownHandler in interface StateManager

getShutdownHandler

public StateManager.ShutdownHandler getShutdownHandler()

isRegistered

boolean isRegistered()