Package com.ultikits.ultitools.utils

Class PowerActionHandler

java.lang.Object

com.ultikits.ultitools.utils.PowerActionHandler

All Implemented Interfaces:

CloudRequestHandler

final class PowerActionHandler
extends Object
implements CloudRequestHandler

Handles the ack-first server.power request: a structured stop or restart that never passes through the command blocklist and is allowed only while the operator's ultipanel.capabilities.power-actions switch is on.

The id is recorded and persisted before command.ack is sent, so a redelivered id is acknowledged again but never stops or restarts the server a second time. The result frame is handed to the channel before the pre-shutdown hook runs and before the power action is scheduled, so the panel always learns what happened before the server begins to go down.

Restart is pre-checked against the server's restart-script: Spigot's own restart stops the server when that script is missing, which would turn a requested restart into a stop that nobody asked for. The check therefore answers power_unsupported instead of degrading.

Package-private framework plumbing; not for module use.

Since:

6.3.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static interface	PowerActionHandler.PowerExecutor	The two calls BukkitPowerExecutor turns into a main-thread stop or restart, kept behind an interface so the handler stays unit-testable without a live server.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final String	ACTION_RESTART	The contract's second action value.
(package private) static final String	ACTION_STOP	The contract's first action value.
private final Consumer<RemoteActionLog.Entry>	actionLog
(package private) static final String	ACTOR	server.power carries no executor field, so the action log names the panel itself.
private final PowerActionHandler.PowerExecutor	executor
private final DedupeLedger	ledger
private static final Logger	LOGGER
private final BooleanSupplier	powerEnabled
private final Runnable	preShutdownHook
(package private) static final String	RESULT_TYPE	The frozen contract result type every delivery is answered with.
(package private) static final String	TYPE	The frozen contract request type this handler consumes.

Constructor Summary

Constructors

Constructor	Description
PowerActionHandler(DedupeLedger ledger, BooleanSupplier powerEnabled, PowerActionHandler.PowerExecutor executor, Runnable preShutdownHook, Consumer<RemoteActionLog.Entry> actionLog)	Creates the handler.

Method Summary

Modifier and Type	Method	Description
private static String	actionType(String action)
private void	execute(CloudRequest request, CloudChannel channel, String action)	Runs once per newly recorded id: the operator switch, then (for a restart) the restart pre-check, then the result, the pre-shutdown hook and the scheduled power action in that order.
void	handle(CloudRequest request, CloudChannel channel)	Validates the action, then runs persist-acknowledge-execute.
private void	record(RemoteActionLog.Entry entry)
private void	runPreShutdownHook(String action)	A failing hook must not cancel an action the operator asked for: it is logged once and the power action proceeds.
private void	schedule(String action)	The result frame was already handed to the channel, so a scheduler refusal is reported locally and nothing tries to answer the panel a second time.

Methods inherited from class java.lang.Object

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

Field Details

TYPE

static final String TYPE

The frozen contract request type this handler consumes.

See Also:

• Constant Field Values

RESULT_TYPE

static final String RESULT_TYPE

The frozen contract result type every delivery is answered with.

See Also:

• Constant Field Values

ACTION_STOP

static final String ACTION_STOP

The contract's first action value.

See Also:

• Constant Field Values

ACTION_RESTART

static final String ACTION_RESTART

The contract's second action value.

See Also:

• Constant Field Values

ACTOR

static final String ACTOR

server.power carries no executor field, so the action log names the panel itself.

See Also:

• Constant Field Values

LOGGER

private static final Logger LOGGER

ledger

private final DedupeLedger ledger

powerEnabled

private final BooleanSupplier powerEnabled

executor

private final PowerActionHandler.PowerExecutor executor

preShutdownHook

private final Runnable preShutdownHook

actionLog

private final Consumer<RemoteActionLog.Entry> actionLog

Constructor Details

PowerActionHandler

PowerActionHandler(DedupeLedger ledger,
 BooleanSupplier powerEnabled,
 PowerActionHandler.PowerExecutor executor,
 Runnable preShutdownHook,
 Consumer<RemoteActionLog.Entry> actionLog)

Creates the handler.

Parameters:

ledger - the session ledger the request id is recorded in before the acknowledgement

powerEnabled - the operator's power-actions switch, read on every delivery

executor - schedules the stop or restart and reports whether a restart is possible

preShutdownHook - runs after the result frame and before the power action is scheduled

actionLog - receives one allowed or denied entry per delivery, or null to record nothing

Method Details

handle

public void handle(CloudRequest request,
 CloudChannel channel)

Validates the action, then runs persist-acknowledge-execute. A payload that does not match the contract propagates as invalid_message before anything is recorded.

Specified by:

handle in interface CloudRequestHandler

Parameters:

request - the parsed request

channel - the reply channel

execute

private void execute(CloudRequest request,
 CloudChannel channel,
 String action)

Runs once per newly recorded id: the operator switch, then (for a restart) the restart pre-check, then the result, the pre-shutdown hook and the scheduled power action in that order.

runPreShutdownHook

private void runPreShutdownHook(String action)

A failing hook must not cancel an action the operator asked for: it is logged once and the power action proceeds.

schedule

private void schedule(String action)

The result frame was already handed to the channel, so a scheduler refusal is reported locally and nothing tries to answer the panel a second time.

record

private void record(RemoteActionLog.Entry entry)

actionType

private static String actionType(String action)