me.confuser.banmanager.common.api

Class BmAPI

java.lang.Object

me.confuser.banmanager.common.api.BmAPI

public class BmAPI
extends java.lang.Object

This is a static API for BanManager No methods are thread safe unless stated otherwise Note: The API does not handle permission checks for exemptions

Constructor Summary

Constructors

Constructor and Description
BmAPI()

Method Summary

Modifier and Type	Method and Description
static boolean	ban(IPAddress ip, PlayerData actor, java.lang.String reason, boolean silent) Permanently ban an ip.
static boolean	ban(IPAddress ip, PlayerData actor, java.lang.String reason, boolean silent, long expires) Temporarily ban an ip You must handle kicking the player if they are online.
static boolean	ban(IpBanData ban) Permanently ban an ip.
static boolean	ban(PlayerBanData ban) Permanently ban a player.
static boolean	ban(PlayerData player, PlayerData actor, java.lang.String reason, boolean silent) Permanently ban a player.
static boolean	ban(PlayerData player, PlayerData actor, java.lang.String reason, boolean silent, long expires) Temporarily ban a player You must handle kicking the player if they are online.
static <any>	getBanRecords(IPAddress ip)
static <any>	getBanRecords(PlayerData player)
static PlayerData	getConsole() Get the console for use as an actor
static IpBanData	getCurrentBan(IPAddress ip) Thread safe
static PlayerBanData	getCurrentBan(java.lang.String name) Thread safe
static PlayerBanData	getCurrentBan(java.util.UUID uuid) Thread safe
static PlayerMuteData	getCurrentMute(java.lang.String name) Thread safe
static PlayerMuteData	getCurrentMute(java.util.UUID uuid) Thread safe
static ConnectionSource	getLocalConnection()
static Message	getMessage(java.lang.String key)
static <any>	getMuteRecords(PlayerData player)
static PlayerData	getPlayer(java.lang.String name)
static PlayerData	getPlayer(java.util.UUID uuid)
static <any>	getWarnings(PlayerData player) Retrieve past warnings of a player.
static boolean	isBanned(IPAddress ip) Thread safe
static boolean	isBanned(java.lang.String name) Thread safe
static boolean	isBanned(java.util.UUID uuid) Thread safe
static boolean	isMuted(IPAddress ip) Thread safe
static boolean	isMuted(java.lang.String name) Thread safe
static boolean	isMuted(java.util.UUID uuid) Thread safe
static boolean	mute(IpMuteData mute) Mute an IP.
static boolean	mute(PlayerData player, PlayerData actor, java.lang.String reason) Permanently mute a player.
static boolean	mute(PlayerData player, PlayerData actor, java.lang.String reason, boolean silent) Permanently mute a player.
static boolean	mute(PlayerData player, PlayerData actor, java.lang.String reason, boolean silent, boolean isSoft) Permanently mute a player.
static boolean	mute(PlayerData player, PlayerData actor, java.lang.String reason, boolean silent, boolean isSoft, long expires) Temporarily mute a player You must handle kicking the player if they are online.
static boolean	mute(PlayerMuteData mute) Permanently mute a player.
static IPAddress	toIp(java.lang.String ip) Convert an ip string of x.x.x.x to IPAddress
static boolean	unban(IpBanData ban, PlayerData actor)
static boolean	unban(PlayerBanData ban, PlayerData actor)
static boolean	unmute(IpMuteData mute, PlayerData actor)
static boolean	unmute(PlayerMuteData mute, PlayerData actor)
static boolean	warn(PlayerData player, PlayerData actor, java.lang.String reason, boolean read) Warn a player.
static boolean	warn(PlayerData player, PlayerData actor, java.lang.String reason, boolean read, boolean silent) Warn a player.
static boolean	warn(PlayerWarnData data) Warn a player.
static boolean	warn(PlayerWarnData data, boolean silent) Warn a player.

Methods inherited from class java.lang.Object

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

