com.elikill58.negativity.universal.ban.processor

Interface BanProcessor

All Known Implementing Classes:

CommandBanProcessor, ForwardToProxyBanProcessor, NegativityBanProcessor

public interface BanProcessor

Decides what to do with ban and unban requests as well as active and logged bans queries.

BanManager basically delegates actions to a BanProcessor.

See Also:

BanProcessorProvider - the preferred way to register BanProcessors, BanManager.registerProcessor(String, BanProcessor)

Method Summary

Modifier and Type	Method and Description
BanResult	executeBan(Ban ban) Executes the given ban.
@Nullable Ban	getActiveBan(UUID playerId)
List<Ban>	getActiveBanOnSameIP(String ip) Get all active ban on the same IP
List<Ban>	getAllBans() Get all current ban.
List<String>	getDescription() Get the description of the processor, including what's not available with this
List<Ban>	getLoggedBans(UUID playerId) Get revoked ban of the specified player Don't include active one
String	getName() Get the name of the processor
default boolean	isBanned(UUID playerId)
default boolean	isHandledByNegativity()
BanResult	revokeBan(UUID playerId) Revokes the active ban of the player identified by the given UUID.

Method Detail

executeBan

BanResult executeBan(Ban ban)

Executes the given ban.

The ban may not be executed for any processor-specific reason.

Parameters:

ban - the ban to execute

Returns:

the result of the execution

revokeBan

BanResult revokeBan(UUID playerId)

Revokes the active ban of the player identified by the given UUID.

The revocation may fail for any processor-specific reason.

If the revocation was successful a LoggedBan must always be returned, even if it will not persist in any way.

Parameters:

playerId - the UUID of the player to unban

Returns:

the logged revoked ban or null if the revocation failed.

isBanned

default boolean isBanned(UUID playerId)

getActiveBan

@Nullable Ban getActiveBan(UUID playerId)

getLoggedBans

List<Ban> getLoggedBans(UUID playerId)

Get revoked ban of the specified player Don't include active one

Parameters:

playerId - the UUID of the player to get logged ban

Returns:

all logged ban

getActiveBanOnSameIP

List<Ban> getActiveBanOnSameIP(String ip)

Get all active ban on the same IP

Parameters:

ip - the IP where we are looking for ban

Returns:

all ban on IP

getAllBans

List<Ban> getAllBans()

Get all current ban.

Returns:

all active bans

getName

String getName()

Get the name of the processor

Returns:

processor name

getDescription

List<String> getDescription()

Get the description of the processor, including what's not available with this

Returns:

the processor description

isHandledByNegativity

default boolean isHandledByNegativity()

Returns:

whether Negativity should kick banned players when this BanProcessor is used, should return false if bans are handled by another plugin.