Package de.dytanic.cloudnet.driver

Class CloudNetDriver

java.lang.Object

de.dytanic.cloudnet.driver.CloudNetDriver

public abstract class CloudNetDriver
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected CloudServiceFactory	cloudServiceFactory
protected DriverEnvironment	driverEnvironment
protected IEventManager	eventManager
protected GeneralCloudServiceProvider	generalCloudServiceProvider
protected GroupConfigurationProvider	groupConfigurationProvider
protected de.dytanic.cloudnet.common.logging.ILogger	logger
protected CloudMessenger	messenger
protected IModuleProvider	moduleProvider
protected NodeInfoProvider	nodeInfoProvider
protected IPermissionManagement	permissionManagement
protected java.util.concurrent.ScheduledExecutorService	scheduler
protected de.dytanic.cloudnet.common.registry.IServicesRegistry	servicesRegistry
protected ServiceTaskProvider	serviceTaskProvider
protected de.dytanic.cloudnet.common.concurrent.ITaskScheduler	taskScheduler

Constructor Summary

Constructors

Constructor	Description
CloudNetDriver(@NotNull de.dytanic.cloudnet.common.logging.ILogger logger)

Method Summary

Modifier and Type	Method	Description
abstract @NotNull java.util.Collection<TemplateStorage>	getAvailableTemplateStorages()
abstract @NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.util.Collection<TemplateStorage>>	getAvailableTemplateStoragesAsync()
@NotNull CloudServiceFactory	getCloudServiceFactory()
@NotNull GeneralCloudServiceProvider	getCloudServiceProvider()	Returns the general CloudServiceProvider
abstract @NotNull SpecificCloudServiceProvider	getCloudServiceProvider(@NotNull ServiceInfoSnapshot serviceInfoSnapshot)	Returns a new service specific CloudServiceProvider
abstract @NotNull SpecificCloudServiceProvider	getCloudServiceProvider(@NotNull java.lang.String name)	Returns a new service specific CloudServiceProvider
abstract @NotNull SpecificCloudServiceProvider	getCloudServiceProvider(@NotNull java.util.UUID uniqueId)	Returns a new service specific CloudServiceProvider
abstract @NotNull java.lang.String	getComponentName()	Returns the name of this component.
abstract @NotNull DatabaseProvider	getDatabaseProvider()
@NotNull DriverEnvironment	getDriverEnvironment()
@NotNull IEventManager	getEventManager()
@NotNull GroupConfigurationProvider	getGroupConfigurationProvider()
static CloudNetDriver	getInstance()
abstract @NotNull TemplateStorage	getLocalTemplateStorage()
@NotNull java.util.Collection<ServiceTemplate>	getLocalTemplateStorageTemplates()	Deprecated. use getLocalTemplateStorage() instead
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.util.Collection<ServiceTemplate>>	getLocalTemplateStorageTemplatesAsync()	Deprecated. use getLocalTemplateStorage() instead
@NotNull de.dytanic.cloudnet.common.logging.ILogger	getLogger()
@NotNull CloudMessenger	getMessenger()
@NotNull IModuleProvider	getModuleProvider()
abstract @NotNull INetworkClient	getNetworkClient()
@NotNull NodeInfoProvider	getNodeInfoProvider()
abstract @NotNull java.lang.String	getNodeUniqueId()	Gets the component name if it is called on a node and the name of the node if it is called on a wrapper.
int	getOwnPID()	Fetches the PID of this process.
@NotNull IPermissionManagement	getPermissionManagement()
@NotNull de.dytanic.cloudnet.common.registry.IServicesRegistry	getServicesRegistry()
@NotNull ServiceTaskProvider	getServiceTaskProvider()
@NotNull java.util.concurrent.ScheduledExecutorService	getTaskExecutor()
@NotNull de.dytanic.cloudnet.common.concurrent.ITaskScheduler	getTaskScheduler()	Deprecated.
abstract @Nullable TemplateStorage	getTemplateStorage(java.lang.String storage)
@NotNull java.util.Collection<ServiceTemplate>	getTemplateStorageTemplates(@NotNull java.lang.String serviceName)	Deprecated. use getTemplateStorage(String) instead
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.util.Collection<ServiceTemplate>>	getTemplateStorageTemplatesAsync(@NotNull java.lang.String serviceName)	Deprecated. use getTemplateStorage(String) instead
static java.util.Optional<CloudNetDriver>	optionalInstance()	The CloudNetDriver instance won't be null usually, this method is only relevant for tests
abstract de.dytanic.cloudnet.common.collection.Pair<java.lang.Boolean,java.lang.String[]>	sendCommandLineAsPermissionUser(@NotNull java.util.UUID uniqueId, @NotNull java.lang.String commandLine)
abstract @NotNull de.dytanic.cloudnet.common.concurrent.ITask<de.dytanic.cloudnet.common.collection.Pair<java.lang.Boolean,java.lang.String[]>>	sendCommandLineAsPermissionUserAsync(@NotNull java.util.UUID uniqueId, @NotNull java.lang.String commandLine)
abstract void	setGlobalLogLevel(int logLevel)
abstract void	setGlobalLogLevel(@NotNull de.dytanic.cloudnet.common.logging.LogLevel logLevel)
protected static void	setInstance(@NotNull CloudNetDriver instance)
void	setPermissionManagement(@NotNull IPermissionManagement permissionManagement)
abstract void	start()
abstract void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

