com.elikill58.negativity.universal.warn.processor

Interface WarnProcessor

All Known Implementing Classes:

CommandWarnProcessor, ForwardToProxyWarnProcessor, NegativityDatabaseWarnProcessor, NegativityFileWarnProcessor

public interface WarnProcessor

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

WarnManager basically delegates actions to a WarnProcessor.

See Also:

BanProcessorProvider - the preferred way to register WarnProcessors, WarnManager.registerProcessor(String, WarnProcessor)

Method Summary

Modifier and Type	Method and Description
default void	disable() Disable the given processor.
default void	enable() Enable the given processor.
WarnResult	executeWarn(Warn warn) Executes the given warn.
default List<Warn>	getActiveWarn(UUID playerId) Get all active warns of a given player
List<Warn>	getActiveWarnOnSameIP(String ip) Get all active warn on the same IP
List<String>	getDescription() Get the description of the processor, including what's not available with this
String	getName() Get the name of the processor
List<Warn>	getWarn(UUID playerId) Get all warns of a given player
default boolean	isWarned(UUID playerId) Check if the player is warned with an active one
WarnResult	revokeWarn(UUID playerId, String revoker) Revokes all active warns for the given player The revocation may fail for any processor-specific reason.
WarnResult	revokeWarn(Warn warn, String revoker) Revokes only given warn for the given player The revocation may fail for any processor-specific reason.

Method Detail

enable

default void enable()

Enable the given processor.

disable

default void disable()

Disable the given processor.

executeWarn

WarnResult executeWarn(Warn warn)

Executes the given warn.

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

Parameters:

warn - the warn to execute

Returns:

the result of the execution

revokeWarn

WarnResult revokeWarn(UUID playerId,
                      String revoker)

Revokes all active warns for the given player

The revocation may fail for any processor-specific reason.

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

Parameters:

playerId - the UUID of the player to unwarn

revoker - who revoke warn

Returns:

the logged revoked warn or null if the revocation failed.

revokeWarn

WarnResult revokeWarn(Warn warn,
                      String revoker)

Revokes only given warn for the given player

The revocation may fail for any processor-specific reason.

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

Parameters:

warn - warn to remove

revoker - who revoke warn

Returns:

the logged revoked warn or null if the revocation failed.

isWarned

default boolean isWarned(UUID playerId)

Check if the player is warned with an active one

Parameters:

playerId - player to check

Returns:

true if a warn is active

getWarn

List<Warn> getWarn(UUID playerId)

Get all warns of a given player

Parameters:

playerId - UUID of player

Returns:

all warns of player, or empty

getActiveWarn

default List<Warn> getActiveWarn(UUID playerId)

Get all active warns of a given player

Parameters:

playerId - UUID of player

Returns:

all active warns of player, or empty

getActiveWarnOnSameIP

List<Warn> getActiveWarnOnSameIP(String ip)

Get all active warn on the same IP

Parameters:

ip - the IP where we are looking for warn

Returns:

all ban on IP

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