org.anvilpowered.anvil.api.core.coremember.repository

Interface CoreMemberRepository<TKey,TDataStore>

All Superinterfaces:

Component<TKey,TDataStore>, Repository<TKey,CoreMember<TKey>,TDataStore>, StorageService<TKey,CoreMember<TKey>,TDataStore>

All Known Subinterfaces:

MongoCoreMemberRepository, XodusCoreMemberRepository

public interface CoreMemberRepository<TKey,TDataStore>
extends Repository<TKey,CoreMember<TKey>,TDataStore>

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<java.lang.Boolean>	ban(TKey id, java.time.Instant endUtc, java.lang.String reason) Updates the properties banEndUtc, banReason and sets banned to true for the document whose id matches the provided TKey
java.util.concurrent.CompletableFuture<java.lang.Boolean>	banIpAddress(java.lang.String ipAddress, java.time.Instant endUtc, java.lang.String reason) Updates the properties banEndUtc, banReason and sets banned to true for documents whose property ipAddress matches the provided String
java.util.concurrent.CompletableFuture<java.lang.Boolean>	banUser(java.lang.String userName, java.time.Instant endUtc, java.lang.String reason) Updates the properties banEndUtc, banReason and sets banned to true for documents whose property userName matches the provided String
java.util.concurrent.CompletableFuture<java.lang.Boolean>	banUser(java.util.UUID userUUID, java.time.Instant endUtc, java.lang.String reason) Updates the properties banEndUtc, banReason and sets banned to true for documents whose property userUUID matches the provided UUID
boolean	checkBanned(CoreMember<?> coreMember) Verifies whether the provided CoreMember is in fact banned.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	checkBanned(TKey id) Verifies whether the CoreMember matching the provided TKey is in fact banned.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	checkBannedForUser(java.lang.String userName) Verifies whether the CoreMember matching the provided String userName is in fact banned.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	checkBannedForUser(java.util.UUID userUUID) Verifies whether the CoreMember matching the provided UUID userUUID is in fact banned.
boolean	checkMuted(CoreMember<?> coreMember) Verifies whether the provided CoreMember is in fact muted.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	checkMuted(TKey id) Verifies whether the CoreMember matching the provided TKey is in fact muted.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	checkMutedForUser(java.lang.String userUUID) Verifies whether the CoreMember matching the provided String userName is in fact muted.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	checkMutedForUser(java.util.UUID userUUID) Verifies whether the CoreMember matching the provided UUID userUUID is in fact muted.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	deleteNickName(TKey id) Deletes the property nickName for the document whose id matches the provided TKey
java.util.concurrent.CompletableFuture<java.lang.Boolean>	deleteNickNameForUser(java.lang.String userName) Deletes the property nickName for documents whose property userName matches the provided String
java.util.concurrent.CompletableFuture<java.lang.Boolean>	deleteNickNameForUser(java.util.UUID userUUID) Deletes the property nickName for documents whose property userUUID matches the provided UUID
java.util.concurrent.CompletableFuture<java.util.List<CoreMember<TKey>>>	getForIpAddress(java.lang.String ipAddress)
java.util.concurrent.CompletableFuture<java.util.Optional<CoreMember<TKey>>>	getOneForUser(java.lang.String userName)
java.util.concurrent.CompletableFuture<java.util.Optional<CoreMember<TKey>>>	getOneForUser(java.util.UUID userUUID)
java.util.concurrent.CompletableFuture<java.util.Optional<CoreMember<TKey>>>	getOneOrGenerateForUser(java.util.UUID userUUID, java.lang.String userName, java.lang.String ipAddress) Ensures that a matching CoreMember exists in the database.
java.util.concurrent.CompletableFuture<java.util.Optional<CoreMember<TKey>>>	getOneOrGenerateForUser(java.util.UUID userUUID, java.lang.String userName, java.lang.String ipAddress, boolean[] flags) Ensures that a matching CoreMember exists in the database.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	mute(TKey id, java.time.Instant endUtc, java.lang.String reason) Updates the properties muteEndUtc, muteReason and sets muted to true for the document whose id matches the provided TKey
java.util.concurrent.CompletableFuture<java.lang.Boolean>	muteIpAddress(java.lang.String ipAddress, java.time.Instant endUtc, java.lang.String reason) Updates the properties muteEndUtc, muteReason and sets muted to true for documents whose property ipAddress matches the provided String
java.util.concurrent.CompletableFuture<java.lang.Boolean>	muteUser(java.lang.String userName, java.time.Instant endUtc, java.lang.String reason) Updates the properties muteEndUtc, muteReason and sets muted to true for documents whose property userName matches the provided String
java.util.concurrent.CompletableFuture<java.lang.Boolean>	muteUser(java.util.UUID userUUID, java.time.Instant endUtc, java.lang.String reason) Updates the properties muteEndUtc, muteReason and sets muted to true for documents whose property userUUID matches the provided UUID
java.util.concurrent.CompletableFuture<java.lang.Boolean>	setNickName(TKey id, java.lang.String nickName) Updates the property nickName for the document whose id matches the provided TKey
java.util.concurrent.CompletableFuture<java.lang.Boolean>	setNickNameForUser(java.lang.String userName, java.lang.String nickName) Updates the property nickName for documents whose property userName matches the provided String
java.util.concurrent.CompletableFuture<java.lang.Boolean>	setNickNameForUser(java.util.UUID userUUID, java.lang.String nickName) Updates the property nickName for documents whose property userUUID matches the provided UUID
java.util.concurrent.CompletableFuture<java.lang.Boolean>	unBan(TKey id) Sets the property banned to false for the document whose id matches the provided TKey
java.util.concurrent.CompletableFuture<java.lang.Boolean>	unBanIpAddress(java.lang.String ipAddress) Sets the property banned to false for documents whose property ipAddress matches the provided String
java.util.concurrent.CompletableFuture<java.lang.Boolean>	unBanUser(java.lang.String userName) Sets the property banned to false for documents whose property userName matches the provided String
java.util.concurrent.CompletableFuture<java.lang.Boolean>	unBanUser(java.util.UUID userUUID) Sets the property banned to false for documents whose property userUUID matches the provided UUID
java.util.concurrent.CompletableFuture<java.lang.Boolean>	unMute(TKey id) Sets the property muted to false for the document whose id matches the provided TKey
java.util.concurrent.CompletableFuture<java.lang.Boolean>	unMuteIpAddress(java.lang.String ipAddress) Sets the property muted to false for documents whose property ipAddress matches the provided String
java.util.concurrent.CompletableFuture<java.lang.Boolean>	unMuteUser(java.lang.String userName) Sets the property muted to false for documents whose property userName matches the provided String
java.util.concurrent.CompletableFuture<java.lang.Boolean>	unMuteUser(java.util.UUID userUUID) Sets the property muted to false for documents whose property userUUID matches the provided UUID

