Class AbstractConfigurateStorage

java.lang.Object

me.lucko.luckperms.common.storage.implementation.file.AbstractConfigurateStorage

All Implemented Interfaces:

StorageImplementation

Direct Known Subclasses:

CombinedConfigurateStorage, SeparatedConfigurateStorage

public abstract class AbstractConfigurateStorage
extends Object
implements StorageImplementation

Abstract storage implementation using Configurate ConfigurationNodes to serialize and deserialize data.

Field Summary

Fields

Modifier and Type	Field	Description
protected Path	dataDirectory
protected final ConfigurateLoader	loader	The Configurate loader used to read/write data
protected final LuckPermsPlugin	plugin	The plugin instance

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractConfigurateStorage(LuckPermsPlugin plugin, String implementationName, ConfigurateLoader loader, String dataDirectoryName)

Method Summary

Modifier and Type	Method	Description
Group	createAndLoadGroup(String name)
Track	createAndLoadTrack(String name)
void	deleteGroup(Group group)
void	deletePlayerData(UUID uniqueId)
void	deleteTrack(Track track)
String	getImplementationName()
LogPage	getLogPage(FilterList<net.luckperms.api.actionlog.Action> filters, @Nullable PageParameters page)
StorageMetadata	getMeta()
String	getPlayerName(UUID uniqueId)
UUID	getPlayerUniqueId(String username)
LuckPermsPlugin	getPlugin()
void	init()
Optional<Group>	loadGroup(String name)
Optional<Track>	loadTrack(String name)
User	loadUser(UUID uniqueId, String username)
Map<UUID,User>	loadUsers(Set<UUID> uniqueIds)
void	logAction(net.luckperms.api.actionlog.Action entry)
protected boolean	processBulkUpdate(BulkUpdate bulkUpdate, ninja.leaping.configurate.ConfigurationNode node, HolderType holderType)
protected abstract ninja.leaping.configurate.ConfigurationNode	readFile(StorageLocation location, String name)	Reads a configuration node from the given location
protected static Set<net.luckperms.api.node.Node>	readNodes(ninja.leaping.configurate.ConfigurationNode data)
protected abstract void	saveFile(StorageLocation location, String name, ninja.leaping.configurate.ConfigurationNode node)	Saves a configuration node to the given location
void	saveGroup(Group group)
net.luckperms.api.model.PlayerSaveResult	savePlayerData(UUID uniqueId, String username)
void	saveTrack(Track track)
void	saveUser(User user)
void	shutdown()

Methods inherited from class Object

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

Methods inherited from interface StorageImplementation

applyBulkUpdate, getUniqueUsers, loadAllGroups, loadAllTracks, searchGroupNodes, searchUserNodes

Field Details

plugin

protected final LuckPermsPlugin plugin

The plugin instance

loader

protected final ConfigurateLoader loader

The Configurate loader used to read/write data

dataDirectory

protected Path dataDirectory

Constructor Details

AbstractConfigurateStorage

protected AbstractConfigurateStorage(LuckPermsPlugin plugin,
 String implementationName,
 ConfigurateLoader loader,
 String dataDirectoryName)

Method Details

getPlugin

public LuckPermsPlugin getPlugin()

Specified by:

getPlugin in interface StorageImplementation

getImplementationName

public String getImplementationName()

Specified by:

getImplementationName in interface StorageImplementation

getMeta

public StorageMetadata getMeta()

Specified by:

getMeta in interface StorageImplementation

readFile

protected abstract ninja.leaping.configurate.ConfigurationNode readFile(StorageLocation location,
 String name)
                                                                 throws IOException

Reads a configuration node from the given location

Parameters:

location - the location

name - the name of the object

Returns:

the node

Throws:

IOException - if an io error occurs

saveFile

protected abstract void saveFile(StorageLocation location,
 String name,
 ninja.leaping.configurate.ConfigurationNode node)
                          throws IOException

Saves a configuration node to the given location

Parameters:

location - the location

name - the name of the object

node - the node

Throws:

IOException - if an io error occurs

init

public void init()
          throws IOException

Specified by:

init in interface StorageImplementation

Throws:

IOException

shutdown

public void shutdown()

Specified by:

shutdown in interface StorageImplementation

logAction

public void logAction(net.luckperms.api.actionlog.Action entry)

Specified by:

logAction in interface StorageImplementation

getLogPage

public LogPage getLogPage(FilterList<net.luckperms.api.actionlog.Action> filters,
 @Nullable PageParameters page)
                   throws Exception

Specified by:

getLogPage in interface StorageImplementation

Throws:

Exception

loadUser

public User loadUser(UUID uniqueId,
 String username)
              throws IOException

Specified by:

loadUser in interface StorageImplementation

Throws:

IOException

loadUsers

public Map<UUID,User> loadUsers(Set<UUID> uniqueIds)
                         throws Exception

Specified by:

loadUsers in interface StorageImplementation

Throws:

Exception

saveUser

public void saveUser(User user)
              throws IOException

Specified by:

saveUser in interface StorageImplementation

Throws:

IOException

createAndLoadGroup

public Group createAndLoadGroup(String name)
                         throws IOException

Specified by:

createAndLoadGroup in interface StorageImplementation

Throws:

IOException

loadGroup

public Optional<Group> loadGroup(String name)
                          throws IOException

Specified by:

loadGroup in interface StorageImplementation

Throws:

IOException

saveGroup

public void saveGroup(Group group)
               throws IOException

Specified by:

saveGroup in interface StorageImplementation

Throws:

IOException

deleteGroup

public void deleteGroup(Group group)
                 throws IOException

Specified by:

deleteGroup in interface StorageImplementation

Throws:

IOException

createAndLoadTrack

public Track createAndLoadTrack(String name)
                         throws IOException

Specified by:

createAndLoadTrack in interface StorageImplementation

Throws:

IOException

loadTrack

public Optional<Track> loadTrack(String name)
                          throws IOException

Specified by:

loadTrack in interface StorageImplementation

Throws:

IOException

saveTrack

public void saveTrack(Track track)
               throws IOException

Specified by:

saveTrack in interface StorageImplementation

Throws:

IOException

deleteTrack

public void deleteTrack(Track track)
                 throws IOException

Specified by:

deleteTrack in interface StorageImplementation

Throws:

IOException

savePlayerData

public net.luckperms.api.model.PlayerSaveResult savePlayerData(UUID uniqueId,
 String username)

Specified by:

savePlayerData in interface StorageImplementation

deletePlayerData

public void deletePlayerData(UUID uniqueId)

Specified by:

deletePlayerData in interface StorageImplementation

getPlayerUniqueId

public UUID getPlayerUniqueId(String username)

Specified by:

getPlayerUniqueId in interface StorageImplementation

getPlayerName

public String getPlayerName(UUID uniqueId)

Specified by:

getPlayerName in interface StorageImplementation

processBulkUpdate

protected boolean processBulkUpdate(BulkUpdate bulkUpdate,
 ninja.leaping.configurate.ConfigurationNode node,
 HolderType holderType)

readNodes

protected static Set<net.luckperms.api.node.Node> readNodes(ninja.leaping.configurate.ConfigurationNode data)