Package de.dytanic.cloudnet.driver.provider.service

Class RemoteSpecificCloudServiceProvider

java.lang.Object

de.dytanic.cloudnet.driver.provider.service.RemoteSpecificCloudServiceProvider

All Implemented Interfaces:

DriverAPIUser, SpecificCloudServiceProvider

public class RemoteSpecificCloudServiceProvider
extends java.lang.Object
implements SpecificCloudServiceProvider, DriverAPIUser

Constructor Summary

Constructors

Constructor	Description
RemoteSpecificCloudServiceProvider(INetworkChannel channel, GeneralCloudServiceProvider provider, java.lang.String name)
RemoteSpecificCloudServiceProvider(INetworkChannel channel, GeneralCloudServiceProvider provider, java.util.UUID uniqueId)
RemoteSpecificCloudServiceProvider(INetworkChannel channel, ServiceInfoSnapshot serviceInfoSnapshot)

Method Summary

Modifier and Type	Method	Description
void	addServiceDeployment(@NotNull ServiceDeployment serviceDeployment)	Adds a deployment to this service, which will be used when SpecificCloudServiceProvider.deployResources() or SpecificCloudServiceProvider.deployResources(boolean) is called.
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Void>	addServiceDeploymentAsync(@NotNull ServiceDeployment serviceDeployment)	Adds a deployment to this service, which will be used when SpecificCloudServiceProvider.deployResources() or SpecificCloudServiceProvider.deployResources(boolean) is called
void	addServiceRemoteInclusion(@NotNull ServiceRemoteInclusion serviceRemoteInclusion)	Adds a remote inclusion to this service.
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Void>	addServiceRemoteInclusionAsync(@NotNull ServiceRemoteInclusion serviceRemoteInclusion)	Adds a remote inclusion to this service.
void	addServiceTemplate(@NotNull ServiceTemplate serviceTemplate)	Adds a service template to this service.
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Void>	addServiceTemplateAsync(@NotNull ServiceTemplate serviceTemplate)	Adds a service template to this service.
void	deployResources(boolean removeDeployments)	Writes all deployments to their defined templates of this service.
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Void>	deployResourcesAsync(boolean removeDeployments)	Writes all deployments to their defined templates of this service.
@Nullable ServiceInfoSnapshot	forceUpdateServiceInfo()	Forces this service to update its ServiceInfoSnapshot, instead of SpecificCloudServiceProvider.getServiceInfoSnapshot(), this method always returns the current snapshot with the current e.g.
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<ServiceInfoSnapshot>	forceUpdateServiceInfoAsync()	Forces this service to update its ServiceInfoSnapshot, instead of SpecificCloudServiceProvider.getServiceInfoSnapshot(), this method always returns the current snapshot with the current e.g.
java.util.Queue<java.lang.String>	getCachedLogMessages()	Gets a queue containing the last messages of this services console.
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.util.Queue<java.lang.String>>	getCachedLogMessagesAsync()	Gets a queue containing the last messages of this services console.
INetworkChannel	getNetworkChannel()
@Nullable ServiceInfoSnapshot	getServiceInfoSnapshot()	Gets the info of the service this provider is for.
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<ServiceInfoSnapshot>	getServiceInfoSnapshotAsync()	Gets the info of the service this provider is for
void	includeWaitingServiceInclusions()	Copies all inclusions of this service into the directory where this service is located in
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Void>	includeWaitingServiceInclusionsAsync()	Copies all inclusions of this service into the directory where this service is located in
void	includeWaitingServiceTemplates()	Copies all templates of this service into the directory where this service is located in
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Void>	includeWaitingServiceTemplatesAsync()	Copies all templates of this service into the directory where this service is located in
boolean	isValid()	Checks whether the service info on this provider is available or not.
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean>	isValidAsync()	Checks whether the service info on this provider is available or not.
void	kill()	Tries to stop this service like SpecificCloudServiceProvider.stop() but if the service is still running after 5 seconds, it is destroyed forcibly
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Void>	killAsync()	Tries to stop this service like SpecificCloudServiceProvider.stop() but if the service is still running after 5 seconds, it is destroyed forcibly
void	restart()	Stops this service like SpecificCloudServiceProvider.stop() and starts it after it like SpecificCloudServiceProvider.start().
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Void>	restartAsync()	Stops this service like SpecificCloudServiceProvider.stop() and starts it after it like SpecificCloudServiceProvider.start().
void	runCommand(@NotNull java.lang.String command)	Executes the given command in the console of this service if it is running
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Void>	runCommandAsync(@NotNull java.lang.String command)	Executes the given command in the console of this service if it is running
void	setCloudServiceLifeCycle(@NotNull ServiceLifeCycle lifeCycle)	Sets the life cycle of this service and starts, prepares, stops or deletes this service.
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Void>	setCloudServiceLifeCycleAsync(@NotNull ServiceLifeCycle lifeCycle)	Sets the life cycle of this service and starts, prepares, stops or deletes this service

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.dytanic.cloudnet.driver.api.DriverAPIUser