Methods inherited from interface org.anvilpowered.anvil.api.datastore.Repository

getCreatedUtc

Methods inherited from interface org.anvilpowered.anvil.api.datastore.StorageService

deleteOne, deleteOne, generateEmpty, getAll, getAllIds, getOne, getOne, getTClass, insert, insertOne, parseAndDeleteOne, parseAndGetOne

Methods inherited from interface org.anvilpowered.anvil.api.datastore.Component

getDataStoreContext, getTKeyClass, parse, parseUnsafe

Method Detail

getOneOrGenerateForUser

java.util.concurrent.CompletableFuture<java.util.Optional<CoreMember<TKey>>> getOneOrGenerateForUser(java.util.UUID userUUID,
                                                                                                     java.lang.String userName,
                                                                                                     java.lang.String ipAddress,
                                                                                                     boolean[] flags)

Ensures that a matching CoreMember exists in the database.

If the userName has changed since the last time this method was called, it will be updated in the database

The boolean values in flags will be set according to the following rules:

0 : Whether a new member was created in the database

1 : Whether userName was updated in the database

2 : Whether ipAddress was updated in the database

flags must be an array of length 8. There are currently 5 elements reserved for future use

Parameters:

userUUID - UUID userUUID of user.

userName - String Name of user.

ipAddress - String IP Address of user.

flags - A boolean array of length 8.

Returns:

An Optional containing the inserted CoreMember if successful, otherwise Optional.empty()

Throws:

java.lang.IllegalArgumentException - If flags is not of length 8

getOneOrGenerateForUser

java.util.concurrent.CompletableFuture<java.util.Optional<CoreMember<TKey>>> getOneOrGenerateForUser(java.util.UUID userUUID,
                                                                                                     java.lang.String userName,
                                                                                                     java.lang.String ipAddress)

Ensures that a matching CoreMember exists in the database.

If the userName has changed since the last time this method was called, it will be updated in the database

Parameters:

userUUID - UUID userUUID of user

userName - String Name of user

ipAddress - String IP Address of user

Returns:

An Optional containing the inserted CoreMember if successful, otherwise Optional.empty()

getOneForUser

java.util.concurrent.CompletableFuture<java.util.Optional<CoreMember<TKey>>> getOneForUser(java.util.UUID userUUID)

