Class AbstractLuckPermsPlugin

java.lang.Object

me.lucko.luckperms.common.plugin.AbstractLuckPermsPlugin

All Implemented Interfaces:

LuckPermsPlugin

public abstract class AbstractLuckPermsPlugin
extends Object
implements LuckPermsPlugin

Constructor Summary

Constructors

Constructor	Description
AbstractLuckPermsPlugin()

Method Summary

Modifier and Type	Method	Description
protected DependencyManager	createDependencyManager()
final void	disable()
final void	enable()
LuckPermsApiProvider	getApiProvider()	Returns the class implementing the LuckPermsAPI on this platform.
BytebinClient	getBytebin()	Gets the bytebin instance in use by platform.
BytesocksClient	getBytesocks()	Gets the bytesocks instance in use by platform.
CalculatorFactory	getCalculatorFactory()	Gets the class responsible for constructing PermissionCalculators on this platform.
LuckPermsConfiguration	getConfiguration()	Gets the plugin's configuration
DependencyManager	getDependencyManager()	Gets the dependency manager for the plugin
EventDispatcher	getEventDispatcher()	Gets the event dispatcher
SimpleExtensionManager	getExtensionManager()	Gets the extension manager.
Optional<FileWatcher>	getFileWatcher()	Gets the file watcher running on the platform
protected Set<Dependency>	getGlobalDependencies()
okhttp3.OkHttpClient	getHttpClient()
InheritanceGraphFactory	getInheritanceGraphFactory()	Gets the inheritance handler
LogDispatcher	getLogDispatcher()	Gets the log dispatcher running on the platform
PluginLogger	getLogger()	Gets a wrapped logger instance for the platform.
Optional<InternalMessagingService>	getMessagingService()	Gets the messaging service.
PermissionRegistry	getPermissionRegistry()	Gets the permission registry for the platform.
static String	getPluginName()
Storage	getStorage()	Gets the primary data storage instance.
SyncTask.Buffer	getSyncTaskBuffer()	Gets the sync task buffer of the platform, used for scheduling and running sync tasks.
TranslationManager	getTranslationManager()	Gets the instance providing locale translations for the plugin
TranslationRepository	getTranslationRepository()	Gets the translation repository
VerboseHandler	getVerboseHandler()	Gets the verbose debug handler instance.
WebEditorStore	getWebEditorStore()	Gets the web editor store
final void	load()	Performs the initial actions to load the plugin
Optional<UUID>	lookupUniqueId(String username)	Lookup a uuid from a username.
Optional<String>	lookupUsername(UUID uniqueId)	Lookup a username from a uuid.
protected abstract void	performFinalSetup()
protected abstract CalculatorFactory	provideCalculatorFactory()
protected abstract ConfigurationAdapter	provideConfigurationAdapter()
protected abstract AbstractEventBus<?>	provideEventBus(LuckPermsApiProvider apiProvider)
protected abstract MessagingFactory<?>	provideMessagingFactory()
protected abstract void	registerApiOnPlatform(net.luckperms.api.LuckPerms api)
protected abstract void	registerCommands()
protected void	registerHousekeepingTasks()
protected abstract void	registerPlatformListeners()
protected void	removePlatformHooks()
protected Path	resolveConfig(String fileName)
net.luckperms.api.platform.Health	runHealthCheck()	Runs a health check for the plugin.
void	setMessagingService(InternalMessagingService messagingService)	Sets the messaging service.
protected abstract void	setupContextManager()
protected abstract void	setupManagers()
protected abstract void	setupPlatformHooks()
protected abstract void	setupSenderFactory()
protected boolean	skipCommandRegistration()
boolean	testUsernameValidity(String username)	Tests whether the given username is valid.

Methods inherited from class Object

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

Methods inherited from interface LuckPermsPlugin

getBootstrap, getCommandManager, getConnectionListener, getConsoleSender, getContextManager, getExtraCommands, getGroupManager, getOnlineSenders, getQueryOptionsForUser, getTrackManager, getUserManager, performPlatformDataSync

Constructor Details

AbstractLuckPermsPlugin

