Index (api API)

A B C D E F G H I L M O P R S T U V W
All Classes and Interfaces|All Packages

A

accept(MessageContext<T>, T) - Method in interface dev.objz.commandbridge.api.message.MessageListener: Invoked when a message matching this listener's payload type is received.
accept(Platform.ServerTarget) - Method in interface dev.objz.commandbridge.api.message.ServerEventListener: Invoked when a server connects or disconnects from the bridge network.
AUTH_FAILED - Enum constant in enum class dev.objz.commandbridge.api.platform.ConnectionState: Authentication failed; no further connection attempts will be made.
AUTHENTICATED - Enum constant in enum class dev.objz.commandbridge.api.platform.ConnectionState: Fully connected and authenticated; messages may be sent and received.

B

backend(String) - Static method in enum class dev.objz.commandbridge.api.platform.Platform: Creates a Platform.ServerTarget identifying a backend server.
BACKEND - Enum constant in enum class dev.objz.commandbridge.api.platform.Platform: Represents a backend Minecraft server (for example, Paper, Folia, or Bukkit).

C

cancel() - Method in interface dev.objz.commandbridge.api.message.Subscription: Unregisters the associated listener so it receives no further events.
channel() - Method in record class dev.objz.commandbridge.api.message.MessageContext: Returns the value of the channel record component.
channel(Class<T>) - Method in interface dev.objz.commandbridge.api.CommandBridgeAPI: Obtains a typed MessageChannel for the given payload type.
ChannelPayload - Interface in dev.objz.commandbridge.api.channel: Marker interface for all data types that can be sent over a MessageChannel.
command() - Method in record class dev.objz.commandbridge.api.channel.command.CommandPayload: Returns the value of the command record component.
CommandBridgeAPI - Interface in dev.objz.commandbridge.api: Primary interface for interacting with the CommandBridge network from a third-party plugin.
CommandBridgeProvider - Class in dev.objz.commandbridge.api: Static provider for obtaining the CommandBridgeAPI singleton instance.
CommandPayload - Record Class in dev.objz.commandbridge.api.channel.command: Payload carrying a command to be executed on a remote server via the CommandBridge network.
CommandPayload(String, RunAs) - Constructor for record class dev.objz.commandbridge.api.channel.command.CommandPayload: Creates a payload with no player context, equivalent to new CommandPayload(command, runAs, null).
CommandPayload(String, RunAs, UUID) - Constructor for record class dev.objz.commandbridge.api.channel.command.CommandPayload: Creates an instance of a CommandPayload record class.
CONNECTED - Enum constant in enum class dev.objz.commandbridge.api.platform.ConnectionState: The socket connection is established; awaiting authentication.
connectedServers() - Method in interface dev.objz.commandbridge.api.CommandBridgeAPI: Returns the identifiers of all servers currently connected to the bridge network.
CONNECTING - Enum constant in enum class dev.objz.commandbridge.api.platform.ConnectionState: A socket connection is being established.
connectionState() - Method in interface dev.objz.commandbridge.api.CommandBridgeAPI: Returns the current connection state of this server to the CommandBridge network.
ConnectionState - Enum Class in dev.objz.commandbridge.api.platform: Represents the network connection status between a server and the CommandBridge network.
CONSOLE - Enum constant in enum class dev.objz.commandbridge.api.channel.command.RunAs: Executes the command as the server console.

D

dev.objz.commandbridge.api - package dev.objz.commandbridge.api
dev.objz.commandbridge.api.channel - package dev.objz.commandbridge.api.channel
dev.objz.commandbridge.api.channel.command - package dev.objz.commandbridge.api.channel.command
dev.objz.commandbridge.api.message - package dev.objz.commandbridge.api.message
dev.objz.commandbridge.api.platform - package dev.objz.commandbridge.api.platform
DISCONNECTED - Enum constant in enum class dev.objz.commandbridge.api.platform.ConnectionState: No connection has been established.

E

equals(Object) - Method in record class dev.objz.commandbridge.api.channel.command.CommandPayload: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.objz.commandbridge.api.message.MessageContext: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.objz.commandbridge.api.platform.Platform.ServerTarget: Indicates whether some other object is "equal to" this one.