Parameters:

userUUID - UUID userUUID of user

Returns:

An Optional containing a matching CoreMember if successful, otherwise Optional.empty()

getOneForUser

java.util.concurrent.CompletableFuture<java.util.Optional<CoreMember<TKey>>> getOneForUser(java.lang.String userName)

Parameters:

userName - String Name of user

Returns:

An Optional containing a matching CoreMember if successful, otherwise Optional.empty()

getForIpAddress

java.util.concurrent.CompletableFuture<java.util.List<CoreMember<TKey>>> getForIpAddress(java.lang.String ipAddress)

Parameters:

ipAddress - String IP Address of user

Returns:

A List of matching CoreMember if successful, otherwise Optional.empty()

ban

java.util.concurrent.CompletableFuture<java.lang.Boolean> ban(TKey id,
                                                              java.time.Instant endUtc,
                                                              java.lang.String reason)

Updates the properties banEndUtc, banReason and sets banned to true for the document whose id matches the provided TKey

Parameters:

id - TKey id of document to update

endUtc - Instant end of the ban

reason - String reason for the ban

Returns:

CompletableFuture wrapped Boolean. true if successful, otherwise false

banUser

java.util.concurrent.CompletableFuture<java.lang.Boolean> banUser(java.util.UUID userUUID,
                                                                  java.time.Instant endUtc,
                                                                  java.lang.String reason)

Updates the properties banEndUtc, banReason and sets banned to true for documents whose property userUUID matches the provided UUID

Parameters:

userUUID - UUID userUUID of documents to update

endUtc - Instant end of the ban

reason - String reason for the ban

Returns:

CompletableFuture wrapped Boolean. true if successful, otherwise false

banUser

java.util.concurrent.CompletableFuture<java.lang.Boolean> banUser(java.lang.String userName,
                                                                  java.time.Instant endUtc,
                                                                  java.lang.String reason)

Updates the properties banEndUtc, banReason and sets banned to true for documents whose property userName matches the provided String

Parameters:

userName - String userName of documents to update

endUtc - Instant end of the ban

reason - String reason for the ban

Returns:

CompletableFuture wrapped Boolean. true if successful, otherwise false

banIpAddress

java.util.concurrent.CompletableFuture<java.lang.Boolean> banIpAddress(java.lang.String ipAddress,
                                                                       java.time.Instant endUtc,
                                                                       java.lang.String reason)

Updates the properties banEndUtc, banReason and sets banned to true for documents whose property ipAddress matches the provided String

Parameters:

ipAddress - String ipAddress of documents to update

endUtc - Instant end of the ban

reason - String reason for the ban

Returns:

CompletableFuture wrapped Boolean. true if successful, otherwise false

unBan

java.util.concurrent.CompletableFuture<java.lang.Boolean> unBan(TKey id)

Sets the property banned to false for the document whose id matches the provided TKey

Parameters:

id - TKey id of document to update

Returns:

CompletableFuture wrapped Boolean. true if successful, otherwise false

unBanUser

java.util.concurrent.CompletableFuture<java.lang.Boolean> unBanUser(java.util.UUID userUUID)

Sets the property banned to false for documents whose property userUUID matches the provided UUID

Parameters:

userUUID - UUID userUUID of documents to update

Returns:

CompletableFuture wrapped Boolean. true if successful, otherwise false

unBanUser

java.util.concurrent.CompletableFuture<java.lang.Boolean> unBanUser(java.lang.String userName)

Sets the property banned to false for documents whose property userName matches the provided String

Parameters:

userName - String userName of documents to update

Returns:

CompletableFuture wrapped Boolean. true if successful, otherwise false

unBanIpAddress

java.util.concurrent.CompletableFuture<java.lang.Boolean> unBanIpAddress(java.lang.String ipAddress)

Sets the property banned to false for documents whose property ipAddress matches the provided String

Parameters:

ipAddress - String ipAddress of documents to update

Returns:

CompletableFuture wrapped Boolean. true if successful, otherwise false

checkBanned

boolean checkBanned(CoreMember<?> coreMember)

Verifies whether the provided CoreMember is in fact banned.

A user is only banned if CoreMember.isBanned() is true and CoreMember.getBanEndUtc() is in the future.

This method checks both CoreMember.isBanned() and CoreMember.getBanEndUtc() and sets the member's ban status accordingly.

Parameters:

coreMember - CoreMember to verify ban for

Returns:

true if user is verified to be banned, otherwise false

checkBanned

java.util.concurrent.CompletableFuture<java.lang.Boolean> checkBanned(TKey id)

