Interface ClientOrchestrator

public interface ClientOrchestrator

Cross-client script lifecycle and group management.

Provides operations to start/stop scripts on individual clients, across named groups, or on every connected client. Groups can be created with descriptions (e.g. "Skillers", "Combat") and used to target bulk operations.

Obtain via ManagementContext.getOrchestrator().

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	ClientOrchestrator.OpResult	Result of a script operation on a specific client.
static final record	ClientOrchestrator.ScheduledScriptEntry	A single active schedule pinned to a specific client.
static final record	ClientOrchestrator.ScheduleOpResult	Result of a schedule operation.
static final record	ClientOrchestrator.ScriptStatusEntry	Snapshot of a script's state on a specific client.

Method Summary

Modifier and Type	Method	Description
boolean	addToGroup(String groupName, String clientName)	Adds a client to a group.
void	cancelAllSchedules()	Cancels every schedule on every connected client.
List<ClientOrchestrator.ScheduleOpResult>	cancelAllSchedulesOnGroup(String groupName)	Cancels every schedule on every client in a group; one result per cancellation.
boolean	cancelSchedule(String clientName, String scheduleId)	Cancels a single schedule on the named client.
default boolean	createGroup(String name)	Creates a group with no description.
boolean	createGroup(String name, String description)	Creates a group.
boolean	deleteGroup(String name)	Deletes a group.
List<String>	getClientNames()	Returns the names of all connected clients.
String	getGroupDescription(String groupName)	Returns the description of a group, or null.
Set<String>	getGroupMembers(String groupName)	Returns the client names in a group.
Set<String>	getGroupNames()	Returns the names of all groups.
List<ClientOrchestrator.ScriptStatusEntry>	getStatusAll()	Returns script status across all clients.
List<ClientOrchestrator.ScriptStatusEntry>	getStatusForGroup(String groupName)	Returns script status for clients in a group.
boolean	isClientAlive(String name)	Returns true if the named client is connected and alive.
List<ClientOrchestrator.ScheduledScriptEntry>	listScheduled()	Returns every active schedule across all connected clients.
List<ClientOrchestrator.ScheduledScriptEntry>	listScheduledForClient(String clientName)	Returns active schedules on the named client.
List<ClientOrchestrator.ScheduledScriptEntry>	listScheduledForGroup(String groupName)	Returns active schedules across all clients in a group.
boolean	removeFromGroup(String groupName, String clientName)	Removes a client from a group.
ClientOrchestrator.OpResult	restartScript(String clientName, String scriptName)	Restarts a script on a specific client.
List<ClientOrchestrator.OpResult>	restartScriptOnAll(String scriptName)	Restarts a script on every connected client.
List<ClientOrchestrator.OpResult>	restartScriptOnGroup(String groupName, String scriptName)	Restarts a script on all clients in a group.
ClientOrchestrator.ScheduleOpResult	scheduleScript(String clientName, String scriptName, Duration delay)	Schedules a one-shot start of a script after delay.
ClientOrchestrator.ScheduleOpResult	scheduleScript(String clientName, String scriptName, Duration delay, Map<String,Object> config)	Schedules a one-shot start of a script after delay, applying config before start.
ClientOrchestrator.ScheduleOpResult	scheduleScriptAt(String clientName, String scriptName, Instant at)	Schedules a one-shot start of a script at the given instant.
ClientOrchestrator.ScheduleOpResult	scheduleScriptEvery(String clientName, String scriptName, Duration interval)	Schedules a script to repeat on a fixed interval.
ClientOrchestrator.ScheduleOpResult	scheduleScriptEvery(String clientName, String scriptName, Duration interval, Duration maxDuration)	Schedules a script to repeat on a fixed interval, auto-stopping after maxDuration each cycle.
List<ClientOrchestrator.ScheduleOpResult>	scheduleScriptOnAll(String scriptName, Duration delay)	Schedules a one-shot start of a script on every connected client.
List<ClientOrchestrator.ScheduleOpResult>	scheduleScriptOnAll(String scriptName, Duration delay, Map<String,Object> config)	Schedules a one-shot start of a script on every connected client, applying config before start.
List<ClientOrchestrator.ScheduleOpResult>	scheduleScriptOnAllAt(String scriptName, Instant at)	Schedules a one-shot start at the given instant on every connected client.
List<ClientOrchestrator.ScheduleOpResult>	scheduleScriptOnAllEvery(String scriptName, Duration interval)	Schedules a recurring script on every connected client.
List<ClientOrchestrator.ScheduleOpResult>	scheduleScriptOnAllEvery(String scriptName, Duration interval, Duration maxDuration)	Schedules a recurring script on every connected client with an auto-stop after maxDuration each cycle.
List<ClientOrchestrator.ScheduleOpResult>	scheduleScriptOnGroup(String groupName, String scriptName, Duration delay)	Schedules a one-shot start of a script on every client in a group.
List<ClientOrchestrator.ScheduleOpResult>	scheduleScriptOnGroup(String groupName, String scriptName, Duration delay, Map<String,Object> config)	Schedules a one-shot start of a script on every client in a group, applying config before start.
List<ClientOrchestrator.ScheduleOpResult>	scheduleScriptOnGroupAt(String groupName, String scriptName, Instant at)	Schedules a one-shot start at the given instant on every client in a group.
List<ClientOrchestrator.ScheduleOpResult>	scheduleScriptOnGroupEvery(String groupName, String scriptName, Duration interval)	Schedules a recurring script on every client in a group.
List<ClientOrchestrator.ScheduleOpResult>	scheduleScriptOnGroupEvery(String groupName, String scriptName, Duration interval, Duration maxDuration)	Schedules a recurring script on every client in a group with an auto-stop after maxDuration each cycle.
void	setGroupDescription(String groupName, String description)	Sets the description of a group.
ClientOrchestrator.OpResult	startScript(String clientName, String scriptName)	Starts a script on a specific client.
List<ClientOrchestrator.OpResult>	startScriptOnAll(String scriptName)	Starts a script on every connected client.
List<ClientOrchestrator.OpResult>	startScriptOnGroup(String groupName, String scriptName)	Starts a script on all clients in a group.
void	stopAllScriptsOnAll()	Stops all scripts on every connected client.
List<ClientOrchestrator.OpResult>	stopAllScriptsOnGroup(String groupName)	Stops all scripts on all clients in a group.
ClientOrchestrator.OpResult	stopScript(String clientName, String scriptName)	Stops a script on a specific client.
List<ClientOrchestrator.OpResult>	stopScriptOnAll(String scriptName)	Stops a script on every connected client.
List<ClientOrchestrator.OpResult>	stopScriptOnGroup(String groupName, String scriptName)	Stops a script on all clients in a group.

