Package com.ultikits.ultitools.utils

Class AgentCapabilities

java.lang.Object

com.ultikits.ultitools.utils.AgentCapabilities

final class AgentCapabilities
extends Object

The operator's switches as UltiCloud protocol capabilities (plan 22-21, S-65, S-66).

Mapping. MONITORING → telemetry; LOGS → logs; PLAYER_EVENTS → events:players, events:commands; ultipanel.logging.error-reporting.enabled → errors; COMMANDS → commands; PLAYER_ACTIONS → players:actions; FILE_READ → files:read, config:read; FILE_WRITE → files:write, config:write; FILE_DELETE → files:delete; SERVER_PROPERTIES → properties:read, properties:write. power is always declared, so the panel can show "turned off by the operator" from settings.powerActionsEnabled while the handler refuses with power_disabled; link is always declared, because a player link carries no action that is dangerous to the server. backups is never declared. Module names modules:<id>@<X.Y.Z> follow, sorted, and the whole list never exceeds MAX_NAMES.

Per request (S-66). The hello list changes only on the next connection, so enabled(String) reads the switch again for every request; a switch turned off after the handshake refuses the request with capability_not_accepted and refusal(String) names its configuration key. Whether the gateway accepted the capability at the handshake is checked separately, by the router's gate in AgentProtocol.

Availability (22-22 fix). A switched-on name whose feature cannot run on this server (the telemetry of a server without a monitor) is neither declared nor admitted per request; its refusal says it is not available instead of naming a switch that is already on. The hello and the router therefore read one predicate.

Field Summary

Fields

Modifier and Type	Field	Description
private final Predicate<String>	available
(package private) static final String	ERROR_REPORTING_KEY	The configuration key of the error-report switch that decides errors.
private final BooleanSupplier	errorReporting
private static final String	ERRORS
private static final String	LINK
(package private) static final int	MAX_NAMES	The contract's bound on the names of one hello.
private static final String	MODULE_PREFIX
private final Supplier<List<String>>	moduleNames
private static final String	POWER
private static final Map<String,Capability>	SWITCHES	Contract name to the switch that decides it, in hello order; null is the error-report key.
private final Predicate<Capability>	switchOn
private static final String	UNAVAILABLE

Constructor Summary

Constructors

Constructor	Description
AgentCapabilities(Predicate<Capability> switchOn, BooleanSupplier errorReporting, Supplier<List<String>> moduleNames)
AgentCapabilities(Predicate<Capability> switchOn, BooleanSupplier errorReporting, Supplier<List<String>> moduleNames, Predicate<String> available)

Method Summary

Modifier and Type	Method	Description
(package private) boolean	enabled(String contractCapability)
(package private) List<String>	helloCapabilities()
(package private) String	refusal(String contractCapability)
(package private) static Capability	switchFor(String contractCapability)

Methods inherited from class java.lang.Object

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

Field Details

ERROR_REPORTING_KEY

static final String ERROR_REPORTING_KEY

The configuration key of the error-report switch that decides errors.

See Also:

• Constant Field Values

MAX_NAMES

static final int MAX_NAMES

The contract's bound on the names of one hello.

See Also:

• Constant Field Values

ERRORS

private static final String ERRORS

See Also:

• Constant Field Values

POWER

private static final String POWER

See Also:

• Constant Field Values

LINK

private static final String LINK

See Also:

• Constant Field Values

MODULE_PREFIX

private static final String MODULE_PREFIX

See Also:

• Constant Field Values

UNAVAILABLE

private static final String UNAVAILABLE

See Also:

• Constant Field Values

SWITCHES

private static final Map<String,Capability> SWITCHES

Contract name to the switch that decides it, in hello order; null is the error-report key.

switchOn

private final Predicate<Capability> switchOn

errorReporting

private final BooleanSupplier errorReporting

moduleNames

private final Supplier<List<String>> moduleNames

available

private final Predicate<String> available

Constructor Details

AgentCapabilities

AgentCapabilities(Predicate<Capability> switchOn,
 BooleanSupplier errorReporting,
 Supplier<List<String>> moduleNames)

Parameters:

switchOn - whether an operator switch is on now (production: Capability.isEnabled())

errorReporting - whether "ultipanel.logging.error-reporting.enabled" is on now

moduleNames - the modules:<id>@<X.Y.Z> names of the modules that answer requests

AgentCapabilities

AgentCapabilities(Predicate<Capability> switchOn,
 BooleanSupplier errorReporting,
 Supplier<List<String>> moduleNames,
 Predicate<String> available)

Parameters:

switchOn - whether an operator switch is on now

errorReporting - whether "ultipanel.logging.error-reporting.enabled" is on now

moduleNames - the modules:<id>@<X.Y.Z> names of the modules that answer requests

available - whether the feature behind a switch-mapped contract name can run on this server now

Method Details

helloCapabilities

List<String> helloCapabilities()

Returns:

the names the next hello declares, framework names first in the order of the mapping, then module names sorted; at most MAX_NAMES

switchFor

static Capability switchFor(String contractCapability)

Parameters:

contractCapability - a contract capability name

Returns:

the operator switch that decides it, or null when no Capability switch does (the error-report key, power, link, module names, an unknown name)

enabled

boolean enabled(String contractCapability)

Parameters:

contractCapability - a contract capability name, or the module sentinel

Returns:

whether the operator allows it now: its switch for a mapped name; always for power (its handler applies the switch), link, module names and the module sentinel; never for backups or an unknown name

refusal

String refusal(String contractCapability)

Parameters:

contractCapability - a refused contract capability name

Returns:

the refusal sentence naming the switch's configuration key, or a fixed sentence for a name no switch decides