executeChunkedDriverAPIMethod, executeDriverAPIMethod, executeDriverAPIMethod, executeVoidDriverAPIMethod, executeVoidDriverAPIMethod

Methods inherited from interface de.dytanic.cloudnet.driver.provider.service.SpecificCloudServiceProvider

delete, deleteAsync, deployResources, deployResourcesAsync, start, startAsync, stop, stopAsync

Constructor Detail

RemoteSpecificCloudServiceProvider

public RemoteSpecificCloudServiceProvider(INetworkChannel channel,
                                          GeneralCloudServiceProvider provider,
                                          java.util.UUID uniqueId)

RemoteSpecificCloudServiceProvider

public RemoteSpecificCloudServiceProvider(INetworkChannel channel,
                                          GeneralCloudServiceProvider provider,
                                          java.lang.String name)

RemoteSpecificCloudServiceProvider

public RemoteSpecificCloudServiceProvider(INetworkChannel channel,
                                          ServiceInfoSnapshot serviceInfoSnapshot)

Method Detail

getServiceInfoSnapshot

@Nullable
public @Nullable ServiceInfoSnapshot getServiceInfoSnapshot()

Description copied from interface: SpecificCloudServiceProvider

Gets the info of the service this provider is for.

Specified by:

getServiceInfoSnapshot in interface SpecificCloudServiceProvider

Returns:

the info or null, if the service doesn't exist

isValid

public boolean isValid()

Description copied from interface: SpecificCloudServiceProvider

Checks whether the service info on this provider is available or not.

Specified by:

isValid in interface SpecificCloudServiceProvider

Returns:

true if it is or false if not

forceUpdateServiceInfo

@Nullable
public @Nullable ServiceInfoSnapshot forceUpdateServiceInfo()

Description copied from interface: SpecificCloudServiceProvider

Forces this service to update its ServiceInfoSnapshot, instead of SpecificCloudServiceProvider.getServiceInfoSnapshot(), this method always returns the current snapshot with the current e.g. CPU and memory usage.

Specified by:

forceUpdateServiceInfo in interface SpecificCloudServiceProvider

Returns:

the current info or null if the service is not connected

getServiceInfoSnapshotAsync

@NotNull
public @NotNull de.dytanic.cloudnet.common.concurrent.ITask<ServiceInfoSnapshot> getServiceInfoSnapshotAsync()

Description copied from interface: SpecificCloudServiceProvider

Gets the info of the service this provider is for

Specified by:

getServiceInfoSnapshotAsync in interface SpecificCloudServiceProvider

Returns:

the info or null, if the service doesn't exist

isValidAsync

@NotNull
public @NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean> isValidAsync()

Description copied from interface: SpecificCloudServiceProvider

Checks whether the service info on this provider is available or not.

Specified by:

isValidAsync in interface SpecificCloudServiceProvider

Returns:

true if it is or false if not

forceUpdateServiceInfoAsync

@NotNull
public @NotNull de.dytanic.cloudnet.common.concurrent.ITask<ServiceInfoSnapshot> forceUpdateServiceInfoAsync()

Description copied from interface: SpecificCloudServiceProvider

Forces this service to update its ServiceInfoSnapshot, instead of SpecificCloudServiceProvider.getServiceInfoSnapshot(), this method always returns the current snapshot with the current e.g. CPU and memory usage.

Specified by:

forceUpdateServiceInfoAsync in interface SpecificCloudServiceProvider

Returns:

the current info or null if the service is not connected

addServiceTemplate

public void addServiceTemplate(@NotNull
                               @NotNull ServiceTemplate serviceTemplate)

Description copied from interface: SpecificCloudServiceProvider

Adds a service template to this service. This template won't be copied directly after adding it but when the service is prepared.

Specified by:

addServiceTemplate in interface SpecificCloudServiceProvider

Parameters:

serviceTemplate - the template to be added to the list of templates of this service

addServiceTemplateAsync

@NotNull
public @NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Void> addServiceTemplateAsync(@NotNull
                                                                                                    @NotNull ServiceTemplate serviceTemplate)

Description copied from interface: SpecificCloudServiceProvider