Method Details

getClientNames

List<String> getClientNames()

Returns the names of all connected clients.

isClientAlive

boolean isClientAlive(String name)

Returns true if the named client is connected and alive.

createGroup

boolean createGroup(String name,
 String description)

Creates a group. Returns true if newly created.

createGroup

default boolean createGroup(String name)

Creates a group with no description.

deleteGroup

boolean deleteGroup(String name)

Deletes a group. Returns true if it existed.

getGroupNames

Set<String> getGroupNames()

Returns the names of all groups.

getGroupDescription

String getGroupDescription(String groupName)

Returns the description of a group, or null.

setGroupDescription

void setGroupDescription(String groupName,
 String description)

Sets the description of a group.

getGroupMembers

Set<String> getGroupMembers(String groupName)

Returns the client names in a group.

addToGroup

boolean addToGroup(String groupName,
 String clientName)

Adds a client to a group.

removeFromGroup

boolean removeFromGroup(String groupName,
 String clientName)

Removes a client from a group.

startScript

ClientOrchestrator.OpResult startScript(String clientName,
 String scriptName)

Starts a script on a specific client.

stopScript

ClientOrchestrator.OpResult stopScript(String clientName,
 String scriptName)

Stops a script on a specific client.

restartScript

ClientOrchestrator.OpResult restartScript(String clientName,
 String scriptName)

Restarts a script on a specific client.

startScriptOnGroup

List<ClientOrchestrator.OpResult> startScriptOnGroup(String groupName,
 String scriptName)

Starts a script on all clients in a group.

stopScriptOnGroup

List<ClientOrchestrator.OpResult> stopScriptOnGroup(String groupName,
 String scriptName)

Stops a script on all clients in a group.

restartScriptOnGroup

List<ClientOrchestrator.OpResult> restartScriptOnGroup(String groupName,
 String scriptName)

Restarts a script on all clients in a group.

stopAllScriptsOnGroup

List<ClientOrchestrator.OpResult> stopAllScriptsOnGroup(String groupName)

Stops all scripts on all clients in a group.

startScriptOnAll

List<ClientOrchestrator.OpResult> startScriptOnAll(String scriptName)

Starts a script on every connected client.

stopScriptOnAll

List<ClientOrchestrator.OpResult> stopScriptOnAll(String scriptName)

Stops a script on every connected client.

restartScriptOnAll

List<ClientOrchestrator.OpResult> restartScriptOnAll(String scriptName)

Restarts a script on every connected client.

stopAllScriptsOnAll

void stopAllScriptsOnAll()

Stops all scripts on every connected client.

scheduleScript