Constructor Detail

BmAPI

public BmAPI()

Method Detail

getPlayer

public static PlayerData getPlayer(java.util.UUID uuid)
                            throws java.sql.SQLException

Parameters:

uuid - Player UUID

Returns:

PlayerData

Throws:

java.sql.SQLException

getPlayer

public static PlayerData getPlayer(java.lang.String name)
                            throws java.sql.SQLException

Parameters:

name - Player name

Returns:

PlayerData

Throws:

java.sql.SQLException

getConsole

public static PlayerData getConsole()

Get the console for use as an actor

Returns:

PlayerData

toIp

public static IPAddress toIp(java.lang.String ip)

Convert an ip string of x.x.x.x to IPAddress

Parameters:

ip - IPv4 in x.x.x.x format

Returns:

IPv4 in number format

ban

public static boolean ban(PlayerBanData ban)
                   throws java.sql.SQLException

Permanently ban a player. You must handle kicking the player if they are online.

Parameters:

ban - PlayerBanData

Returns:

Returns true if ban successful

Throws:

java.sql.SQLException

ban

public static boolean ban(PlayerData player,
                          PlayerData actor,
                          java.lang.String reason,
                          boolean silent)
                   throws java.sql.SQLException

Permanently ban a player. You must handle kicking the player if they are online.

Parameters:

player - Player to ban

actor - Who the ban is by

reason - Why they are banned

silent - Whether the ban should be broadcast

Returns:

Returns true if ban successful

Throws:

java.sql.SQLException

ban

public static boolean ban(PlayerData player,
                          PlayerData actor,
                          java.lang.String reason,
                          boolean silent,
                          long expires)
                   throws java.sql.SQLException

Temporarily ban a player You must handle kicking the player if they are online.

Parameters:

player - Player to ban

actor - Who the ban is by

reason - Why they are banned

expires - Unix Timestamp in seconds stating the time of when the ban ends

Returns:

Returns true if ban successful

Throws:

java.sql.SQLException

unban

public static boolean unban(PlayerBanData ban,
                            PlayerData actor)
                     throws java.sql.SQLException

Parameters:

ban - The ban (can be retrieved via getBan)

actor - Who is unbanning the player

Returns:

Returns true if the unban is successful

Throws:

java.sql.SQLException

isBanned

public static boolean isBanned(java.util.UUID uuid)

Thread safe

Parameters:

uuid - Player UUID

Returns:

Returns true if player is banned

isBanned

public static boolean isBanned(java.lang.String name)

Thread safe

Parameters:

name - Player name

Returns:

Returns true if player is banned

getCurrentBan

public static PlayerBanData getCurrentBan(java.lang.String name)

Thread safe

Parameters:

name - Player name

Returns:

Returns the active ban of a player; if the player is not banned this returns null

getCurrentBan

public static PlayerBanData getCurrentBan(java.util.UUID uuid)

Thread safe

Parameters:

uuid - Player UUID

Returns:

Returns the active ban of a player; if the player is not banned this returns null

getBanRecords

public static <any> getBanRecords(PlayerData player)
                           throws java.sql.SQLException

Parameters:

player - BanManager's player record

Returns:

An iterator of ban records

Throws:

java.sql.SQLException

mute

public static boolean mute(PlayerMuteData mute)
                    throws java.sql.SQLException

Permanently mute a player. You must handle kicking the player if they are online.

Parameters:

mute - PlayerMuteData

Returns:

Returns true if the mute is successful

Throws:

java.sql.SQLException

mute

public static boolean mute(PlayerData player,
                           PlayerData actor,
                           java.lang.String reason)
                    throws java.sql.SQLException

Permanently mute a player. You must handle kicking the player if they are online.

Parameters:

player - Player to mute

actor - Who the mute is by

reason - Why they are muted

Returns:

Returns true if the mute is successful

Throws:

java.sql.SQLException

mute

