me.lucko.luckperms.api.manager

Interface UserManager

public interface UserManager

Represents the object responsible for managing User instances.

Note that User instances are automatically loaded for online players. It's likely that offline players will not have an instance pre-loaded.

All blocking methods return CompletableFutures, which will be populated with the result once the data has been loaded/saved asynchronously. Care should be taken when using such methods to ensure that the main server thread is not blocked.

Methods such as CompletableFuture.get() and equivalent should not be called on the main server thread. If you need to use the result of these operations on the main server thread, register a callback using CompletableFuture.thenAcceptAsync(Consumer, Executor).

Since:

4.0

Method Summary

Modifier and Type	Method and Description
void	cleanupUser(User user) Unload a user from the internal storage, if they're not currently online.
Set<User>	getLoadedUsers() Gets a set of all loaded users.
CompletableFuture<Set<UUID>>	getUniqueUsers() Gets a set all "unique" user UUIDs.
User	getUser(String name) Gets a loaded user.
User	getUser(UUID uuid) Gets a loaded user.
default Optional<User>	getUserOpt(String name) Gets a loaded user.
default Optional<User>	getUserOpt(UUID uuid) Gets a loaded user.
CompletableFuture<List<HeldPermission<UUID>>>	getWithPermission(String permission) Searches for a list of users with a given permission.
boolean	isLoaded(UUID uuid) Check if a user is loaded in memory
default CompletableFuture<User>	loadUser(UUID uuid) Loads a user from the plugin's storage provider into memory.
CompletableFuture<User>	loadUser(UUID uuid, String username) Loads a user from the plugin's storage provider into memory.
CompletableFuture<String>	lookupUsername(UUID uuid) Uses the LuckPerms cache to find a username for the given uuid.
CompletableFuture<UUID>	lookupUuid(String username) Uses the LuckPerms cache to find a uuid for the given username.
CompletableFuture<PlayerSaveResult>	savePlayerData(UUID uuid, String username) Saves data about a player to the uuid caching system.
CompletableFuture<Void>	saveUser(User user) Saves a user's data back to the plugin's storage provider.

Method Detail

loadUser

@Nonnull
CompletableFuture<User> loadUser(@Nonnull
                                           UUID uuid,
                                           @Nullable
                                           String username)

Loads a user from the plugin's storage provider into memory.

This method is effectively the same as Storage.loadUser(UUID, String), however, the Future returns the resultant user instance instead of a boolean flag.

Unlike the method in Storage, when a user cannot be loaded, the future will be completed exceptionally.

Parameters:

uuid - the uuid of the user

username - the username, if known

Returns:

the resultant user

Throws:

NullPointerException - if the uuid is null

Since:

4.1

loadUser

@Nonnull
default CompletableFuture<User> loadUser(@Nonnull
                                                   UUID uuid)

Loads a user from the plugin's storage provider into memory.

This method is effectively the same as Storage.loadUser(UUID), however, the Future returns the resultant user instance instead of a boolean flag.

Unlike the method in Storage, when a user cannot be loaded, the future will be completed exceptionally.

Parameters:

uuid - the uuid of the user

Returns:

the resultant user

Throws:

NullPointerException - if the uuid is null

Since:

4.1

lookupUuid

@Nonnull
CompletableFuture<UUID> lookupUuid(@Nonnull
                                             String username)

Uses the LuckPerms cache to find a uuid for the given username.

This lookup is case insensitive.

Parameters:

username - the username

Returns:

a uuid, could be null

Throws:

NullPointerException - if either parameters are null

IllegalArgumentException - if the username is invalid

Since:

4.2

lookupUsername

@Nonnull
CompletableFuture<String> lookupUsername(@Nonnull
                                                   UUID uuid)

Uses the LuckPerms cache to find a username for the given uuid.

Parameters:

uuid - the uuid

Returns:

a username, could be null

Throws:

NullPointerException - if either parameters are null

IllegalArgumentException - if the username is invalid

Since:

4.2

saveUser

@Nonnull
CompletableFuture<Void> saveUser(@Nonnull
                                           User user)

Saves a user's data back to the plugin's storage provider.

You should call this after you make any changes to a user.

This method is effectively the same as Storage.saveUser(User), however, the Future returns void instead of a boolean flag.

Unlike the method in Storage, when a user cannot be saved, the future will be completed exceptionally.

Parameters:

user - the user to save

Returns:

a future to encapsulate the operation.

Throws:

NullPointerException - if user is null

IllegalStateException - if the user instance was not obtained from LuckPerms.

Since:

4.1

savePlayerData

@Nonnull
CompletableFuture<PlayerSaveResult> savePlayerData(@Nonnull
                                                             UUID uuid,
                                                             @Nonnull
                                                             String username)

Saves data about a player to the uuid caching system.

Parameters:

uuid - the users mojang unique id

username - the users username

Returns:

the result of the operation.

Throws:

NullPointerException - if either parameters are null

IllegalArgumentException - if the username is invalid

Since:

4.2

getUniqueUsers

@Nonnull
CompletableFuture<Set<UUID>> getUniqueUsers()

Gets a set all "unique" user UUIDs.

"Unique" meaning the user isn't just a member of the "default" group.

Returns:

a set of uuids

Since:

4.2

getWithPermission

@Nonnull
CompletableFuture<List<HeldPermission<UUID>>> getWithPermission(@Nonnull
                                                                          String permission)

Searches for a list of users with a given permission.

Parameters:

permission - the permission to search for

Returns:

a list of held permissions

Throws:

NullPointerException - if the permission is null

Since:

4.2

getUser

@Nullable
User getUser(@Nonnull
                        UUID uuid)

Gets a loaded user.

Parameters:

uuid - the uuid of the user to get

Returns:

a User object, if one matching the uuid is loaded, or null if not

Throws:

NullPointerException - if the uuid is null

getUserOpt

@Nonnull
default Optional<User> getUserOpt(@Nonnull
                                            UUID uuid)

Gets a loaded user.

Parameters:

uuid - the uuid of the user to get

Returns:

an optional User object

Throws:

NullPointerException - if the uuid is null

getUser

@Nullable
User getUser(@Nonnull
                        String name)

Gets a loaded user.

Parameters:

name - the username of the user to get

Returns:

a User object, if one matching the uuid is loaded, or null if not

Throws:

NullPointerException - if the name is null

getUserOpt

@Nonnull
default Optional<User> getUserOpt(@Nonnull
                                            String name)

Gets a loaded user.

Parameters:

name - the username of the user to get

Returns:

an optional User object

Throws:

NullPointerException - if the name is null

getLoadedUsers

@Nonnull
Set<User> getLoadedUsers()

Gets a set of all loaded users.

Returns:

a Set of User objects

isLoaded

boolean isLoaded(@Nonnull
                 UUID uuid)

Check if a user is loaded in memory

Parameters:

uuid - the uuid to check for

Returns:

true if the user is loaded

Throws:

NullPointerException - if the uuid is null

cleanupUser

void cleanupUser(@Nonnull
                 User user)

Unload a user from the internal storage, if they're not currently online.

Parameters:

user - the user to unload

Throws:

NullPointerException - if the user is null