org.spongepowered.api.service.ban

Interface BanService

public interface BanService

Represents a service with which to ban things, such as GameProfiles or IP addresses.

Implementors of this service should treat expired bans as non-existent, even if they choose to retain them in a way not accessible through the ban service API (e.g. writing them to a database). In essence, expired bans should be treated the same as user-removed bans.

For example, getBans() would not include any expired bans, and hasBan(Ban) would return false.

Method Summary

Modifier and Type	Method and Description
Optional<? extends Ban>	addBan(Ban ban) Adds a ban.
Optional<Ban.Profile>	getBanFor(GameProfile profile) Gets the ban for the given GameProfile, if available.
Optional<Ban.Ip>	getBanFor(InetAddress address) Gets the ban for the given address, if available.
Collection<? extends Ban>	getBans() Gets all bans registered.
Collection<Ban.Ip>	getIpBans() Gets all IP bans registered.
Collection<Ban.Profile>	getProfileBans() Gets all GameProfile bans registered.
boolean	hasBan(Ban ban) Checks if the specified ban is present.
boolean	isBanned(GameProfile profile) Checks if a GameProfile has a ban.
boolean	isBanned(InetAddress address) Checks if an IP has a ban.
boolean	pardon(GameProfile profile) Pardons a profile, or removes its ban, if present.
boolean	pardon(InetAddress address) Pardons an IP address, or removes its ban, if present.
boolean	removeBan(Ban ban) Removes a ban.

Method Detail

getBans

Collection<? extends Ban> getBans()

Gets all bans registered.

Returns:

All registered bans

getProfileBans

Collection<Ban.Profile> getProfileBans()

Gets all GameProfile bans registered.

Returns:

All registered GameProfile bans

getIpBans

Collection<Ban.Ip> getIpBans()

Gets all IP bans registered.

Returns:

All registered IP bans

getBanFor

Optional<Ban.Profile> getBanFor(GameProfile profile)

Gets the ban for the given GameProfile, if available.

Parameters:

profile - The profile

Returns:

The ban, if available

getBanFor

Optional<Ban.Ip> getBanFor(InetAddress address)

Gets the ban for the given address, if available.

Parameters:

address - The address.

Returns:

All registered IP bans

isBanned

boolean isBanned(GameProfile profile)

Checks if a GameProfile has a ban.

Parameters:

profile - The profile

Returns:

True if the profile has a ban, false otherwise

isBanned

boolean isBanned(InetAddress address)

Checks if an IP has a ban.

Parameters:

address - The address

Returns:

True if the address has a ban, false otherwise

pardon

boolean pardon(GameProfile profile)

Pardons a profile, or removes its ban, if present.

Parameters:

profile - The profile

Returns:

Whether the profile had a ban present

pardon

boolean pardon(InetAddress address)

Pardons an IP address, or removes its ban, if present.

Parameters:

address - The IP address

Returns:

Whether the address had a ban present

removeBan

boolean removeBan(Ban ban)

Removes a ban.

Parameters:

ban - The ban

Returns:

Whether the ban was present in this ban service

addBan

Optional<? extends Ban> addBan(Ban ban)

Adds a ban.

If the GameProfile or IP address of the ban already has a ban set, the passed in ban will replace the existing ban.

Parameters:

ban - The ban to add to this ban service

Returns:

The previous ban, if available

hasBan

boolean hasBan(Ban ban)

Checks if the specified ban is present.

Parameters:

ban - The ban

Returns:

True if the ban exists in this ban service, false otherwise