ClientOrchestrator.ScheduleOpResult scheduleScript(String clientName,
 String scriptName,
 Duration delay)

Schedules a one-shot start of a script after delay.

scheduleScript

ClientOrchestrator.ScheduleOpResult scheduleScript(String clientName,
 String scriptName,
 Duration delay,
 Map<String,Object> config)

Schedules a one-shot start of a script after delay, applying config before start.

scheduleScriptAt

ClientOrchestrator.ScheduleOpResult scheduleScriptAt(String clientName,
 String scriptName,
 Instant at)

Schedules a one-shot start of a script at the given instant.

scheduleScriptEvery

ClientOrchestrator.ScheduleOpResult scheduleScriptEvery(String clientName,
 String scriptName,
 Duration interval)

Schedules a script to repeat on a fixed interval.

scheduleScriptEvery

ClientOrchestrator.ScheduleOpResult scheduleScriptEvery(String clientName,
 String scriptName,
 Duration interval,
 Duration maxDuration)

Schedules a script to repeat on a fixed interval, auto-stopping after maxDuration each cycle.

scheduleScriptOnGroup

List<ClientOrchestrator.ScheduleOpResult> scheduleScriptOnGroup(String groupName,
 String scriptName,
 Duration delay)

Schedules a one-shot start of a script on every client in a group.

scheduleScriptOnGroup

List<ClientOrchestrator.ScheduleOpResult> scheduleScriptOnGroup(String groupName,
 String scriptName,
 Duration delay,
 Map<String,Object> config)

Schedules a one-shot start of a script on every client in a group, applying config before start.

scheduleScriptOnGroupAt

List<ClientOrchestrator.ScheduleOpResult> scheduleScriptOnGroupAt(String groupName,
 String scriptName,
 Instant at)

Schedules a one-shot start at the given instant on every client in a group.

scheduleScriptOnGroupEvery

List<ClientOrchestrator.ScheduleOpResult> scheduleScriptOnGroupEvery(String groupName,
 String scriptName,
 Duration interval)

Schedules a recurring script on every client in a group.

scheduleScriptOnGroupEvery

List<ClientOrchestrator.ScheduleOpResult> scheduleScriptOnGroupEvery(String groupName,
 String scriptName,
 Duration interval,
 Duration maxDuration)

Schedules a recurring script on every client in a group with an auto-stop after maxDuration each cycle.

scheduleScriptOnAll

List<ClientOrchestrator.ScheduleOpResult> scheduleScriptOnAll(String scriptName,
 Duration delay)

Schedules a one-shot start of a script on every connected client.

scheduleScriptOnAll

List<ClientOrchestrator.ScheduleOpResult> scheduleScriptOnAll(String scriptName,
 Duration delay,
 Map<String,Object> config)

Schedules a one-shot start of a script on every connected client, applying config before start.

scheduleScriptOnAllAt

List<ClientOrchestrator.ScheduleOpResult> scheduleScriptOnAllAt(String scriptName,
 Instant at)

Schedules a one-shot start at the given instant on every connected client.

scheduleScriptOnAllEvery

List<ClientOrchestrator.ScheduleOpResult> scheduleScriptOnAllEvery(String scriptName,
 Duration interval)

Schedules a recurring script on every connected client.

scheduleScriptOnAllEvery

List<ClientOrchestrator.ScheduleOpResult> scheduleScriptOnAllEvery(String scriptName,
 Duration interval,
 Duration maxDuration)

Schedules a recurring script on every connected client with an auto-stop after maxDuration each cycle.

cancelSchedule

boolean cancelSchedule(String clientName,
 String scheduleId)

Cancels a single schedule on the named client.

cancelAllSchedulesOnGroup

List<ClientOrchestrator.ScheduleOpResult> cancelAllSchedulesOnGroup(String groupName)

Cancels every schedule on every client in a group; one result per cancellation.

cancelAllSchedules

void cancelAllSchedules()

Cancels every schedule on every connected client.

listScheduled

List<ClientOrchestrator.ScheduledScriptEntry> listScheduled()

Returns every active schedule across all connected clients.

listScheduledForClient

List<ClientOrchestrator.ScheduledScriptEntry> listScheduledForClient(String clientName)

Returns active schedules on the named client.

listScheduledForGroup

List<ClientOrchestrator.ScheduledScriptEntry> listScheduledForGroup(String groupName)

Returns active schedules across all clients in a group.

getStatusAll

List<ClientOrchestrator.ScriptStatusEntry> getStatusAll()

Returns script status across all clients.

getStatusForGroup

List<ClientOrchestrator.ScriptStatusEntry> getStatusForGroup(String groupName)

Returns script status for clients in a group.