servicesRegistry

protected final de.dytanic.cloudnet.common.registry.IServicesRegistry servicesRegistry

eventManager

protected final IEventManager eventManager

moduleProvider

protected final IModuleProvider moduleProvider

taskScheduler

protected final de.dytanic.cloudnet.common.concurrent.ITaskScheduler taskScheduler

scheduler

protected final java.util.concurrent.ScheduledExecutorService scheduler

logger

protected final de.dytanic.cloudnet.common.logging.ILogger logger

permissionManagement

protected IPermissionManagement permissionManagement

cloudServiceFactory

protected CloudServiceFactory cloudServiceFactory

generalCloudServiceProvider

protected GeneralCloudServiceProvider generalCloudServiceProvider

serviceTaskProvider

protected ServiceTaskProvider serviceTaskProvider

groupConfigurationProvider

protected GroupConfigurationProvider groupConfigurationProvider

nodeInfoProvider

protected NodeInfoProvider nodeInfoProvider

messenger

protected CloudMessenger messenger

driverEnvironment

protected DriverEnvironment driverEnvironment

Constructor Detail

CloudNetDriver

public CloudNetDriver(@NotNull
                      @NotNull de.dytanic.cloudnet.common.logging.ILogger logger)

Method Detail

getInstance

public static CloudNetDriver getInstance()

setInstance

protected static void setInstance(@NotNull
                                  @NotNull CloudNetDriver instance)

optionalInstance

public static java.util.Optional<CloudNetDriver> optionalInstance()

The CloudNetDriver instance won't be null usually, this method is only relevant for tests

Returns:

optional CloudNetDriver

start

public abstract void start()
                    throws java.lang.Exception

Throws:

java.lang.Exception

stop

public abstract void stop()

getComponentName

@NotNull
public abstract @NotNull java.lang.String getComponentName()

Returns the name of this component. (e.g. Node-1, Lobby-1)

getNodeUniqueId

@NotNull
public abstract @NotNull java.lang.String getNodeUniqueId()

Gets the component name if it is called on a node and the name of the node if it is called on a wrapper.

Returns:

the uniqueId of the current node

getCloudServiceFactory

@NotNull
public @NotNull CloudServiceFactory getCloudServiceFactory()

getServiceTaskProvider

@NotNull
public @NotNull ServiceTaskProvider getServiceTaskProvider()

getNodeInfoProvider

@NotNull
public @NotNull NodeInfoProvider getNodeInfoProvider()

getGroupConfigurationProvider

@NotNull
public @NotNull GroupConfigurationProvider getGroupConfigurationProvider()

getMessenger

@NotNull
public @NotNull CloudMessenger getMessenger()

getPermissionManagement

@NotNull
public @NotNull IPermissionManagement getPermissionManagement()

setPermissionManagement

public void setPermissionManagement(@NotNull
                                    @NotNull IPermissionManagement permissionManagement)

getLocalTemplateStorage

@NotNull
public abstract @NotNull TemplateStorage getLocalTemplateStorage()

getTemplateStorage

@Nullable
public abstract @Nullable TemplateStorage getTemplateStorage(java.lang.String storage)

getAvailableTemplateStorages

@NotNull
public abstract @NotNull java.util.Collection<TemplateStorage> getAvailableTemplateStorages()

getAvailableTemplateStoragesAsync

@NotNull
public abstract @NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.util.Collection<TemplateStorage>> getAvailableTemplateStoragesAsync()

getDatabaseProvider

@NotNull
public abstract @NotNull DatabaseProvider getDatabaseProvider()

getCloudServiceProvider

@NotNull
public abstract @NotNull SpecificCloudServiceProvider getCloudServiceProvider(@NotNull
                                                                              @NotNull java.lang.String name)

