Package com.gamersafer.minecraft.auth.common.db.cache

Class BanCache

java.lang.Object

com.gamersafer.minecraft.auth.common.db.cache.BanCache

All Implemented Interfaces:

IBanStorage

public class BanCache
extends Object
implements IBanStorage

Constructor Summary

Constructors

Constructor	Description
BanCache(IBanStorage base)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	add(Ban ban)
CompletableFuture<List<Ban>>	getBans(UserIdentity identity, @Nullable String guildMemberId)
CompletableFuture<List<Ban>>	getBans(String guildMemberId)
CompletableFuture<List<Ban>>	getUnsubmittedBans()
void	shutdown()
CompletableFuture<Void>	unbanIpUser(@Nullable String guildMemberId, UserIdentity identity)	Removes IP bans associated with the given identity.
CompletableFuture<Void>	unbanUser(@Nullable String guildMemberId, UserIdentity identity)	Removes regular bans associated with the given identity.
CompletableFuture<Void>	update(Ban ban)

Methods inherited from class java.lang.Object

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

Constructor Details

BanCache

public BanCache(IBanStorage base)

Method Details

add

public CompletableFuture<Void> add(Ban ban)

Specified by:

add in interface IBanStorage

update

public CompletableFuture<Void> update(Ban ban)

Specified by:

update in interface IBanStorage

unbanUser

public CompletableFuture<Void> unbanUser(@Nullable String guildMemberId,
 UserIdentity identity)

Description copied from interface: IBanStorage

Removes regular bans associated with the given identity. NOTE: IP bans are ignored. See IBanStorage.unbanIpUser(String, UserIdentity)

Specified by:

unbanUser in interface IBanStorage

Parameters:

guildMemberId - their guild member id; may be null

identity - the user identity

Returns:

a CompletableFuture that will be completed once all bans have been removed

unbanIpUser

public CompletableFuture<Void> unbanIpUser(@Nullable String guildMemberId,
 UserIdentity identity)

Description copied from interface: IBanStorage

Removes IP bans associated with the given identity. NOTE: non-IP bans are ignore. See IBanStorage.unbanUser(String, UserIdentity)

Specified by:

unbanIpUser in interface IBanStorage

identity - the user identity

Returns:

a CompletableFuture that will be completed once all bans have been removed

getBans

public CompletableFuture<List<Ban>> getBans(UserIdentity identity,
 @Nullable String guildMemberId)

Specified by:

getBans in interface IBanStorage

getBans

public CompletableFuture<List<Ban>> getBans(String guildMemberId)

Specified by:

getBans in interface IBanStorage

getUnsubmittedBans

public CompletableFuture<List<Ban>> getUnsubmittedBans()

Specified by:

getUnsubmittedBans in interface IBanStorage

shutdown

public void shutdown()

Specified by:

shutdown in interface IBanStorage