me.lucko.luckperms.api

Interface Storage

public interface Storage

A means of loading and saving permission data to/from the backend.

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:

2.14

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Boolean>	createAndLoadGroup(String name) Deprecated. in favour of GroupManager.createAndLoadGroup(String)
CompletableFuture<Boolean>	createAndLoadTrack(String name) Deprecated. in favour of TrackManager.createAndLoadTrack(String)
CompletableFuture<Boolean>	deleteGroup(Group group) Deprecated. in favour of GroupManager.deleteGroup(Group)
CompletableFuture<Boolean>	deleteTrack(Track track) Deprecated. in favour of TrackManager.deleteTrack(Track)
Executor	getAsyncExecutor() Deprecated. as plugins should create their own executors
CompletableFuture<List<HeldPermission<String>>>	getGroupsWithPermission(String permission) Searches for a list of groups with a given permission.
CompletableFuture<Log>	getLog() Loads and returns the entire log from storage
String	getName() Get the name of the storage implementation.
CompletableFuture<String>	getName(UUID uuid) Gets a username from a UUID
Executor	getSyncExecutor() Deprecated. as plugins should create their own executors
CompletableFuture<Set<UUID>>	getUniqueUsers() Gets a set all "unique" user UUIDs.
CompletableFuture<List<HeldPermission<UUID>>>	getUsersWithPermission(String permission) Searches for a list of users with a given permission.
CompletableFuture<UUID>	getUUID(String username) Gets a UUID from a username
boolean	isAcceptingLogins() Deprecated. as this method always returns true.
CompletableFuture<Boolean>	loadAllGroups() Deprecated. in favour of GroupManager.loadAllGroups()
CompletableFuture<Boolean>	loadAllTracks() Deprecated. in favour of TrackManager.loadAllTracks()
CompletableFuture<Boolean>	loadGroup(String name) Deprecated. in favour of GroupManager.loadGroup(String)
CompletableFuture<Boolean>	loadTrack(String name) Deprecated. in favour of TrackManager.loadTrack(String)
default CompletableFuture<Boolean>	loadUser(UUID uuid) Deprecated. in favour of UserManager.loadUser(UUID)
CompletableFuture<Boolean>	loadUser(UUID uuid, String username) Deprecated. in favour of UserManager.loadUser(UUID, String)
CompletableFuture<Boolean>	logAction(LogEntry entry) Deprecated. in favour of ActionLogger.submit(LogEntry).
CompletableFuture<Boolean>	saveGroup(Group group) Deprecated. in favour of GroupManager.saveGroup(Group)
CompletableFuture<Boolean>	saveTrack(Track track) Deprecated. in favour of TrackManager.saveTrack(Track)
CompletableFuture<Boolean>	saveUser(User user) Deprecated. in favour of UserManager.saveUser(User)
CompletableFuture<Boolean>	saveUUIDData(String username, UUID uuid) Saves UUID caching data to the global cache

Method Detail

getName

@Nonnull
String getName()

Get the name of the storage implementation.

Returns:

the name of the implementation

getLog

@Nonnull
CompletableFuture<Log> getLog()

Loads and returns the entire log from storage

Returns:

a log instance, could be null if loading failed

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, or null if the operation failed.

getUsersWithPermission