Returns a new service specific CloudServiceProvider

Parameters:

name - the name of the service

Returns:

the new instance of the SpecificCloudServiceProvider

getCloudServiceProvider

@NotNull
public abstract @NotNull SpecificCloudServiceProvider getCloudServiceProvider(@NotNull
                                                                              @NotNull java.util.UUID uniqueId)

Returns a new service specific CloudServiceProvider

Parameters:

uniqueId - the uniqueId of the service

Returns:

the new instance of the SpecificCloudServiceProvider

getCloudServiceProvider

@NotNull
public abstract @NotNull SpecificCloudServiceProvider getCloudServiceProvider(@NotNull
                                                                              @NotNull ServiceInfoSnapshot serviceInfoSnapshot)

Returns a new service specific CloudServiceProvider

Parameters:

serviceInfoSnapshot - the info of the service to create a provider for

Returns:

the new instance of the SpecificCloudServiceProvider

getCloudServiceProvider

@NotNull
public @NotNull GeneralCloudServiceProvider getCloudServiceProvider()

Returns the general CloudServiceProvider

Returns:

the instance of the GeneralCloudServiceProvider

getNetworkClient

@NotNull
public abstract @NotNull INetworkClient getNetworkClient()

getLocalTemplateStorageTemplatesAsync

@Deprecated
@NotNull
public @NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.util.Collection<ServiceTemplate>> getLocalTemplateStorageTemplatesAsync()

Deprecated.

use getLocalTemplateStorage() instead

getTemplateStorageTemplatesAsync

@Deprecated
@NotNull
public @NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.util.Collection<ServiceTemplate>> getTemplateStorageTemplatesAsync(@NotNull
                                                                                                                                    @NotNull java.lang.String serviceName)

Deprecated.

use getTemplateStorage(String) instead

getLocalTemplateStorageTemplates

@Deprecated
@NotNull
public @NotNull java.util.Collection<ServiceTemplate> getLocalTemplateStorageTemplates()

Deprecated.

use getLocalTemplateStorage() instead

getTemplateStorageTemplates

@Deprecated
@NotNull
public @NotNull java.util.Collection<ServiceTemplate> getTemplateStorageTemplates(@NotNull
                                                                                  @NotNull java.lang.String serviceName)

Deprecated.

use getTemplateStorage(String) instead

setGlobalLogLevel

public abstract void setGlobalLogLevel(@NotNull
                                       @NotNull de.dytanic.cloudnet.common.logging.LogLevel logLevel)

setGlobalLogLevel

public abstract void setGlobalLogLevel(int logLevel)

sendCommandLineAsPermissionUser

public abstract de.dytanic.cloudnet.common.collection.Pair<java.lang.Boolean,java.lang.String[]> sendCommandLineAsPermissionUser(@NotNull
                                                                                                                                       @NotNull java.util.UUID uniqueId,
                                                                                                                                       @NotNull
                                                                                                                                       @NotNull java.lang.String commandLine)

sendCommandLineAsPermissionUserAsync

@NotNull
public abstract @NotNull de.dytanic.cloudnet.common.concurrent.ITask<de.dytanic.cloudnet.common.collection.Pair<java.lang.Boolean,java.lang.String[]>> sendCommandLineAsPermissionUserAsync(@NotNull
                                                                                                                                                                                                  @NotNull java.util.UUID uniqueId,
                                                                                                                                                                                                  @NotNull
                                                                                                                                                                                                  @NotNull java.lang.String commandLine)

getOwnPID

public int getOwnPID()

Fetches the PID of this process.

Returns:

the PID as an int or -1, if it couldn't be fetched

getServicesRegistry

@NotNull
public @NotNull de.dytanic.cloudnet.common.registry.IServicesRegistry getServicesRegistry()

getEventManager

@NotNull
public @NotNull IEventManager getEventManager()

getModuleProvider

@NotNull
public @NotNull IModuleProvider getModuleProvider()

getTaskScheduler

@NotNull
@Deprecated
@ScheduledForRemoval
public @NotNull de.dytanic.cloudnet.common.concurrent.ITaskScheduler getTaskScheduler()

Deprecated.

getTaskExecutor

@NotNull
public @NotNull java.util.concurrent.ScheduledExecutorService getTaskExecutor()

getLogger

@NotNull
public @NotNull de.dytanic.cloudnet.common.logging.ILogger getLogger()

getDriverEnvironment

@NotNull
public @NotNull DriverEnvironment getDriverEnvironment()