me.leoko.advancedban.manager

Class PunishmentManager

java.lang.Object

me.leoko.advancedban.manager.PunishmentManager

public class PunishmentManager
extends Object

The Punishment Manager handles the punishments. It loads and parses them from the database, caches them and eventually discards them again.

Constructor Summary

Constructors

Constructor and Description
PunishmentManager()

Method Summary

Modifier and Type	Method and Description
void	discard(String name) Discard a players punishments from the cache.
static PunishmentManager	get() Get the punishment manager.
Punishment	getBan(String uuid) Get a players active ban.
int	getCalculationLevel(String uuid, String layout) Get punishment-time calculation level.
int	getCurrentWarns(String uuid) Get how many warnings a player has.
Set<Punishment>	getLoadedHistory() Get all cached history punishments.
Set<Punishment>	getLoadedPunishments(boolean checkExpired) Get all cached punishments.
Punishment	getMute(String uuid) Get a players active mute.
Punishment	getPunishment(int id) Get an active punishment by id.
Punishment	getPunishmentFromResultSet(ResultSet rs) Get a Punishment from a ResultSet
List<Punishment>	getPunishments(SQLQuery sqlQuery, Object... parameters) Get parsed punishments from the database queried by the given SQLQuery. The parameters work as described in MessageManager.sendMessage(Object, String, boolean, String...).
List<Punishment>	getPunishments(String target, PunishmentType put, boolean current) Get all punishments which belong to the given uuid or ip.
Punishment	getWarn(int id) Get an active warning by id.
List<Punishment>	getWarns(String uuid) Get a players active warnings.
boolean	isBanned(String uuid) Check whether a player is banned.
boolean	isCached(String target) Check whether the data for the given uuid, ip or username are currently cached.
boolean	isMuted(String uuid) Check whether a player is muted.
InterimData	load(String name, String uuid, String ip) Get a users punishments as InterimData.
void	setCached(InterimData data) Mark the InterimData as cached.
void	setup() Initially clears out all expired punishments.

Methods inherited from class java.lang.Object

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

Constructor Detail

PunishmentManager

public PunishmentManager()

Method Detail

get

public static PunishmentManager get()

Get the punishment manager.

Returns:

the punishment manager instance

setup

public void setup()

Initially clears out all expired punishments.

load

public InterimData load(String name,
                        String uuid,
                        String ip)

Get a users punishments as InterimData. This method is meant to be called if the goal eventually is to add the users punishments to the cache. If you are just interested in the specific punishments there are more convenient methods as getBan(String), getMute(String), getWarns(String) or getPunishments(String, PunishmentType, boolean).

Parameters:

name - the users name

uuid - the users uuid

ip - the users ip

Returns:

the interim data

discard

public void discard(String name)

Discard a players punishments from the cache.

Parameters:

name - the name

getPunishments

public List<Punishment> getPunishments(String target,
                                       PunishmentType put,
                                       boolean current)

Get all punishments which belong to the given uuid or ip.

Parameters:

target - the uuid or ip to search for

put - the basic punishment type to search for (PunishmentType.BAN would also include Tempbans). Use null to search for all punishments.

current - if only active punishments should be included.

Returns:

the punishments

getPunishments

public List<Punishment> getPunishments(SQLQuery sqlQuery,
                                       Object... parameters)

Get parsed punishments from the database queried by the given SQLQuery.
The parameters work as described in MessageManager.sendMessage(Object, String, boolean, String...).

Parameters:

sqlQuery - the sql query

parameters - the parameters

Returns:

the punishments

getPunishment

public Punishment getPunishment(int id)

Get an active punishment by id.

Parameters:

id - the id

Returns:

the punishment

getWarn

public Punishment getWarn(int id)

Get an active warning by id.

Parameters:

id - the id

Returns:

the warning

getWarns

public List<Punishment> getWarns(String uuid)

Get a players active warnings.

Parameters:

uuid - the players uuid

Returns:

the warns

getBan

public Punishment getBan(String uuid)

Get a players active ban.

Parameters:

uuid - the players uuid (can also be an IP)

Returns:

the ban or null if not banned

getMute

public Punishment getMute(String uuid)

Get a players active mute.

Parameters:

uuid - the players uuid

Returns:

the mute or null if not muted

isBanned

public boolean isBanned(String uuid)

Check whether a player is banned.

Parameters:

uuid - the players uuid (can also be an IP)

Returns:

whether the player is banned

isMuted

public boolean isMuted(String uuid)

Check whether a player is muted.

Parameters:

uuid - the players uuid

Returns:

whether the player is muted

isCached

public boolean isCached(String target)

Check whether the data for the given uuid, ip or username are currently cached.

Parameters:

target - the target (uuid, ip or username)

Returns:

whether the targets data is cached

setCached

public void setCached(InterimData data)

Mark the InterimData as cached. This method des not acually cache the data, see InterimData.accept() to do that.

Parameters:

data - the data

getCalculationLevel

public int getCalculationLevel(String uuid,
                               String layout)

Get punishment-time calculation level. This level is represented by the amount a user has been punished using the given time-layout.

Parameters:

uuid - the players uuid

layout - the time-layout name

Returns:

the calculation level

getCurrentWarns

public int getCurrentWarns(String uuid)

Get how many warnings a player has.

Parameters:

uuid - the players uuid

Returns:

the current warning count

getLoadedPunishments

public Set<Punishment> getLoadedPunishments(boolean checkExpired)

Get all cached punishments.

Parameters:

checkExpired - whether to look for and remove expired punishments

Returns:

the cached punishments

getPunishmentFromResultSet

public Punishment getPunishmentFromResultSet(ResultSet rs)
                                      throws SQLException

Get a Punishment from a ResultSet

Parameters:

rs - the result set

Returns:

the punishment from the result set

Throws:

SQLException - the sql exception

getLoadedHistory

public Set<Punishment> getLoadedHistory()

Get all cached history punishments.

Returns:

the loaded history