public AbstractLuckPermsPlugin()

Method Details

load

public final void load()

Performs the initial actions to load the plugin

enable

public final void enable()

disable

public final void disable()

createDependencyManager

protected DependencyManager createDependencyManager()

getGlobalDependencies

protected Set<Dependency> getGlobalDependencies()

registerHousekeepingTasks

protected void registerHousekeepingTasks()

setupSenderFactory

protected abstract void setupSenderFactory()

provideConfigurationAdapter

protected abstract ConfigurationAdapter provideConfigurationAdapter()

registerPlatformListeners

protected abstract void registerPlatformListeners()

provideMessagingFactory

protected abstract MessagingFactory<?> provideMessagingFactory()

registerCommands

protected abstract void registerCommands()

setupManagers

protected abstract void setupManagers()

provideCalculatorFactory

protected abstract CalculatorFactory provideCalculatorFactory()

setupContextManager

protected abstract void setupContextManager()

setupPlatformHooks

protected abstract void setupPlatformHooks()

provideEventBus

protected abstract AbstractEventBus<?> provideEventBus(LuckPermsApiProvider apiProvider)

registerApiOnPlatform

protected abstract void registerApiOnPlatform(net.luckperms.api.LuckPerms api)

performFinalSetup

protected abstract void performFinalSetup()

removePlatformHooks

protected void removePlatformHooks()

resolveConfig

protected Path resolveConfig(String fileName)

skipCommandRegistration

protected boolean skipCommandRegistration()

getLogger

public PluginLogger getLogger()

Description copied from interface: LuckPermsPlugin

Gets a wrapped logger instance for the platform.

Specified by:

getLogger in interface LuckPermsPlugin

Returns:

the plugin's logger

setMessagingService

public void setMessagingService(InternalMessagingService messagingService)

Description copied from interface: LuckPermsPlugin

Sets the messaging service.

Specified by:

setMessagingService in interface LuckPermsPlugin

Parameters:

messagingService - the service

runHealthCheck

public net.luckperms.api.platform.Health runHealthCheck()

Description copied from interface: LuckPermsPlugin

Runs a health check for the plugin.

Specified by:

runHealthCheck in interface LuckPermsPlugin

Returns:

the result of the healthcheck

lookupUniqueId

public Optional<UUID> lookupUniqueId(String username)

Description copied from interface: LuckPermsPlugin

Lookup a uuid from a username.

Specified by:

lookupUniqueId in interface LuckPermsPlugin

Parameters:

username - the username to lookup

Returns:

an optional uuid, if found

lookupUsername

public Optional<String> lookupUsername(UUID uniqueId)

Description copied from interface: LuckPermsPlugin

Lookup a username from a uuid.

Specified by:

lookupUsername in interface LuckPermsPlugin

Parameters:

uniqueId - the uuid to lookup

Returns:

an optional username, if found

testUsernameValidity

public boolean testUsernameValidity(String username)

Description copied from interface: LuckPermsPlugin

Tests whether the given username is valid.

Specified by:

testUsernameValidity in interface LuckPermsPlugin

Parameters:

username - the username

Returns:

true if valid

getDependencyManager

public DependencyManager getDependencyManager()

Description copied from interface: LuckPermsPlugin

Gets the dependency manager for the plugin

Specified by:

getDependencyManager in interface LuckPermsPlugin

Returns:

the dependency manager

getTranslationManager

public TranslationManager getTranslationManager()

Description copied from interface: LuckPermsPlugin

Gets the instance providing locale translations for the plugin

Specified by:

getTranslationManager in interface LuckPermsPlugin

Returns:

the translation manager

getVerboseHandler

public VerboseHandler getVerboseHandler()

Description copied from interface: LuckPermsPlugin

Gets the verbose debug handler instance.

Specified by:

getVerboseHandler in interface LuckPermsPlugin

Returns:

the debug handler instance

getPermissionRegistry

public PermissionRegistry getPermissionRegistry()

Description copied from interface: LuckPermsPlugin

Gets the permission registry for the platform.

Specified by:

