Class CloudServiceConfigurationPrePrepareEvent

java.lang.Object

eu.cloudnetservice.driver.event.Event

eu.cloudnetservice.node.event.service.CloudServiceConfigurationPrePrepareEvent

public final class CloudServiceConfigurationPrePrepareEvent
extends eu.cloudnetservice.driver.event.Event

An event that is called before the actual preparation (setting the service id, including group templates etc.) of a service configuration is done. This event is called in the last stage before the service gets created. The configuration can still be modified without the risk of causing configuration issues.

Note that this event is only called on the head node, as no other node is allowed to start services nor prepare the configuration for them.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private final CloudServiceManager	cloudServiceManager
private final eu.cloudnetservice.driver.service.ServiceConfiguration.Builder	modifiableConfiguration
private final eu.cloudnetservice.driver.service.ServiceConfiguration	originalConfiguration

Constructor Summary

Constructors

Constructor	Description
CloudServiceConfigurationPrePrepareEvent(@NonNull CloudServiceManager cloudServiceManager, @NonNull eu.cloudnetservice.driver.service.ServiceConfiguration originalConfiguration, eu.cloudnetservice.driver.service.ServiceConfiguration.Builder modifiableConfiguration)	Constructs a new cloud service configuration pre-prepare event instance.

Method Summary

Modifier and Type	Method	Description
@NonNull CloudServiceManager	cloudServiceManager()	Get the service manager that will keep track of the service after creation.
eu.cloudnetservice.driver.service.ServiceConfiguration.Builder	modifiableConfiguration()	Get a modifiable version of the original service configuration.
@NonNull eu.cloudnetservice.driver.service.ServiceConfiguration	originalConfiguration()	Get the original, unmodifiable version of the service configuration which was passed in to create a service from.

Methods inherited from class Object

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

Field Details

cloudServiceManager

private final CloudServiceManager cloudServiceManager

originalConfiguration

private final eu.cloudnetservice.driver.service.ServiceConfiguration originalConfiguration

modifiableConfiguration

private final eu.cloudnetservice.driver.service.ServiceConfiguration.Builder modifiableConfiguration

Constructor Details

CloudServiceConfigurationPrePrepareEvent

public CloudServiceConfigurationPrePrepareEvent(@NonNull
 @NonNull CloudServiceManager cloudServiceManager,
 @NonNull
 @NonNull eu.cloudnetservice.driver.service.ServiceConfiguration originalConfiguration,
 @NonNull
 eu.cloudnetservice.driver.service.ServiceConfiguration.Builder modifiableConfiguration)

Constructs a new cloud service configuration pre-prepare event instance.

Parameters:

cloudServiceManager - the service manager which will keep track of the service after the creation.

originalConfiguration - the configuration on which basis the service should get created.

modifiableConfiguration - a modifiable copy of the original configuration with no changes applied.

Throws:

NullPointerException - if the given service manager, original or modifiable configuration is null.

Method Details

cloudServiceManager

@NonNull
public @NonNull CloudServiceManager cloudServiceManager()

Get the service manager that will keep track of the service after creation.

Returns:

the service manager that will keep track of the service after creation.

originalConfiguration

@NonNull
public @NonNull eu.cloudnetservice.driver.service.ServiceConfiguration originalConfiguration()

Get the original, unmodifiable version of the service configuration which was passed in to create a service from.

Returns:

the original service configuration passed to create the service.

modifiableConfiguration

@NonNull
public eu.cloudnetservice.driver.service.ServiceConfiguration.Builder modifiableConfiguration()

Get a modifiable version of the original service configuration. Changes made to the configuration will reflect into the service creation process and take effect immediately.

Returns:

a modifiable copy of the original configuration which allows changes to be applied to it.