Class GroupConfiguration

java.lang.Object

eu.cloudnetservice.driver.service.ServiceConfigurationBase

eu.cloudnetservice.driver.service.GroupConfiguration

All Implemented Interfaces:

Named, DefaultedDocPropertyHolder, DocPropertyHolder, Cloneable

public class GroupConfiguration
extends ServiceConfigurationBase
implements Cloneable, Named

Represents a group configuration. A group is used to combine multiple tasks and/or environments together and allows including shared jvm options, process parameters, templates, deployments and includes.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GroupConfiguration.Builder	Represents a builder for a group configuration.

Nested classes/interfaces inherited from interface eu.cloudnetservice.driver.document.property.DefaultedDocPropertyHolder

DefaultedDocPropertyHolder.Mutable<S extends DocPropertyHolder.Mutable<S>>

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,String>	environmentVariables
protected final Set<String>	jvmOptions
protected final String	name
protected final Set<String>	processParameters
protected final Set<String>	targetEnvironments

Fields inherited from class eu.cloudnetservice.driver.service.ServiceConfigurationBase

deployments, includes, properties, templates

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GroupConfiguration(@NonNull String name, @NonNull Set<String> jvmOptions, @NonNull Set<String> processParameters, @NonNull Map<String,String> environmentVariables, @NonNull Set<String> targetEnvironments, @NonNull Set<ServiceTemplate> templates, @NonNull Set<ServiceDeployment> deployments, @NonNull Set<ServiceRemoteInclusion> includes, @NonNull Document properties)	Constructs a new group configuration instance.

Method Summary

Modifier and Type	Method	Description
static @NonNull GroupConfiguration.Builder	builder()	Constructs a new builder instance to create a group configuration.
static @NonNull GroupConfiguration.Builder	builder(@NonNull GroupConfiguration group)	Constructs a new builder which inherits the properties of the given group configuration, allowing to change certain properties of a group.
@NonNull GroupConfiguration	clone()
@Unmodifiable @NonNull Map<String,String>	environmentVariables()	Get the environment variables which should get appended to all environments of services which are created based on this configuration.
@Unmodifiable @NonNull Collection<String>	jvmOptions()	Get the jvm options which should get applied to the service command line.
@NonNull String	name()	Get the unique name identifier of this object in the related scope.
@Unmodifiable @NonNull Collection<String>	processParameters()	Get the process parameters which should get appended to the command line.
@Unmodifiable @NonNull Collection<String>	targetEnvironments()	Get the environments to which this group configuration will always be applied, even if the base task of a service does not implement the group directly.

Methods inherited from class eu.cloudnetservice.driver.service.ServiceConfigurationBase

deployments, inclusions, propertyHolder, templates

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.cloudnetservice.driver.document.property.DefaultedDocPropertyHolder

propertyAbsent, propertyPresent, readProperty, readPropertyOrDefault, readPropertyOrGet, readPropertyOrThrow, readPropertyOrThrow

Field Details

name

protected final String name

jvmOptions

protected final Set<String> jvmOptions

processParameters

protected final Set<String> processParameters

environmentVariables

protected final Map<String,String> environmentVariables

targetEnvironments

protected final Set<String> targetEnvironments

Constructor Details

GroupConfiguration

protected GroupConfiguration(@NonNull
 @NonNull String name,
 @NonNull
 @NonNull Set<String> jvmOptions,
 @NonNull
 @NonNull Set<String> processParameters,
 @NonNull
 @NonNull Map<String,String> environmentVariables,
 @NonNull
 @NonNull Set<String> targetEnvironments,
 @NonNull
 @NonNull Set<ServiceTemplate> templates,
 @NonNull
 @NonNull Set<ServiceDeployment> deployments,
 @NonNull
 @NonNull Set<ServiceRemoteInclusion> includes,
 @NonNull
 @NonNull Document properties)

Constructs a new group configuration instance.

Parameters:

name - the name of the group.

jvmOptions - the jvm options of the group to apply to all services inheriting from it.

processParameters - the process parameters of the group to apply to all services inheriting from it.

environmentVariables - the environment variables to apply to all services inheriting from it.

targetEnvironments - the environments to apply this group configuration to.

templates - the templates of the group to apply to all services inheriting from it.

deployments - the deployments of the group to apply to all services inheriting from it.

includes - the includes of the group to apply to all services inheriting from it.

properties - the properties for extra information to store.

Throws:

NullPointerException - if one of the given parameters is null.

Method Details

builder

@NonNull
public static @NonNull GroupConfiguration.Builder builder()

Constructs a new builder instance to create a group configuration.

Returns:

a new builder for a group.

builder

@NonNull
public static @NonNull GroupConfiguration.Builder builder(@NonNull
 @NonNull GroupConfiguration group)

Constructs a new builder which inherits the properties of the given group configuration, allowing to change certain properties of a group. This is useful if you have a group which already exists and just want to change a specific option of it.

Calling the build method right after creating the builder will result in a new group which is identical to the given group.

Parameters:

group - the group to copy the properties of.

Returns:

a new builder which holds the same properties as the given group.

Throws:

NullPointerException - if the given group configuration is null.

name

@NonNull
public @NonNull String name()

Get the unique name identifier of this object in the related scope.

Specified by:

name in interface Named

Returns:

the unique name identifier of this object in the related scope.

jvmOptions

@NonNull
public @Unmodifiable @NonNull Collection<String> jvmOptions()

Get the jvm options which should get applied to the service command line. JVM options are there to configure the behaviour of the jvm, for example the garbage collector.

Specified by:

jvmOptions in class ServiceConfigurationBase

Returns:

the jvm options to set for services created based on this configuration.

processParameters

@NonNull
public @Unmodifiable @NonNull Collection<String> processParameters()

Get the process parameters which should get appended to the command line. Process parameters are there to configure the application, for example setting an option like --online-mode=true.

Specified by:

processParameters in class ServiceConfigurationBase

Returns:

the process parameters to set for services created based on this configuration.

environmentVariables

@NonNull
public @Unmodifiable @NonNull Map<String,String> environmentVariables()

Get the environment variables which should get appended to all environments of services which are created based on this configuration.

Specified by:

environmentVariables in class ServiceConfigurationBase

Returns:

the environment variables to set for services created based on this configuration.

targetEnvironments

@NonNull
public @Unmodifiable @NonNull Collection<String> targetEnvironments()

Get the environments to which this group configuration will always be applied, even if the base task of a service does not implement the group directly. An example use case is a global template which should be applied to all proxies.

Returns:

the environments to apply this group configuration always to.

clone

@NonNull
public @NonNull GroupConfiguration clone()

Overrides:

clone in class Object