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

Interface IBanStorage

All Known Implementing Classes:

BanCache, BansDB

public interface IBanStorage

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)

Method Details

add

CompletableFuture<Void> add(Ban ban)

update

CompletableFuture<Void> update(Ban ban)

unbanUser

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

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

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

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

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

Parameters:

identity - the user identity

Returns:

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

getBans

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

getBans

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

getUnsubmittedBans

CompletableFuture<List<Ban>> getUnsubmittedBans()

shutdown

void shutdown()