Verifies whether the CoreMember matching the provided TKey is in fact banned.

A user is only banned if CoreMember.isBanned() is true and CoreMember.getBanEndUtc() is in the future.

This method checks both CoreMember.isBanned() and CoreMember.getBanEndUtc() and sets the member's ban status accordingly.

Parameters:

id - TKey id of member to verify ban for

Returns:

CompletableFuture wrapped Boolean. true if user is verified to be banned, otherwise false

checkBannedForUser

java.util.concurrent.CompletableFuture<java.lang.Boolean> checkBannedForUser(java.util.UUID userUUID)

Verifies whether the CoreMember matching the provided UUID userUUID is in fact banned.

A user is only banned if CoreMember.isBanned() is true and CoreMember.getBanEndUtc() is in the future.

This method checks both CoreMember.isBanned() and CoreMember.getBanEndUtc() and sets the member's ban status accordingly.

Parameters:

userUUID - UUID userUUID of member to verify ban for

Returns:

CompletableFuture wrapped Boolean. true if user is verified to be banned, otherwise false

checkBannedForUser

java.util.concurrent.CompletableFuture<java.lang.Boolean> checkBannedForUser(java.lang.String userName)

Verifies whether the CoreMember matching the provided String userName is in fact banned.

A user is only banned if CoreMember.isBanned() is true and CoreMember.getBanEndUtc() is in the future.

This method checks both CoreMember.isBanned() and CoreMember.getBanEndUtc() and sets the member's ban status accordingly.

Parameters:

userName - String userUUID of member to verify ban for

Returns:

CompletableFuture wrapped Boolean. true if user is verified to be banned, otherwise false

mute

java.util.concurrent.CompletableFuture<java.lang.Boolean> mute(TKey id,
                                                               java.time.Instant endUtc,
                                                               java.lang.String reason)

Updates the properties muteEndUtc, muteReason and sets muted to true for the document whose id matches the provided TKey

Parameters:

id - TKey id of document to update

endUtc - Instant end of the mute

reason - String reason for the mute

Returns:

CompletableFuture wrapped Boolean. true if successful, otherwise false

muteUser

java.util.concurrent.CompletableFuture<java.lang.Boolean> muteUser(java.util.UUID userUUID,
                                                                   java.time.Instant endUtc,
                                                                   java.lang.String reason)

Updates the properties muteEndUtc, muteReason and sets muted to true for documents whose property userUUID matches the provided UUID

Parameters:

userUUID - UUID userUUID of documents to update

endUtc - Instant end of the mute

reason - String reason for the mute

Returns:

CompletableFuture wrapped Boolean. true if successful, otherwise false

muteUser

java.util.concurrent.CompletableFuture<java.lang.Boolean> muteUser(java.lang.String userName,
                                                                   java.time.Instant endUtc,
                                                                   java.lang.String reason)

Updates the properties muteEndUtc, muteReason and sets muted to true for documents whose property userName matches the provided String

Parameters:

userName - String userName of documents to update

endUtc - Instant end of the mute

reason - String reason for the mute

Returns:

CompletableFuture wrapped Boolean. true if successful, otherwise false

muteIpAddress

java.util.concurrent.CompletableFuture<java.lang.Boolean> muteIpAddress(java.lang.String ipAddress,
                                                                        java.time.Instant endUtc,
                                                                        java.lang.String reason)

Updates the properties muteEndUtc, muteReason and sets muted to true for documents whose property ipAddress matches the provided String

Parameters:

ipAddress - String ipAddress of documents to update

endUtc - Instant end of the mute

reason - String reason for the mute

Returns:

CompletableFuture wrapped Boolean. true if successful, otherwise false

unMute

java.util.concurrent.CompletableFuture<java.lang.Boolean> unMute(TKey id)

Sets the property muted to false for the document whose id matches the provided TKey

Parameters:

id - TKey id of document to update

Returns:

CompletableFuture wrapped Boolean. true if successful, otherwise false

unMuteUser

java.util.concurrent.CompletableFuture<java.lang.Boolean> unMuteUser(java.util.UUID userUUID)

Sets the property muted to false for documents whose property userUUID matches the provided UUID

Parameters:

userUUID - UUID userUUID of documents to update

Returns:

CompletableFuture wrapped Boolean. true if successful, otherwise false

unMuteUser

java.util.concurrent.CompletableFuture<java.lang.Boolean> unMuteUser(java.lang.String userName)

Sets the property muted to false for documents whose property userName matches the provided String

Parameters:

userName - String userName of documents to update

Returns:

CompletableFuture wrapped Boolean. true if successful, otherwise false

