net.md_5.bungee.api

Interface ProxyConfig

Deprecated.

This class is subject to rapid change between releases

@Deprecated
public interface ProxyConfig

Core configuration adaptor for the proxy api.

Method Summary

Modifier and Type	Method and Description
ServerInfo	addServer(ServerInfo server) Deprecated. Register the given server to the proxy.
boolean	addServers(Collection<ServerInfo> servers) Deprecated. Register all of the given servers to the proxy.
Collection<String>	getDisabledCommands() Deprecated. A collection of disabled commands.
String	getFavicon() Deprecated. Use #getFaviconObject instead.
Favicon	getFaviconObject() Deprecated. The favicon used for the server ping list.
String	getGameVersion() Deprecated. The supported versions
Collection<ListenerInfo>	getListeners() Deprecated. Set of all listeners.
int	getPlayerLimit() Deprecated. Returns the player max.
int	getRemotePingCache() Deprecated. Time in milliseconds to cache server list info from a ping request from the proxy to a server.
int	getRemotePingTimeout() Deprecated. Time in milliseconds before timing out a ping request from the proxy to a server when attempting to request server list info.
int	getServerConnectTimeout() Deprecated. Time in milliseconds before timing out a clients request to connect to a server.
ServerInfo	getServerInfo(String name) Deprecated. Gets the server info of a server.
Map<String,ServerInfo>	getServers() Deprecated. The returned map may be modified concurrently by the proxy. The safe alternative is getServersCopy().
Map<String,ServerInfo>	getServersCopy() Deprecated. Return all servers registered to this proxy, keyed by name.
int	getTabThrottle() Deprecated. How often tab-complete packets can be sent.
int	getThrottle() Deprecated.
int	getTimeout() Deprecated. Time before users are disconnected due to no network activity.
String	getUuid() Deprecated. UUID used for metrics.
boolean	isDisableEntityMetadataRewrite() Deprecated.
boolean	isDisableModernTabLimiter() Deprecated. Should we disable the tab completion limit for 1.13+ clients
boolean	isIpForward() Deprecated.
boolean	isLogCommands() Deprecated. Whether proxy commands are logged to the proxy log.
boolean	isLogInitialHandlerConnections() Deprecated. Whether we log InitialHandler connections
boolean	isOnlineMode() Deprecated. Does the server authenticate with Mojang.
boolean	isUseNettyDnsResolver() Deprecated. Whether Netty's async DNS resolver is used for account authentication.
ServerInfo	removeServer(ServerInfo server) Deprecated. Un-register the given server from the proxy.
ServerInfo	removeServerNamed(String name) Deprecated. Un-register the server with the given name from the proxy.
boolean	removeServers(Collection<ServerInfo> servers) Deprecated. Un-register all of the given servers from the proxy.
boolean	removeServersNamed(Collection<String> names) Deprecated. Un-register servers with any of the given names from the proxy.

Method Detail

getTimeout

int getTimeout()

Deprecated.

Time before users are disconnected due to no network activity.

Returns:

the time before users are disconnected due to no network activity.

getUuid

String getUuid()

Deprecated.

UUID used for metrics.

Returns:

the UUID used for metrics

getListeners

Collection<ListenerInfo> getListeners()

Deprecated.

Set of all listeners.

Returns:

a set of all listeners

getServers

@Deprecated
Map<String,ServerInfo> getServers()

Deprecated. The returned map may be modified concurrently by the proxy. The safe alternative is getServersCopy().

Set of all servers.

Returns:

a map of registered servers

getServersCopy

Map<String,ServerInfo> getServersCopy()

Deprecated.

Return all servers registered to this proxy, keyed by name. The returned map is an immutable snapshot of the actual server collection. It cannot be modified, and it will not change.

Returns:

all registered remote server destinations

getServerInfo

ServerInfo getServerInfo(String name)

Deprecated.

Gets the server info of a server.

Parameters:

name - the name of the configured server

Returns:

the server info belonging to the specified server

addServer

ServerInfo addServer(ServerInfo server)

Deprecated.

Register the given server to the proxy. Any currently registered server with the same name will be replaced. This change is not saved to config.yml

Parameters:

server - The server to register with the proxy

Returns:

