Package me.remigio07.chatplugin.api.common.punishment.ban

Class BanManager

java.lang.Object

me.remigio07.chatplugin.api.common.punishment.PunishmentManager

me.remigio07.chatplugin.api.common.punishment.ban.BanManager

All Implemented Interfaces:

ChatPluginManager

public abstract class BanManager
extends PunishmentManager

Manager that handles Bans and interacts with the storage.

See Also:

• ChatPlugin wiki/Modules/Punishments/Bans

Constructor Summary

Constructors

Constructor	Description
BanManager()

Method Summary

Modifier and Type	Method	Description
abstract void	ban(OfflinePlayer player, String staffMember, String reason, String server, long duration, boolean global, boolean silent)	Bans a player.
abstract void	banIP(InetAddress ipAddress, String staffMember, String reason, String server, long duration, boolean global, boolean silent)	Bans an IP address.
abstract void	banIP(OfflinePlayer player, String staffMember, String reason, String server, long duration, boolean global, boolean silent)	Bans a player by their IP address.
abstract String	formatActiveMessage(boolean active, Language language)	Formats a ban's active message using the message set in the specified language's messages file.
abstract String	formatGlobalMessage(boolean global, Language language)	Formats a ban's global message using the message set in the specified language's messages file.
abstract String	formatKickMessage(KickType type, Language language)	Formats a ban's kick message using the message set in the specified language's messages file.
abstract String	formatSilentMessage(boolean silent, Language language)	Formats a ban's silent message using the message set in the specified language's messages file.
abstract String	formatTypeMessage(BanType type, Language language)	Formats a ban's type message using the message set in the specified language's messages file.
abstract Ban	getActiveBan(int id)	Gets the active ban for the specified ID.
abstract Ban	getActiveBan(InetAddress ipAddress, String server)	Gets the active ban for the specified IP address and server.
abstract Ban	getActiveBan(OfflinePlayer player, String server)	Gets the active ban for the specified player and server.
List<Ban>	getActiveBans()	Gets the active bans' list.
abstract List<Ban>	getActiveBans(InetAddress ipAddress)	Gets the active bans' list for the specified IP address.
abstract List<Ban>	getActiveBans(OfflinePlayer player)	Gets the active bans' list for the specified player.
abstract Ban	getBan(int id)	Gets a ban from the database.
static BanManager	getInstance()	Gets this manager's instance.
boolean	isBanned(InetAddress ipAddress, String server)	Checks if an IP address is banned in the specified server.
boolean	isBanned(OfflinePlayer player, String server)	Checks if a player is banned in the specified server.
boolean	isDefaultGlobal()	Checks if bans should be global by default.
boolean	isEnabled()	Checks if this manager is enabled.
abstract void	unban(int id, String whoUnbanned)	Unbans a player based on their ban's ID.
abstract void	unban(OfflinePlayer player, String server, String whoUnbanned)	Unbans a player.
abstract void	unbanIP(InetAddress ipAddress, String server, String whoUnbanned)	Unbans an IP address.

Methods inherited from class me.remigio07.chatplugin.api.common.punishment.PunishmentManager

formatReason, getAnticheatStorageCount, getNextID, getStaffStorageCount, getStorageCount, load, setAnticheatStorageCount, setStaffStorageCount, setStorageCount

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.remigio07.chatplugin.api.common.util.manager.ChatPluginManager

checkAvailability, isReloadable, reload, unload

Constructor Details

BanManager

public BanManager()

Method Details

isEnabled

public boolean isEnabled()

Checks if this manager is enabled.

Found at: "ban.enabled" in ConfigurationType.CONFIG

Specified by:

isEnabled in interface ChatPluginManager

Overrides:

isEnabled in class PunishmentManager

Returns:

Whether this manager is enabled

getActiveBans

public List<Ban> getActiveBans()

Gets the active bans' list.

Do not modify the returned list.

Returns:

Active bans' list

isDefaultGlobal

public boolean isDefaultGlobal()

Checks if bans should be global by default.

Found at: "ban.default-global" in ConfigurationType.CONFIG

Returns:

Whether bans should be global

isBanned

public boolean isBanned(OfflinePlayer player,
 String server)

Checks if a player is banned in the specified server.

Specify null as server to check global bans.

Parameters:

player - Player to check

server - Origin server (ProxyManager.getServerID())

Returns:

Whether the player is banned

isBanned

public boolean isBanned(InetAddress ipAddress,
 String server)

Checks if an IP address is banned in the specified server.

Specify null as server to check global bans.

Parameters:

ipAddress - IP address to check

server - Origin server (ProxyManager.getServerID())

Returns:

Whether the IP address is banned

getInstance

public static BanManager getInstance()

Gets this manager's instance.

Returns:

Manager's instance

ban

public abstract void ban(OfflinePlayer player,
 String staffMember,
 String reason,
 String server,
 long duration,
 boolean global,
 boolean silent)

Bans a player.

Parameters:

player - Player to ban

staffMember - Who banned the player

reason - Ban's reason, nullable

server - Origin server (ProxyManager.getServerID())

duration - Duration, in milliseconds; -1 = permanent

global - Whether this ban is global

silent - Whether this ban is silent

Throws:

IllegalStateException - If !Environment.isProxy() && ProxyManager.isEnabled() && PlayerAdapter.getOnlinePlayers().isEmpty()

UnsupportedOperationException - If OfflinePlayer.isOnline() && !OfflinePlayer.isLoaded()

See Also:

• BanEvent
• BanUpdateEvent

banIP

public abstract void banIP(OfflinePlayer player,
 String staffMember,
 String reason,
 String server,
 long duration,
 boolean global,
 boolean silent)

Bans a player by their IP address.

Parameters:

player - Player to ban

staffMember - Who banned the player