unMuteIpAddress

java.util.concurrent.CompletableFuture<java.lang.Boolean> unMuteIpAddress(java.lang.String ipAddress)

Sets the property muted to false for documents whose property ipAddress matches the provided String

Parameters:

ipAddress - String ipAddress of documents to update

Returns:

CompletableFuture wrapped Boolean. true if successful, otherwise false

checkMuted

boolean checkMuted(CoreMember<?> coreMember)

Verifies whether the provided CoreMember is in fact muted.

A user is only muted if CoreMember.isMuted() is true and CoreMember.getMuteEndUtc() is in the future.

This method checks both CoreMember.isMuted() and CoreMember.getMuteEndUtc() and sets the member's mute status accordingly.

Parameters:

coreMember - CoreMember to verify mute for

Returns:

true if user is verified to be muted, otherwise false

checkMuted

java.util.concurrent.CompletableFuture<java.lang.Boolean> checkMuted(TKey id)

Verifies whether the CoreMember matching the provided TKey is in fact muted.

A user is only muted if CoreMember.isMuted() is true and CoreMember.getMuteEndUtc() is in the future.

This method checks both CoreMember.isMuted() and CoreMember.getMuteEndUtc() and sets the member's mute status accordingly.

Parameters:

id - TKey id of member to verify mute for

Returns:

CompletableFuture wrapped Boolean. true if user is verified to be muted, otherwise false

checkMutedForUser

java.util.concurrent.CompletableFuture<java.lang.Boolean> checkMutedForUser(java.util.UUID userUUID)

Verifies whether the CoreMember matching the provided UUID userUUID is in fact muted.

A user is only muted if CoreMember.isMuted() is true and CoreMember.getMuteEndUtc() is in the future.

This method checks both CoreMember.isMuted() and CoreMember.getMuteEndUtc() and sets the member's mute status accordingly.

Parameters:

userUUID - UUID userUUID of member to verify mute for

Returns:

CompletableFuture wrapped Boolean. true if user is verified to be muted, otherwise false

checkMutedForUser

java.util.concurrent.CompletableFuture<java.lang.Boolean> checkMutedForUser(java.lang.String userUUID)

Verifies whether the CoreMember matching the provided String userName is in fact muted.

A user is only muted if CoreMember.isMuted() is true and CoreMember.getMuteEndUtc() is in the future.

This method checks both CoreMember.isMuted() and CoreMember.getMuteEndUtc() and sets the member's mute status accordingly.

Parameters:

userUUID - UUID userUUID of member to verify mute for

Returns:

CompletableFuture wrapped Boolean. true if user is verified to be muted, otherwise false

setNickName

java.util.concurrent.CompletableFuture<java.lang.Boolean> setNickName(TKey id,
                                                                      java.lang.String nickName)

Updates the property nickName for the document whose id matches the provided TKey

Parameters:

id - TKey id of document to update

nickName - String new nickName

Returns:

CompletableFuture wrapped Boolean. true if successful, otherwise false

setNickNameForUser

java.util.concurrent.CompletableFuture<java.lang.Boolean> setNickNameForUser(java.util.UUID userUUID,
                                                                             java.lang.String nickName)

Updates the property nickName for documents whose property userUUID matches the provided UUID

Parameters:

userUUID - UUID userUUID of documents to update

nickName - String new nickName

Returns:

CompletableFuture wrapped Boolean. true if successful, otherwise false

setNickNameForUser

java.util.concurrent.CompletableFuture<java.lang.Boolean> setNickNameForUser(java.lang.String userName,
                                                                             java.lang.String nickName)

Updates the property nickName for documents whose property userName matches the provided String

Parameters:

userName - String userName of documents to update

nickName - String new nickName

Returns:

CompletableFuture wrapped Boolean. true if successful, otherwise false

deleteNickName

java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteNickName(TKey id)

Deletes the property nickName for the document whose id matches the provided TKey

Parameters:

id - TKey id of document to update

Returns:

CompletableFuture wrapped Boolean. true if successful, otherwise false

deleteNickNameForUser

java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteNickNameForUser(java.util.UUID userUUID)

Deletes the property nickName for documents whose property userUUID matches the provided UUID

Parameters:

userUUID - UUID userName of documents to update

Returns:

CompletableFuture wrapped Boolean. true if successful, otherwise false

deleteNickNameForUser

java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteNickNameForUser(java.lang.String userName)

Deletes the property nickName for documents whose property userName matches the provided String

Parameters:

userName - String userName of documents to update

Returns:

CompletableFuture wrapped boolean true if successful, otherwise false