the previously registered server with the same name, or null if there was no such server.

addServers

boolean addServers(Collection<ServerInfo> servers)

Deprecated.

Register all of the given servers to the proxy. This change is not saved to config.yml

Parameters:

servers - The collection of servers to register with the proxy

Returns:

true if any servers were added or replaced.

removeServerNamed

ServerInfo removeServerNamed(String name)

Deprecated.

Un-register the server with the given name from the proxy. This change is not saved to config.yml

Parameters:

name - The name of the server to unregister

Returns:

the server that was removed, or null if there is no server with the given name.

removeServer

ServerInfo removeServer(ServerInfo server)

Deprecated.

Un-register the given server from the proxy. The server is matched by name only, other fields in the given ServerInfo are ignored. This change is not saved to config.yml

Parameters:

server - the server to unregister from the proxy

Returns:

the server that was removed, or null if there is no server with a matching name.

removeServersNamed

boolean removeServersNamed(Collection<String> names)

Deprecated.

Un-register servers with any of the given names from the proxy. This change is not saved to config.yml

Parameters:

names - a collection of server names to be unregistered

Returns:

true if any servers were removed.

removeServers

boolean removeServers(Collection<ServerInfo> servers)

Deprecated.

Un-register all of the given servers from the proxy. The servers are matched by name only, other fields in the given ServerInfo are ignored. This change is not saved to config.yml

Parameters:

servers - a collection of servers to be unregistered

Returns:

true if any servers were removed.

isOnlineMode

boolean isOnlineMode()

Deprecated.

Does the server authenticate with Mojang.

Returns:

if the server authenticates to mojang

isLogCommands

boolean isLogCommands()

Deprecated.

Whether proxy commands are logged to the proxy log.

Returns:

should the proxy log commands

getRemotePingCache

int getRemotePingCache()

Deprecated.

Time in milliseconds to cache server list info from a ping request from the proxy to a server.

Returns:

cache time

getPlayerLimit

int getPlayerLimit()

Deprecated.

Returns the player max.

Returns:

player limit

getDisabledCommands

Collection<String> getDisabledCommands()

Deprecated.

A collection of disabled commands.

Returns:

a collection of disabled commands

getServerConnectTimeout

int getServerConnectTimeout()

Deprecated.

Time in milliseconds before timing out a clients request to connect to a server.

Returns:

connect timeout

getRemotePingTimeout

int getRemotePingTimeout()

Deprecated.

Time in milliseconds before timing out a ping request from the proxy to a server when attempting to request server list info.

Returns:

ping timeout

getThrottle

@Deprecated
int getThrottle()

Deprecated.

The connection throttle delay.

Returns:

the connection throttle delay

isIpForward

@Deprecated
boolean isIpForward()

Deprecated.

Whether the proxy will forward the players information (UUID, IP)

Returns:

should we forward player information

getFavicon

@Deprecated
String getFavicon()

Deprecated. Use #getFaviconObject instead.

The encoded favicon.

Returns:

the encoded favicon

getFaviconObject

Favicon getFaviconObject()

Deprecated.

The favicon used for the server ping list.

Returns:

the favicon used for the server ping list

isLogInitialHandlerConnections

boolean isLogInitialHandlerConnections()

Deprecated.

Whether we log InitialHandler connections

Returns:

whether we log InitialHandler connections

getGameVersion

String getGameVersion()

Deprecated.

The supported versions

Returns:

the supported versions

isUseNettyDnsResolver

boolean isUseNettyDnsResolver()

Deprecated.

Whether Netty's async DNS resolver is used for account authentication.

Returns:

whether Netty's async DNS resolver is used for account authentication.

getTabThrottle

int getTabThrottle()

Deprecated.

How often tab-complete packets can be sent.
Values in milliseconds.

Returns:

how often tab-complete packets can be sent in milliseconds

isDisableModernTabLimiter

boolean isDisableModernTabLimiter()

Deprecated.

Should we disable the tab completion limit for 1.13+ clients

Returns:

should we disable the tab completion limit for 1.13+ clients

isDisableEntityMetadataRewrite

boolean isDisableEntityMetadataRewrite()

Deprecated.

Returns:

Should we disable entity metadata rewriting?