F

from() - Method in record class dev.objz.commandbridge.api.message.MessageContext: Returns the value of the from record component.

G

get() - Static method in class dev.objz.commandbridge.api.CommandBridgeProvider: Returns the registered CommandBridgeAPI instance.
get(Class<T>) - Static method in class dev.objz.commandbridge.api.CommandBridgeProvider: Returns the registered CommandBridgeAPI instance cast to the specified subtype.

H

hashCode() - Method in record class dev.objz.commandbridge.api.channel.command.CommandPayload: Returns a hash code value for this object.
hashCode() - Method in record class dev.objz.commandbridge.api.message.MessageContext: Returns a hash code value for this object.
hashCode() - Method in record class dev.objz.commandbridge.api.platform.Platform.ServerTarget: Returns a hash code value for this object.

I

id() - Method in record class dev.objz.commandbridge.api.platform.Platform.ServerTarget: Returns the value of the id record component.
isActive() - Method in enum class dev.objz.commandbridge.api.platform.ConnectionState: Returns whether the connection is established and ready for message transport.

L

listen(MessageListener<P>) - Method in interface dev.objz.commandbridge.api.channel.MessageChannel: Subscribes to messages received on this channel.
locate(UUID) - Method in interface dev.objz.commandbridge.api.platform.PlayerLocator: Resolves the server a player is currently connected to.

M

MessageChannel<P> - Interface in dev.objz.commandbridge.api.channel: A typed communication pipe for sending and receiving messages across the CommandBridge network.
MessageChannel.Sender<P> - Interface in dev.objz.commandbridge.api.channel: A target-bound sender created by MessageChannel.to(java.util.Collection) or MessageChannel.toAll(), used to dispatch payloads to the targeted servers.
MessageContext<T> - Record Class in dev.objz.commandbridge.api.message: Metadata accompanying a message received on a MessageChannel.
MessageContext(Class<T>, Platform.ServerTarget, long) - Constructor for record class dev.objz.commandbridge.api.message.MessageContext: Creates an instance of a MessageContext record class.
MessageListener<T> - Interface in dev.objz.commandbridge.api.message: Callback for handling messages received on a typed MessageChannel.

O

onConnectionStateChanged(Consumer<ConnectionState>) - Method in interface dev.objz.commandbridge.api.CommandBridgeAPI: Subscribes to connection state changes on this server.
onServerConnected(ServerEventListener) - Method in interface dev.objz.commandbridge.api.CommandBridgeAPI: Subscribes to server connection events.
onServerDisconnected(ServerEventListener) - Method in interface dev.objz.commandbridge.api.CommandBridgeAPI: Subscribes to server disconnection events.
OPERATOR - Enum constant in enum class dev.objz.commandbridge.api.channel.command.RunAs: Executes the command as a specific player with temporary operator-level permissions.

P

Platform - Enum Class in dev.objz.commandbridge.api.platform: Enumeration of the two supported bridge platforms: the Velocity proxy and backend servers.
Platform.ServerTarget - Record Class in dev.objz.commandbridge.api.platform: Identifies a specific server in the bridge network by its unique identifier and platform type.
player() - Method in record class dev.objz.commandbridge.api.channel.command.CommandPayload: Returns the value of the player record component.
PLAYER - Enum constant in enum class dev.objz.commandbridge.api.channel.command.RunAs: Executes the command as a specific player with their normal permissions.
playerLocator() - Method in interface dev.objz.commandbridge.api.CommandBridgeAPI: Returns the player location service for resolving which server a player is connected to.
PlayerLocator - Interface in dev.objz.commandbridge.api.platform: Service for resolving which server a player is currently connected to within the bridge network.

R

