Package com.velocitypowered.api.proxy.server

Enum Class ServerInfoForwardingMode

java.lang.Object

java.lang.Enum<ServerInfoForwardingMode>

com.velocitypowered.api.proxy.server.ServerInfoForwardingMode

All Implemented Interfaces:

Serializable, Comparable<ServerInfoForwardingMode>, Constable

public enum ServerInfoForwardingMode
extends Enum<ServerInfoForwardingMode>

Supported per-server player info forwarding methods.

These modes define how Velocity forwards player identity and connection information to backend servers. The correct mode must be chosen depending on the backend server version and its support for forwarding mechanisms.

Since:

3.4.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BUNGEEGUARD	Use BungeeGuard-compatible forwarding.
LEGACY	Use legacy forwarding mode compatible with BungeeCord's IP forwarding.
MODERN	Forward player information using Velocity's modern forwarding system, based on cryptographic signatures.
NONE	Do not forward any player information.

Method Summary

Modifier and Type	Method	Description
static ServerInfoForwardingMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ServerInfoForwardingMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MODERN

public static final ServerInfoForwardingMode MODERN

Forward player information using Velocity's modern forwarding system, based on cryptographic signatures. This is the preferred method for modern (1.13+) servers that support it.

BUNGEEGUARD

public static final ServerInfoForwardingMode BUNGEEGUARD

Use BungeeGuard-compatible forwarding. This method provides a shared-secret system for player information forwarding between the proxy and backend servers.

LEGACY

public static final ServerInfoForwardingMode LEGACY

Use legacy forwarding mode compatible with BungeeCord's IP forwarding. This should only be used when connecting to older (1.12 or below) backend servers that do not support modern forwarding mechanisms.

NONE

public static final ServerInfoForwardingMode NONE

Do not forward any player information. The backend server will see all connections as if they originated directly from the proxy itself.

Method Details

values

public static ServerInfoForwardingMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ServerInfoForwardingMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null