me.lucko.helper.network.redirect

Interface RedirectSystem

All Superinterfaces:

AutoCloseable, Terminable

All Known Implementing Classes:

AbstractRedirectSystem

public interface RedirectSystem
extends Terminable

Implements a system for controlled redirects between servers.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RedirectSystem.ReceivedResponse Represents the response to a redirect request.
static interface	RedirectSystem.Request Encapsulates a redirect request
static interface	RedirectSystem.RequestHandler Handles incoming redirect requests for this server
static class	RedirectSystem.Response Encapsulates the response to a RedirectSystem.Request.

Field Summary

Fields inherited from interface me.lucko.helper.terminable.Terminable

EMPTY

Method Summary

Modifier and Type	Method and Description
void	addDefaultParameterProvider(RedirectParameterProvider provider) Adds a default parameter provider.
void	close() Closes this resource.
static <M extends Messenger & InstanceData & PlayerRedirector> RedirectSystem	create(M messenger) Creates a new RedirectSystem instance.
static RedirectSystem	create(Messenger messenger, InstanceData instanceData, PlayerRedirector redirecter) Creates a new RedirectSystem instance.
int	getExpectedConnectionsCount() Gets the number of connections which have been allowed, but not yet fully established.
static RedirectSystem	obtain(Supplier<RedirectSystem> ifElse) Tries to obtain an instance of RedirectSystem from the services manager, falling back to given supplier if one is not already present.
default Promise<RedirectSystem.ReceivedResponse>	redirectPlayer(String serverId, org.bukkit.entity.Player player, Map<String,String> params) Makes a request to redirect the given player to the given server.
Promise<RedirectSystem.ReceivedResponse>	redirectPlayer(String serverId, Profile profile, Map<String,String> params) Makes a request to redirect the given player to the given server.
void	setEnsure(boolean ensureJoinedViaQueue) Sets if the system should ensure that incoming connections were made (and accepted) by the redirect system.
void	setHandler(RedirectSystem.RequestHandler handler) Sets the RedirectSystem.RequestHandler for this instance.

Methods inherited from interface me.lucko.helper.terminable.Terminable

bindWith, closeAndReportException, closeSilently, isClosed

Method Detail

create

static RedirectSystem create(Messenger messenger,
                             InstanceData instanceData,
                             PlayerRedirector redirecter)

Creates a new RedirectSystem instance. These should be shared if possible.

Parameters:

messenger - the messenger

instanceData - the instance data

redirecter - the redirecter

Returns:

the new RedirectSystem

create

static <M extends Messenger & InstanceData & PlayerRedirector> RedirectSystem create(M messenger)

Creates a new RedirectSystem instance. These should be shared if possible.

Parameters:

messenger - the messenger

Returns:

the new RedirectSystem

obtain

static RedirectSystem obtain(Supplier<RedirectSystem> ifElse)

Tries to obtain an instance of RedirectSystem from the services manager, falling back to given supplier if one is not already present.

Parameters:

ifElse - the supplier

Returns:

the RedirectSystem instance

redirectPlayer

Promise<RedirectSystem.ReceivedResponse> redirectPlayer(@Nonnull
                                                        String serverId,
                                                        @Nonnull
                                                        Profile profile,
                                                        @Nonnull
                                                        Map<String,String> params)

Makes a request to redirect the given player to the given server.

Parameters:

serverId - the server to redirect to

profile - the player to be redirected

params - the parameters for the request

Returns:

a promise for the redirect response

redirectPlayer

default Promise<RedirectSystem.ReceivedResponse> redirectPlayer(@Nonnull
                                                                String serverId,
                                                                @Nonnull
                                                                org.bukkit.entity.Player player,
                                                                @Nonnull
                                                                Map<String,String> params)

Makes a request to redirect the given player to the given server.

Parameters:

serverId - the server to redirect to

player - the player to be redirected

params - the parameters for the request

Returns:

a promise for the redirect response

setHandler

void setHandler(@Nonnull
                RedirectSystem.RequestHandler handler)

Sets the RedirectSystem.RequestHandler for this instance.

Parameters:

handler - the handler

addDefaultParameterProvider

void addDefaultParameterProvider(@Nonnull
                                 RedirectParameterProvider provider)

Adds a default parameter provider.

Parameters:

provider - the provider

setEnsure

void setEnsure(boolean ensureJoinedViaQueue)

Sets if the system should ensure that incoming connections were made (and accepted) by the redirect system.

Parameters:

ensureJoinedViaQueue - if the system should ensure all joins are in the redirect queue

getExpectedConnectionsCount

int getExpectedConnectionsCount()

Gets the number of connections which have been allowed, but not yet fully established.

Returns:

the number of expected connections

close

void close()

Description copied from interface: Terminable

Closes this resource.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Terminable