Package com.linecorp.centraldogma.server.command

Class AbstractCommandExecutor

java.lang.Object

com.linecorp.centraldogma.server.command.AbstractCommandExecutor

All Implemented Interfaces:

CommandExecutor

Direct Known Subclasses:

StandaloneCommandExecutor

public abstract class AbstractCommandExecutor
extends Object
implements CommandExecutor

Helps to implement a concrete CommandExecutor.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCommandExecutor(Consumer<CommandExecutor> onTakeLeadership, Consumer<CommandExecutor> onReleaseLeadership, Consumer<CommandExecutor> onTakeZoneLeadership, Consumer<CommandExecutor> onReleaseZoneLeadership)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected abstract <T> CompletableFuture<T>	doExecute(Command<T> command)	Executes the specified Command.
protected abstract void	doStart(Runnable onTakeLeadership, Runnable onReleaseLeadership, Runnable onTakeZoneLeadership, Runnable onReleaseZoneLeadership)	Starts the CommandExecutor.
protected abstract void	doStop(Runnable onReleaseLeadership, Runnable onReleaseZoneLeadership)	Stops the CommandExecutor.
final <T> CompletableFuture<T>	execute(Command<T> command)	Executes the specified Command.
final boolean	isStarted()	Returns true if the executor is started.
protected final boolean	isStopping()	Returns true if the CommandExecutor is in the process of stopping.
final boolean	isWritable()	Returns true if the executor can accept the Commands making a change to the replica.
final void	setWritable(boolean writable)	Makes the executor read/write mode or read-only mode.
final CompletableFuture<Void>	start()	Starts the executor.
CommandExecutorStatusManager	statusManager()	Returns the status manager of this executor.
final CompletableFuture<Void>	stop()	Stops the executor.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.centraldogma.server.command.CommandExecutor

replicaId

Constructor Details

AbstractCommandExecutor

protected AbstractCommandExecutor(@Nullable
 Consumer<CommandExecutor> onTakeLeadership,
 @Nullable
 Consumer<CommandExecutor> onReleaseLeadership,
 @Nullable
 Consumer<CommandExecutor> onTakeZoneLeadership,
 @Nullable
 Consumer<CommandExecutor> onReleaseZoneLeadership)

Creates a new instance.

Parameters:

onTakeLeadership - the callback to be invoked after the replica has taken the leadership

onReleaseLeadership - the callback to be invoked before the replica releases the leadership

onTakeZoneLeadership - the callback to be invoked after the replica has taken the zone leadership

onReleaseZoneLeadership - the callback to be invoked before the replica releases the zone leadership

Method Details

isStarted

public final boolean isStarted()

Description copied from interface: CommandExecutor

Returns true if the executor is started.

Specified by:

isStarted in interface CommandExecutor

isStopping

protected final boolean isStopping()

Returns true if the CommandExecutor is in the process of stopping.

start

public final CompletableFuture<Void> start()

Description copied from interface: CommandExecutor

Starts the executor.

Specified by:

start in interface CommandExecutor

doStart

protected abstract void doStart(@Nullable
 Runnable onTakeLeadership,
 @Nullable
 Runnable onReleaseLeadership,
 @Nullable
 Runnable onTakeZoneLeadership,
 @Nullable
 Runnable onReleaseZoneLeadership)
                         throws Exception

Starts the CommandExecutor.

Throws:

Exception

stop

public final CompletableFuture<Void> stop()

Description copied from interface: CommandExecutor

Stops the executor.

Specified by:

stop in interface CommandExecutor

doStop

protected abstract void doStop(@Nullable
 Runnable onReleaseLeadership,
 @Nullable
 Runnable onReleaseZoneLeadership)
                        throws Exception

Stops the CommandExecutor.

Throws:

Exception

isWritable

public final boolean isWritable()

Description copied from interface: CommandExecutor

Returns true if the executor can accept the Commands making a change to the replica. false would be returned if the replica is running as a read-only mode.

Specified by:

isWritable in interface CommandExecutor

setWritable

public final void setWritable(boolean writable)

Description copied from interface: CommandExecutor

Makes the executor read/write mode or read-only mode.

Specified by:

setWritable in interface CommandExecutor

Parameters:

writable - true to make the executor read/write mode, or false to make it read-only mode

execute

public final <T> CompletableFuture<T> execute(Command<T> command)

Description copied from interface: CommandExecutor

Executes the specified Command.

Specified by:

execute in interface CommandExecutor

Type Parameters:

T - the type of the result to be returned

Parameters:

command - the command which is supposed to be executed

doExecute

protected abstract <T> CompletableFuture<T> doExecute(Command<T> command)
                                               throws Exception

Executes the specified Command.

Throws:

Exception

statusManager

public CommandExecutorStatusManager statusManager()

Description copied from interface: CommandExecutor

Returns the status manager of this executor.

Specified by:

statusManager in interface CommandExecutor

toString

public String toString()

Overrides:

toString in class Object