public static boolean mute(PlayerData player,
                           PlayerData actor,
                           java.lang.String reason,
                           boolean silent)
                    throws java.sql.SQLException

Permanently mute a player. You must handle kicking the player if they are online.

Parameters:

player - Player to mute

actor - Who the mute is by

reason - Why they are mutened

silent - Whether the mute should be broadcast

Returns:

Returns true if mute is successful

Throws:

java.sql.SQLException

mute

public static boolean mute(PlayerData player,
                           PlayerData actor,
                           java.lang.String reason,
                           boolean silent,
                           boolean isSoft)
                    throws java.sql.SQLException

Permanently mute a player. You must handle kicking the player if they are online.

Parameters:

player - Player to mute

actor - Who the mute is by

reason - Why they are mutened

silent - Whether the mute should be broadcast

isSoft - Whether the player should be aware they are muted; they will still see their own messages but nobody else will

Returns:

Returns true if the mute is successful

Throws:

java.sql.SQLException

mute

public static boolean mute(PlayerData player,
                           PlayerData actor,
                           java.lang.String reason,
                           boolean silent,
                           boolean isSoft,
                           long expires)
                    throws java.sql.SQLException

Temporarily mute a player You must handle kicking the player if they are online.

Parameters:

player - Player to mute

actor - Who the mute is by

reason - Why they are mutened

silent - Whether the mute should be broadcast

isSoft - Whether the player should be aware they are muted; they will still see their own messages but nobody else will

expires - Unix Timestamp in seconds stating the time of when the mute ends

Returns:

Returns true if mute successful

Throws:

java.sql.SQLException

mute

public static boolean mute(IpMuteData mute)
                    throws java.sql.SQLException

Mute an IP.

Parameters:

mute - IpMuteData

Returns:

Returns true if the mute is successful

Throws:

java.sql.SQLException

unmute

public static boolean unmute(PlayerMuteData mute,
                             PlayerData actor)
                      throws java.sql.SQLException

Parameters:

mute - PlayerMuteData

actor - Who unmuted the player

Returns:

Returns true if unmute successful

Throws:

java.sql.SQLException

unmute

public static boolean unmute(IpMuteData mute,
                             PlayerData actor)
                      throws java.sql.SQLException

Parameters:

mute - IP Mute record

actor - Who unmuted the ip

Returns:

Returns true if unmute is successful

Throws:

java.sql.SQLException

isMuted

public static boolean isMuted(java.util.UUID uuid)

Thread safe

Parameters:

uuid - Player UUID

Returns:

Returns true if player muted

isMuted

public static boolean isMuted(java.lang.String name)

Thread safe

Parameters:

name - Player Name

Returns:

Returns true if player muted

isMuted

public static boolean isMuted(IPAddress ip)

Thread safe

Parameters:

ip - IP address

Returns:

Returns true if IP address muted

getCurrentMute

public static PlayerMuteData getCurrentMute(java.lang.String name)

Thread safe

Parameters:

name -

Returns:

Returns the active mute of a player; if the player is not muted this returns null

getCurrentMute

public static PlayerMuteData getCurrentMute(java.util.UUID uuid)

Thread safe

Parameters:

uuid -

Returns:

Returns the active mute of a player; if the player is not muted this returns null

getMuteRecords

public static <any> getMuteRecords(PlayerData player)
                            throws java.sql.SQLException

Parameters:

player - Player record

Returns:

Iterator of previous mutes

Throws:

java.sql.SQLException

ban

public static boolean ban(IpBanData ban)
                   throws java.sql.SQLException

Permanently ban an ip. You must handle kicking the player if they are online.

Parameters:

ban - IpBanData

Returns:

Returns true if ban is successful

Throws:

java.sql.SQLException

ban

public static boolean ban(IPAddress ip,
                          PlayerData actor,
                          java.lang.String reason,
                          boolean silent)
                   throws java.sql.SQLException

Permanently ban an ip. You must handle kicking the player if they are online.

