Class ServiceDeployment

java.lang.Object

eu.cloudnetservice.driver.service.ServiceDeployment

All Implemented Interfaces:

DefaultedDocPropertyHolder, DocPropertyHolder, Cloneable

public class ServiceDeployment
extends Object
implements DefaultedDocPropertyHolder, Cloneable

A deployment for a service. A deployment can be added to any service and will copy the data from the currently running service into the given template, allowing for example cross copy of templates as there is no need for a service to be based on the given template to get copied to it.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServiceDeployment.Builder	A builder for a service deployment.

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
static final Set<Pattern>	DEFAULT_EXCLUSIONS
protected final Collection<Pattern>	excludes
protected final Collection<Pattern>	includes
protected final Document	properties
protected final ServiceTemplate	template

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ServiceDeployment(@NonNull ServiceTemplate template, @NonNull Collection<Pattern> excludes, @NonNull Collection<Pattern> includes, @NonNull Document properties)	Constructs a new service deployment instance.

Method Summary

Modifier and Type	Method	Description
static @NonNull ServiceDeployment.Builder	builder()	Creates a new builder for a service deployment.
static @NonNull ServiceDeployment.Builder	builder(@NonNull ServiceDeployment deployment)	Creates a new builder for a service deployment which has the same properties pre-set as the given deployment instance.
@NonNull ServiceDeployment	clone()
@NonNull Collection<Pattern>	excludes()	Get a collection of file names (in a regular expression format) which should get excluded from a deployment.
@NonNull Collection<Pattern>	includes()	Get a collection of file names (in a regular expression format) which should be included in a deployment.
@NonNull Document	propertyHolder()	Get the underlying document that all read and write operations are delegated to.
@NonNull ServiceTemplate	template()	Get the template to which this deployment (and therefore the service files) should get copied.

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

DEFAULT_EXCLUSIONS

public static final Set<Pattern> DEFAULT_EXCLUSIONS

template

protected final ServiceTemplate template

excludes

protected final Collection<Pattern> excludes

includes

protected final Collection<Pattern> includes

properties

protected final Document properties

Constructor Details

ServiceDeployment

protected ServiceDeployment(@NonNull
 @NonNull ServiceTemplate template,
 @NonNull
 @NonNull Collection<Pattern> excludes,
 @NonNull
 @NonNull Collection<Pattern> includes,
 @NonNull
 @NonNull Document properties)

Constructs a new service deployment instance.

Parameters:

template - the template to deploy the service data to.

excludes - the names of the files to exclude.

properties - the properties for the deployment, not used internally and mainly for identification reasons.

Throws:

NullPointerException - if one of the constructor parameters is null.

Method Details

builder

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

Creates a new builder for a service deployment.

Returns:

a new service deployment builder.

builder

@NonNull
public static @NonNull ServiceDeployment.Builder builder(@NonNull
 @NonNull ServiceDeployment deployment)

Creates a new builder for a service deployment which has the same properties pre-set as the given deployment instance. Changes made to the given deployment will not reflect into the builder and vice-versa.

When calling build directly after creating the builder with this method it will return a service deployment instance which is equal to the given one but not identical.

Parameters:

deployment - the deployment to copy the properties of.

Returns:

a new service builder.

Throws:

NullPointerException - if the given deployment is null.

template

@NonNull
public @NonNull ServiceTemplate template()

Get the template to which this deployment (and therefore the service files) should get copied.

Returns:

the target template of this deployment.

excludes

@NonNull
public @NonNull Collection<Pattern> excludes()

Get a collection of file names (in a regular expression format) which should get excluded from a deployment. Directories must be suffixed with a /.

Returns:

the regular expressions of file names which should get excluded from a deployment.

includes

@NonNull
public @NonNull Collection<Pattern> includes()

Get a collection of file names (in a regular expression format) which should be included in a deployment. Directories must be suffixed with a /.

Returns:

the regular expressions of file names which should be included in a deployment.

clone

@NonNull
public @NonNull ServiceDeployment clone()

Overrides:

clone in class Object

propertyHolder

@NonNull
public @NonNull Document propertyHolder()

Get the underlying document that all read and write operations are delegated to.

Specified by:

propertyHolder in interface DocPropertyHolder

Returns:

the underlying document.