RECONNECTING - Enum constant in enum class dev.objz.commandbridge.api.platform.ConnectionState: The connection was lost and a reconnection attempt is in progress.
register(CommandBridgeAPI) - Static method in class dev.objz.commandbridge.api.CommandBridgeProvider: Registers the CommandBridgeAPI implementation.
request(P) - Method in interface dev.objz.commandbridge.api.channel.MessageChannel.Sender: Sends a payload and returns a future that completes with the remote server's response, using the default timeout.
request(P, Duration) - Method in interface dev.objz.commandbridge.api.channel.MessageChannel.Sender: Sends a payload and returns a future that completes with the remote server's response, using a custom timeout.
requirePlayer() - Method in interface dev.objz.commandbridge.api.channel.MessageChannel.Sender: Constrains this sender to only execute if the triggering player (if any) is present on the target server at the time of delivery.
requirePlayer(UUID) - Method in interface dev.objz.commandbridge.api.channel.MessageChannel.Sender: Constrains this sender to only execute if the specified player is present on the target server at the time of delivery.
runAs() - Method in record class dev.objz.commandbridge.api.channel.command.CommandPayload: Returns the value of the runAs record component.
RunAs - Enum Class in dev.objz.commandbridge.api.channel.command: Defines the execution context for a command dispatched through the CommandBridge network.

S

send(P) - Method in interface dev.objz.commandbridge.api.channel.MessageChannel.Sender: Sends a payload to the targeted servers without waiting for a response.
server() - Method in interface dev.objz.commandbridge.api.CommandBridgeAPI: Returns the identity of the server this API instance is running on.
ServerEventListener - Interface in dev.objz.commandbridge.api.message: Callback invoked when a server connects to or disconnects from the CommandBridge network.
ServerTarget(String, Platform) - Constructor for record class dev.objz.commandbridge.api.platform.Platform.ServerTarget: Creates an instance of a ServerTarget record class.
Subscription - Interface in dev.objz.commandbridge.api.message: A handle to a registered listener that allows the registration to be cancelled.

T

target(String) - Method in enum class dev.objz.commandbridge.api.platform.Platform: Creates a Platform.ServerTarget for this platform with the given identifier.
timestamp() - Method in record class dev.objz.commandbridge.api.message.MessageContext: Returns the value of the timestamp record component.
to(Collection<Platform.ServerTarget>) - Method in interface dev.objz.commandbridge.api.channel.MessageChannel: Returns a MessageChannel.Sender targeting the specified servers.
toAll() - Method in interface dev.objz.commandbridge.api.channel.MessageChannel: Returns a MessageChannel.Sender that broadcasts to all servers currently connected to the bridge network.
toString() - Method in record class dev.objz.commandbridge.api.channel.command.CommandPayload: Returns a string representation of this record class.
toString() - Method in record class dev.objz.commandbridge.api.message.MessageContext: Returns a string representation of this record class.
toString() - Method in record class dev.objz.commandbridge.api.platform.Platform.ServerTarget: Returns a string representation of this record class.
type() - Method in record class dev.objz.commandbridge.api.platform.Platform.ServerTarget: Returns the value of the type record component.

U

unregister() - Static method in class dev.objz.commandbridge.api.CommandBridgeProvider: Clears the registered CommandBridgeAPI implementation.

V

valueOf(String) - Static method in enum class dev.objz.commandbridge.api.channel.command.RunAs: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class dev.objz.commandbridge.api.platform.ConnectionState: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class dev.objz.commandbridge.api.platform.Platform: Returns the enum constant of this class with the specified name.
values() - Static method in enum class dev.objz.commandbridge.api.channel.command.RunAs: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class dev.objz.commandbridge.api.platform.ConnectionState: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class dev.objz.commandbridge.api.platform.Platform: Returns an array containing the constants of this enum class, in the order they are declared.
velocity(String) - Static method in enum class dev.objz.commandbridge.api.platform.Platform: Creates a Platform.ServerTarget identifying a Velocity proxy server.
VELOCITY - Enum constant in enum class dev.objz.commandbridge.api.platform.Platform: Represents the Velocity proxy.

W

whenOnline() - Method in interface dev.objz.commandbridge.api.channel.MessageChannel.Sender: Queues the payload for delivery to the target server when the triggering player (if any) is online.
whenOnline(UUID) - Method in interface dev.objz.commandbridge.api.channel.MessageChannel.Sender: Queues the payload for delivery to the target server when the specified player is online.

A B C D E F G H I L M O P R S T U V W
All Classes and Interfaces|All Packages