Adds a service template to this service. This template won't be copied directly after adding it but when the service is prepared

Specified by:

addServiceTemplateAsync in interface SpecificCloudServiceProvider

Parameters:

serviceTemplate - the template to be added to the list of templates of this service

addServiceRemoteInclusion

public void addServiceRemoteInclusion(@NotNull
                                      @NotNull ServiceRemoteInclusion serviceRemoteInclusion)

Description copied from interface: SpecificCloudServiceProvider

Adds a remote inclusion to this service. This remote inclusion won't be included directly after adding it but when the service is prepared.

Specified by:

addServiceRemoteInclusion in interface SpecificCloudServiceProvider

Parameters:

serviceRemoteInclusion - the inclusion to be added to the list of inclusions of this service

addServiceRemoteInclusionAsync

@NotNull
public @NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Void> addServiceRemoteInclusionAsync(@NotNull
                                                                                                           @NotNull ServiceRemoteInclusion serviceRemoteInclusion)

Description copied from interface: SpecificCloudServiceProvider

Adds a remote inclusion to this service. This remote inclusion won't be included directly after adding it but when the service is prepared

Specified by:

addServiceRemoteInclusionAsync in interface SpecificCloudServiceProvider

Parameters:

serviceRemoteInclusion - the inclusion to be added to the list of inclusions of this service

addServiceDeployment

public void addServiceDeployment(@NotNull
                                 @NotNull ServiceDeployment serviceDeployment)

Description copied from interface: SpecificCloudServiceProvider

Adds a deployment to this service, which will be used when SpecificCloudServiceProvider.deployResources() or SpecificCloudServiceProvider.deployResources(boolean) is called.

Specified by:

addServiceDeployment in interface SpecificCloudServiceProvider

Parameters:

serviceDeployment - the deployment to be added to the list of deployments of this service

addServiceDeploymentAsync

@NotNull
public @NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Void> addServiceDeploymentAsync(@NotNull
                                                                                                      @NotNull ServiceDeployment serviceDeployment)

Description copied from interface: SpecificCloudServiceProvider

Adds a deployment to this service, which will be used when SpecificCloudServiceProvider.deployResources() or SpecificCloudServiceProvider.deployResources(boolean) is called

Specified by:

addServiceDeploymentAsync in interface SpecificCloudServiceProvider

Parameters:

serviceDeployment - the deployment to be added to the list of deployments of this service

getCachedLogMessages

public java.util.Queue<java.lang.String> getCachedLogMessages()

Description copied from interface: SpecificCloudServiceProvider

Gets a queue containing the last messages of this services console. The max size of this queue can be configured in the nodes config.json.

Specified by:

getCachedLogMessages in interface SpecificCloudServiceProvider

Returns:

a queue with the cached messages of this services console

getCachedLogMessagesAsync

@NotNull
public @NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.util.Queue<java.lang.String>> getCachedLogMessagesAsync()

Description copied from interface: SpecificCloudServiceProvider

Gets a queue containing the last messages of this services console. The max size of this queue can be configured in the nodes config.json.

Specified by:

getCachedLogMessagesAsync in interface SpecificCloudServiceProvider

Returns:

a queue with the cached messages of this services console

setCloudServiceLifeCycle

public void setCloudServiceLifeCycle(@NotNull
                                     @NotNull ServiceLifeCycle lifeCycle)

Description copied from interface: SpecificCloudServiceProvider

Sets the life cycle of this service and starts, prepares, stops or deletes this service.

Specified by:

setCloudServiceLifeCycle in interface SpecificCloudServiceProvider

Parameters:

lifeCycle - the lifeCycle to be set

setCloudServiceLifeCycleAsync

@NotNull
public @NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Void> setCloudServiceLifeCycleAsync(@NotNull
                                                                                                          @NotNull ServiceLifeCycle lifeCycle)

Description copied from interface: SpecificCloudServiceProvider

Sets the life cycle of this service and starts, prepares, stops or deletes this service

Specified by:

setCloudServiceLifeCycleAsync in interface SpecificCloudServiceProvider

Parameters:

lifeCycle - the lifeCycle to be set

restart

public void restart()

Description copied from interface: SpecificCloudServiceProvider

Stops this service like SpecificCloudServiceProvider.stop() and starts it after it like SpecificCloudServiceProvider.start().

Specified by:

restart in interface SpecificCloudServiceProvider

restartAsync

@NotNull
public @NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Void> restartAsync()

Description copied from interface: SpecificCloudServiceProvider