@Nonnull
CompletableFuture<List<HeldPermission<UUID>>> getUsersWithPermission(@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, or null if the operation failed

Throws:

NullPointerException - if the permission is null

Since:

2.17

getGroupsWithPermission

@Nonnull
CompletableFuture<List<HeldPermission<String>>> getGroupsWithPermission(@Nonnull
                                                                                  String permission)

Searches for a list of groups with a given permission.

Parameters:

permission - the permission to search for

Returns:

a list of held permissions, or null if the operation failed

Throws:

NullPointerException - if the permission is null

Since:

2.17

saveUUIDData

@Nonnull
CompletableFuture<Boolean> saveUUIDData(@Nonnull
                                                  String username,
                                                  @Nonnull
                                                  UUID uuid)

Saves UUID caching data to the global cache

Parameters:

username - the users username

uuid - the users mojang unique id

Returns:

true if the operation completed successfully.

Throws:

NullPointerException - if either parameters are null

IllegalArgumentException - if the username is invalid

getUUID

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

Gets a UUID from a username

Parameters:

username - the corresponding username

Returns:

a uuid object, could be null

Throws:

NullPointerException - if either parameters are null

IllegalArgumentException - if the username is invalid

getName

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

Gets a username from a UUID

Parameters:

uuid - the corresponding uuid

Returns:

a name string, could be null

Throws:

NullPointerException - if either parameters are null

Since:

2.17

isAcceptingLogins

@Deprecated
boolean isAcceptingLogins()

Deprecated. as this method always returns true.

Gets whether the storage instance is allowing logins on the platform.

Returns:

true if logins are enabled

getSyncExecutor

@Nonnull
 @Deprecated
Executor getSyncExecutor()

Deprecated. as plugins should create their own executors

Returns an executor which will run all passed runnables on the main server thread.

This method is deprecated as plugins should create and use their own executor instances.

Returns:

an executor instance

getAsyncExecutor

@Nonnull
 @Deprecated
Executor getAsyncExecutor()

Deprecated. as plugins should create their own executors

Returns an executor which will run all passed runnables asynchronously using the platforms scheduler and thread pools.

This method is deprecated as plugins should create and use their own executor instances.

Returns:

an executor instance

logAction

@Nonnull
 @Deprecated
CompletableFuture<Boolean> logAction(@Nonnull
                                                             LogEntry entry)

Deprecated. in favour of ActionLogger.submit(LogEntry).

Saves an action to storage

Parameters:

entry - the log entry to be saved

Returns:

true if the operation completed successfully.

Throws:

NullPointerException - if entry is null

loadUser

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

Deprecated. in favour of UserManager.loadUser(UUID, String)

Loads a user's data from the main storage into the plugins local storage.

Parameters:

uuid - the uuid of the user to load

username - the users username, or null if it is not known.

Returns:

if the operation completed successfully

Throws:

NullPointerException - if uuid is null

loadUser

@Nonnull
 @Deprecated
default CompletableFuture<Boolean> loadUser(@Nonnull
                                                                    UUID uuid)

Deprecated. in favour of UserManager.loadUser(UUID)

Loads a user's data from the main storage into the plugins local storage.

Parameters:

uuid - the uuid of the user to load

Returns:

if the operation completed successfully

Throws:

NullPointerException - if uuid is null

saveUser

@Nonnull
 @Deprecated
CompletableFuture<Boolean> saveUser(@Nonnull
                                                            User user)

Deprecated. in favour of UserManager.saveUser(User)

Saves a user object back to storage.

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

Parameters:

user - the user to save

Returns:

true if the operation completed successfully.

Throws:

NullPointerException - if user is null

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

createAndLoadGroup

@Nonnull
 @Deprecated
CompletableFuture<Boolean> createAndLoadGroup(@Nonnull
                                                                      String name)

Deprecated. in favour of GroupManager.createAndLoadGroup(String)

Creates and loads a group into the plugins local storage

Parameters:

name - the name of the group

Returns:

true if the operation completed successfully

Throws:

NullPointerException - if name is null

IllegalArgumentException - if the name is invalid

loadGroup

@Nonnull
 @Deprecated
CompletableFuture<Boolean> loadGroup(@Nonnull
                                                             String name)

Deprecated. in favour of GroupManager.loadGroup(String)

Loads a group into the plugins local storage.

Parameters:

name - the name of the group

Returns:

true if the operation completed successfully

Throws:

NullPointerException - if name is null

IllegalArgumentException - if the name is invalid

loadAllGroups

@Nonnull
 @Deprecated
CompletableFuture<Boolean> loadAllGroups()

Deprecated. in favour of GroupManager.loadAllGroups()

Loads all groups from the storage into memory

Returns:

true if the operation completed successfully.

saveGroup

@Nonnull
 @Deprecated
CompletableFuture<Boolean> saveGroup(@Nonnull
                                                             Group group)

Deprecated. in favour of GroupManager.saveGroup(Group)

Saves a group back to storage.

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

Parameters:

group - the group to save

Returns:

true if the operation completed successfully.

Throws:

NullPointerException - if group is null

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

deleteGroup

@Nonnull
 @Deprecated
CompletableFuture<Boolean> deleteGroup(@Nonnull
                                                               Group group)

Deprecated. in favour of GroupManager.deleteGroup(Group)

Permanently deletes a group from storage.

Parameters:

group - the group to delete

Returns:

true if the operation completed successfully.

Throws:

NullPointerException - if group is null

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

createAndLoadTrack

@Nonnull
 @Deprecated
CompletableFuture<Boolean> createAndLoadTrack(@Nonnull
                                                                      String name)

Deprecated. in favour of TrackManager.createAndLoadTrack(String)

Creates and loads a track into the plugins local storage

Parameters:

name - the name of the track

Returns:

true if the operation completed successfully

Throws:

NullPointerException - if name is null

IllegalArgumentException - if the name is invalid

loadTrack

@Nonnull
 @Deprecated
CompletableFuture<Boolean> loadTrack(@Nonnull
                                                             String name)

Deprecated. in favour of TrackManager.loadTrack(String)

Loads a track into the plugins local storage.

Parameters:

name - the name of the track

Returns:

true if the operation completed successfully

Throws:

NullPointerException - if name is null

IllegalArgumentException - if the name is invalid

loadAllTracks

@Nonnull
 @Deprecated
CompletableFuture<Boolean> loadAllTracks()

Deprecated. in favour of TrackManager.loadAllTracks()

Loads all tracks from the storage into memory

Returns:

true if the operation completed successfully.

saveTrack

@Nonnull
 @Deprecated
CompletableFuture<Boolean> saveTrack(@Nonnull
                                                             Track track)

Deprecated. in favour of TrackManager.saveTrack(Track)

Saves a track back to storage. You should call this after you make any changes to a track.

Parameters:

track - the track to save

Returns:

true if the operation completed successfully.

Throws:

NullPointerException - if track is null

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

deleteTrack

@Nonnull
 @Deprecated
CompletableFuture<Boolean> deleteTrack(@Nonnull
                                                               Track track)

Deprecated. in favour of TrackManager.deleteTrack(Track)

Permanently deletes a track from storage

Parameters:

track - the track to delete

Returns:

true if the operation completed successfully.

Throws:

NullPointerException - if track is null

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