reason - Ban's reason, nullable

server - Origin server (ProxyManager.getServerID())

duration - Duration, in milliseconds; -1 = permanent

global - Whether this ban is global

silent - Whether this ban is silent

Throws:

IllegalArgumentException - If !OfflinePlayer.hasPlayedBefore()

IllegalStateException - If !Environment.isProxy() && ProxyManager.isEnabled() && PlayerAdapter.getOnlinePlayers().isEmpty()

UnsupportedOperationException - If OfflinePlayer.isOnline() && !OfflinePlayer.isLoaded()

See Also:

• BanEvent
• BanUpdateEvent

banIP

public abstract void banIP(InetAddress ipAddress,
 String staffMember,
 String reason,
 String server,
 long duration,
 boolean global,
 boolean silent)

Bans an IP address.

Parameters:

ipAddress - IP address to ban

staffMember - Who banned the IP address

reason - Ban's reason, nullable

server - Origin server (ProxyManager.getServerID())

duration - Duration, in milliseconds; -1 = permanent

global - Whether this ban is global

silent - Whether this ban is silent

Throws:

IllegalStateException - If !Environment.isProxy() && ProxyManager.isEnabled() && PlayerAdapter.getOnlinePlayers().isEmpty()

UnsupportedOperationException - If OfflinePlayer.isOnline() && !OfflinePlayer.isLoaded()

See Also:

• BanEvent
• BanUpdateEvent

unban

public abstract void unban(OfflinePlayer player,
 String server,
 String whoUnbanned)

Unbans a player.

Specify null as server to disactive a global ban.

Parameters:

player - Player to unban

server - Origin server (ProxyManager.getServerID())

whoUnbanned - Who unbanned the player

Throws:

IllegalStateException - If !Environment.isProxy() && ProxyManager.isEnabled() && PlayerAdapter.getOnlinePlayers().isEmpty()

UnsupportedOperationException - If OfflinePlayer.isOnline() && !OfflinePlayer.isLoaded()

See Also:

• UnbanEvent

unbanIP

public abstract void unbanIP(InetAddress ipAddress,
 String server,
 String whoUnbanned)

Unbans an IP address.

Specify null as server to disactive a global ban.

Parameters:

ipAddress - IP address to unban

server - Origin server (ProxyManager.getServerID())

whoUnbanned - Who unbanned the IP address

Throws:

IllegalStateException - If !Environment.isProxy() && ProxyManager.isEnabled() && PlayerAdapter.getOnlinePlayers().isEmpty()

See Also:

• UnbanEvent

unban

public abstract void unban(int id,
 String whoUnbanned)

Unbans a player based on their ban's ID.

Parameters:

id - Ban's ID

whoUnbanned - Who unbanned the player

Throws:

IllegalStateException - If !Environment.isProxy() && ProxyManager.isEnabled() && PlayerAdapter.getOnlinePlayers().isEmpty()

See Also:

• UnbanEvent

getActiveBans

public abstract List<Ban> getActiveBans(OfflinePlayer player)

Gets the active bans' list for the specified player.

Will return an empty list if the player is not banned in any server.

Parameters:

player - Player to check

Returns:

Player's bans

getActiveBans

public abstract List<Ban> getActiveBans(InetAddress ipAddress)

Gets the active bans' list for the specified IP address.

Will return an empty list if the IP address is not banned in any server.

Parameters:

ipAddress - IP address to check

Returns:

IP address' bans

getActiveBan

public abstract Ban getActiveBan(OfflinePlayer player,
 String server)

Gets the active ban for the specified player and server.

Will return null if the player is not banned in that server.

Specify null as server to check global bans.

Parameters:

player - Player to check

server - Origin server (ProxyManager.getServerID())

Returns:

Player's ban

getActiveBan

public abstract Ban getActiveBan(InetAddress ipAddress,
 String server)

Gets the active ban for the specified IP address and server.

Will return null if the IP address is not banned in that server.

Specify null as server to check global bans.

Parameters:

ipAddress - IP address to check

server - Origin server (ProxyManager.getServerID())

Returns:

IP address' ban

getActiveBan

public abstract Ban getActiveBan(int id)

Gets the active ban for the specified ID.

Will return null if the ban is not active.

Parameters:

id - Ban's ID

Returns:

Ban object

getBan

public abstract Ban getBan(int id)

Gets a ban from the database.

Will return null if the ban does not exist.

This method is equivalent to StorageConnector.getBan(int) with the difference that it suppresses SQLExceptions.

Parameters:

id - Ban's ID

Returns:

Ban object

formatTypeMessage

public abstract String formatTypeMessage(BanType type,
 Language language)

Formats a ban's type message using the message set in the specified language's messages file.

Parameters:

type - Type to format

language - Language used to translate the message

Returns:

Formatted type message

formatActiveMessage

public abstract String formatActiveMessage(boolean active,
 Language language)

Formats a ban's active message using the message set in the specified language's messages file.

Parameters:

active - Whether the ban is active

language - Language used to translate the message

Returns:

Formatted type message

formatGlobalMessage

public abstract String formatGlobalMessage(boolean global,
 Language language)

Formats a ban's global message using the message set in the specified language's messages file.

Parameters:

global - Whether the ban is global

language - Language used to translate the message

Returns:

Formatted global message

formatSilentMessage

public abstract String formatSilentMessage(boolean silent,
 Language language)

Formats a ban's silent message using the message set in the specified language's messages file.

Parameters:

silent - Whether the ban is silent

language - Language used to translate the message

Returns:

Formatted silent message

formatKickMessage

public abstract String formatKickMessage(KickType type,
 Language language)

Formats a ban's kick message using the message set in the specified language's messages file.

Parameters:

type - Type to format

language - Language used to translate the message

Returns:

Formatted kick message