com.elikill58.negativity.universal.ban.processor

Class NegativityBanProcessor

java.lang.Object

com.elikill58.negativity.universal.ban.processor.NegativityBanProcessor

All Implemented Interfaces:

BanProcessor

public class NegativityBanProcessor
extends Object
implements BanProcessor

This ban processor simply saves bans (active and logged) in a configurable storage (ActiveBanStorage and BanLogsStorage respectively).

It is important to know its sole purpose is to manage bans, and will not do anything on the game server, like kicking the player when BanProcessor.executeBan(Ban) executing a ban. If you want direct actions on the game server use NegativityBanProcessor instead.

Field Summary

Fields

Modifier and Type	Field and Description
protected ActiveBanStorage	activeBanStorage
protected @Nullable BanLogsStorage	banLogsStorage
protected String	name

Constructor Summary

Constructors

Constructor and Description
NegativityBanProcessor(ActiveBanStorage activeBanStorage, @Nullable BanLogsStorage banLogsStorage, String name)

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
boolean	isHandledByNegativity()
BanResult	revokeBan(UUID playerId) Revokes the active ban of the player identified by the given UUID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.elikill58.negativity.universal.ban.processor.BanProcessor

isBanned

Field Detail

activeBanStorage

protected final ActiveBanStorage activeBanStorage

banLogsStorage

protected final @Nullable BanLogsStorage banLogsStorage

name

protected final String name

Constructor Detail

NegativityBanProcessor

public NegativityBanProcessor(ActiveBanStorage activeBanStorage,
                              @Nullable BanLogsStorage banLogsStorage,
                              String name)

Method Detail

executeBan

public BanResult executeBan(Ban ban)

Description copied from interface: BanProcessor

Executes the given ban.

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

Specified by:

executeBan in interface BanProcessor

Parameters:

ban - the ban to execute

Returns:

the result of the execution

revokeBan

public BanResult revokeBan(UUID playerId)

Description copied from interface: BanProcessor

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.

Specified by:

revokeBan in interface BanProcessor

Parameters:

playerId - the UUID of the player to unban

Returns:

the logged revoked ban or null if the revocation failed.

getActiveBan

public @Nullable Ban getActiveBan(UUID playerId)

Specified by:

getActiveBan in interface BanProcessor

getLoggedBans

public List<Ban> getLoggedBans(UUID playerId)

Description copied from interface: BanProcessor

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

Specified by:

getLoggedBans in interface BanProcessor

Parameters:

playerId - the UUID of the player to get logged ban

Returns:

all logged ban

getActiveBanOnSameIP

public List<Ban> getActiveBanOnSameIP(String ip)

Description copied from interface: BanProcessor

Get all active ban on the same IP

Specified by:

getActiveBanOnSameIP in interface BanProcessor

Parameters:

ip - the IP where we are looking for ban

Returns:

all ban on IP

getAllBans

public List<Ban> getAllBans()

Description copied from interface: BanProcessor

Get all current ban.

Specified by:

getAllBans in interface BanProcessor

Returns:

all active bans

isHandledByNegativity

public boolean isHandledByNegativity()

Specified by:

isHandledByNegativity in interface BanProcessor

Returns:

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

getName

public String getName()

Description copied from interface: BanProcessor

Get the name of the processor

Specified by:

getName in interface BanProcessor

Returns:

processor name

getDescription

public List<String> getDescription()

Description copied from interface: BanProcessor

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

Specified by:

getDescription in interface BanProcessor

Returns:

the processor description