Stops this service like SpecificCloudServiceProvider.stop() and starts it after it like SpecificCloudServiceProvider.start().

Specified by:

restartAsync in interface SpecificCloudServiceProvider

kill

public void kill()

Description copied from interface: SpecificCloudServiceProvider

Tries to stop this service like SpecificCloudServiceProvider.stop() but if the service is still running after 5 seconds, it is destroyed forcibly

Specified by:

kill in interface SpecificCloudServiceProvider

killAsync

@NotNull
public @NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Void> killAsync()

Description copied from interface: SpecificCloudServiceProvider

Tries to stop this service like SpecificCloudServiceProvider.stop() but if the service is still running after 5 seconds, it is destroyed forcibly

Specified by:

killAsync in interface SpecificCloudServiceProvider

runCommand

public void runCommand(@NotNull
                       @NotNull java.lang.String command)

Description copied from interface: SpecificCloudServiceProvider

Executes the given command in the console of this service if it is running

Specified by:

runCommand in interface SpecificCloudServiceProvider

Parameters:

command - the command to be executed

runCommandAsync

@NotNull
public @NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Void> runCommandAsync(@NotNull
                                                                                            @NotNull java.lang.String command)

Description copied from interface: SpecificCloudServiceProvider

Executes the given command in the console of this service if it is running

Specified by:

runCommandAsync in interface SpecificCloudServiceProvider

Parameters:

command - the command to be executed

includeWaitingServiceTemplates

public void includeWaitingServiceTemplates()

Description copied from interface: SpecificCloudServiceProvider

Copies all templates of this service into the directory where this service is located in

Specified by:

includeWaitingServiceTemplates in interface SpecificCloudServiceProvider

See Also:

SpecificCloudServiceProvider.addServiceTemplate(ServiceTemplate), SpecificCloudServiceProvider.addServiceTemplateAsync(ServiceTemplate)

includeWaitingServiceInclusions

public void includeWaitingServiceInclusions()

Description copied from interface: SpecificCloudServiceProvider

Copies all inclusions of this service into the directory where this service is located in

Specified by:

includeWaitingServiceInclusions in interface SpecificCloudServiceProvider

See Also:

SpecificCloudServiceProvider.addServiceRemoteInclusion(ServiceRemoteInclusion), SpecificCloudServiceProvider.addServiceRemoteInclusionAsync(ServiceRemoteInclusion)

deployResources

public void deployResources(boolean removeDeployments)

Description copied from interface: SpecificCloudServiceProvider

Writes all deployments to their defined templates of this service.

Specified by:

deployResources in interface SpecificCloudServiceProvider

Parameters:

removeDeployments - whether the deployments should be removed after deploying or not

See Also:

SpecificCloudServiceProvider.addServiceDeployment(ServiceDeployment), SpecificCloudServiceProvider.addServiceDeploymentAsync(ServiceDeployment)

includeWaitingServiceTemplatesAsync

@NotNull
public @NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Void> includeWaitingServiceTemplatesAsync()

Description copied from interface: SpecificCloudServiceProvider

Copies all templates of this service into the directory where this service is located in

Specified by:

includeWaitingServiceTemplatesAsync in interface SpecificCloudServiceProvider

See Also:

SpecificCloudServiceProvider.addServiceTemplate(ServiceTemplate), SpecificCloudServiceProvider.addServiceTemplateAsync(ServiceTemplate)

includeWaitingServiceInclusionsAsync

@NotNull
public @NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Void> includeWaitingServiceInclusionsAsync()

Description copied from interface: SpecificCloudServiceProvider

Copies all inclusions of this service into the directory where this service is located in

Specified by:

includeWaitingServiceInclusionsAsync in interface SpecificCloudServiceProvider

See Also:

SpecificCloudServiceProvider.addServiceRemoteInclusion(ServiceRemoteInclusion), SpecificCloudServiceProvider.addServiceRemoteInclusionAsync(ServiceRemoteInclusion)

deployResourcesAsync

@NotNull
public @NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Void> deployResourcesAsync(boolean removeDeployments)

Description copied from interface: SpecificCloudServiceProvider

Writes all deployments to their defined templates of this service.

Specified by:

deployResourcesAsync in interface SpecificCloudServiceProvider

Parameters:

removeDeployments - whether the deployments should be removed after deploying or not

See Also:

SpecificCloudServiceProvider.addServiceDeployment(ServiceDeployment), SpecificCloudServiceProvider.addServiceDeploymentAsync(ServiceDeployment)

getNetworkChannel

public INetworkChannel getNetworkChannel()

Specified by:

getNetworkChannel in interface DriverAPIUser