Parameters:

ip - IP to ban, use toIp to convert x.x.x.x to IPAddress

actor - Who the ban is by

reason - Why they are banned

silent - Whether the ban should be broadcast

Returns:

Returns true if ban is successful

Throws:

java.sql.SQLException

ban

public static boolean ban(IPAddress ip,
                          PlayerData actor,
                          java.lang.String reason,
                          boolean silent,
                          long expires)
                   throws java.sql.SQLException

Temporarily ban an ip You must handle kicking the player if they are online.

Parameters:

ip - IP to ban, use toIp to convert x.x.x.x to IPAddress

actor - Who the ban is by

reason - Why they are banned

silent - Whether the ban should be broadcast

expires - Unix Timestamp in seconds stating the time of when the ban ends

Returns:

Returns true if ban is successful

Throws:

java.sql.SQLException

unban

public static boolean unban(IpBanData ban,
                            PlayerData actor)
                     throws java.sql.SQLException

Parameters:

ban - IP Ban record

actor - Who unbanned the ip

Returns:

Returns true if unban is successful

Throws:

java.sql.SQLException

isBanned

public static boolean isBanned(IPAddress ip)

Thread safe

Parameters:

ip - IP to ban, use toIp to convert x.x.x.x to IPAddress

Returns:

Returns true if ip is banned

getCurrentBan

public static IpBanData getCurrentBan(IPAddress ip)

Thread safe

Parameters:

ip - IP to ban, use toIp to convert x.x.x.x to IPAddress

Returns:

Returns the active ban of an ip if the ip is not banned this returns null

getBanRecords

public static <any> getBanRecords(IPAddress ip)
                           throws java.sql.SQLException

Parameters:

ip - IP to ban, use toIp to convert x.x.x.x to IPAddress

Returns:

Returns previous bans of an ip

Throws:

java.sql.SQLException

warn

public static boolean warn(PlayerData player,
                           PlayerData actor,
                           java.lang.String reason,
                           boolean read)
                    throws java.sql.SQLException

Warn a player. You must handle the notification to the warned player yourself.

Parameters:

player - Player record

actor - Player record of who warned the player

reason - What the player was warned for

read - Whether the player has already viewed the warning

Returns:

Returns true if warning is successful

Throws:

java.sql.SQLException

warn

public static boolean warn(PlayerData player,
                           PlayerData actor,
                           java.lang.String reason,
                           boolean read,
                           boolean silent)
                    throws java.sql.SQLException

Warn a player. You must handle the notification to the warned player yourself.

Parameters:

player - Player record

actor - Player record of who warned the player

reason - What the player was warned for

read - Whether the player has already viewed the warning

silent - Whether the warning should be broadcast

Returns:

Returns true if warning is successful

Throws:

java.sql.SQLException

warn

public static boolean warn(PlayerWarnData data)
                    throws java.sql.SQLException

Warn a player. You must handle the notification to the warned player yourself.

Parameters:

data - PlayerWarnData

Returns:

Returns true if warning is successful

Throws:

java.sql.SQLException

warn

public static boolean warn(PlayerWarnData data,
                           boolean silent)
                    throws java.sql.SQLException

Warn a player. You must handle the notification to the warned player yourself.

Parameters:

data - PlayerWarnData

silent - Whether the warning should be broadcast

Returns:

Returns true if warning is successful

Throws:

java.sql.SQLException

getWarnings

public static <any> getWarnings(PlayerData player)
                         throws java.sql.SQLException

Retrieve past warnings of a player. This method is not thread safe and should not be called on the main thread.

Parameters:

player - Player record

Returns:

Iterator containing previous player warningss

Throws:

java.sql.SQLException

getMessage

public static Message getMessage(java.lang.String key)

Parameters:

key - The message config node within messages.yml, e.g. "ban.notify"

Returns:

String

getLocalConnection

public static ConnectionSource getLocalConnection()