getPermissionRegistry in interface LuckPermsPlugin

Returns:

the permission registry

getLogDispatcher

public LogDispatcher getLogDispatcher()

Description copied from interface: LuckPermsPlugin

Gets the log dispatcher running on the platform

Specified by:

getLogDispatcher in interface LuckPermsPlugin

Returns:

the log dispatcher

getConfiguration

public LuckPermsConfiguration getConfiguration()

Description copied from interface: LuckPermsPlugin

Gets the plugin's configuration

Specified by:

getConfiguration in interface LuckPermsPlugin

Returns:

the plugin config

getHttpClient

public okhttp3.OkHttpClient getHttpClient()

getBytebin

public BytebinClient getBytebin()

Description copied from interface: LuckPermsPlugin

Gets the bytebin instance in use by platform.

Specified by:

getBytebin in interface LuckPermsPlugin

Returns:

the bytebin instance

getBytesocks

public BytesocksClient getBytesocks()

Description copied from interface: LuckPermsPlugin

Gets the bytesocks instance in use by platform.

Specified by:

getBytesocks in interface LuckPermsPlugin

Returns:

the bytesocks instance

getWebEditorStore

public WebEditorStore getWebEditorStore()

Description copied from interface: LuckPermsPlugin

Gets the web editor store

Specified by:

getWebEditorStore in interface LuckPermsPlugin

Returns:

the web editor store

getTranslationRepository

public TranslationRepository getTranslationRepository()

Description copied from interface: LuckPermsPlugin

Gets the translation repository

Specified by:

getTranslationRepository in interface LuckPermsPlugin

Returns:

the translation repository

getFileWatcher

public Optional<FileWatcher> getFileWatcher()

Description copied from interface: LuckPermsPlugin

Gets the file watcher running on the platform

Specified by:

getFileWatcher in interface LuckPermsPlugin

Returns:

the file watcher

getStorage

public Storage getStorage()

Description copied from interface: LuckPermsPlugin

Gets the primary data storage instance. This is likely to be wrapped with extra layers for caching, etc.

Specified by:

getStorage in interface LuckPermsPlugin

Returns:

the storage handler instance

getMessagingService

public Optional<InternalMessagingService> getMessagingService()

Description copied from interface: LuckPermsPlugin

Gets the messaging service.

Specified by:

getMessagingService in interface LuckPermsPlugin

Returns:

the messaging service

getSyncTaskBuffer

public SyncTask.Buffer getSyncTaskBuffer()

Description copied from interface: LuckPermsPlugin

Gets the sync task buffer of the platform, used for scheduling and running sync tasks.

Specified by:

getSyncTaskBuffer in interface LuckPermsPlugin

Returns:

the sync task buffer instance

getInheritanceGraphFactory

public InheritanceGraphFactory getInheritanceGraphFactory()

Description copied from interface: LuckPermsPlugin

Gets the inheritance handler

Specified by:

getInheritanceGraphFactory in interface LuckPermsPlugin

Returns:

the inheritance handler

getCalculatorFactory

public CalculatorFactory getCalculatorFactory()

Description copied from interface: LuckPermsPlugin

Gets the class responsible for constructing PermissionCalculators on this platform.

Specified by:

getCalculatorFactory in interface LuckPermsPlugin

Returns:

the permission calculator factory

getApiProvider

public LuckPermsApiProvider getApiProvider()

Description copied from interface: LuckPermsPlugin

Returns the class implementing the LuckPermsAPI on this platform.

Specified by:

getApiProvider in interface LuckPermsPlugin

Returns:

the api

getExtensionManager

public SimpleExtensionManager getExtensionManager()

Description copied from interface: LuckPermsPlugin

Gets the extension manager.

Specified by:

getExtensionManager in interface LuckPermsPlugin

Returns:

the extension manager

getEventDispatcher

public EventDispatcher getEventDispatcher()

Description copied from interface: LuckPermsPlugin

Gets the event dispatcher

Specified by:

getEventDispatcher in interface LuckPermsPlugin

Returns:

the event dispatcher

getPluginName

public static String getPluginName()