Package com.atlassian.bamboo.build.docker

Class DockerPipelineConfigurationImpl

java.lang.Object

com.atlassian.bamboo.build.docker.DockerPipelineConfigurationImpl

All Implemented Interfaces:

DockerPipelineConfiguration, ConvertibleFromConfig, OptionallyConvertibleFromConfig

public class DockerPipelineConfigurationImpl
extends Object
implements DockerPipelineConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DockerPipelineConfigurationImpl.ConfigFields

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_FIELD_PREFIX
static final String	PROGRAM_ARGUMENT

Constructor Summary

Constructors

Constructor	Description
DockerPipelineConfigurationImpl()
DockerPipelineConfigurationImpl(@NotNull DockerPipelineConfiguration dockerPipelineConfiguration)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@NotNull List<String>	getAdditionalArgs()	Additional arguments for docker command.
@NotNull List<DataVolume>	getDataVolumes()	List of data volume mapping between host and container.
@Nullable String	getImage()	Docker image to be used for the Docker pipeline.
int	hashCode()
boolean	isEnabled()	Whether the Docker pipeline is enabled.
boolean	isValid()	Is the object state valid after it has been initialised from properties.
void	populateFromConfig(@NotNull org.apache.commons.configuration.HierarchicalConfiguration config)	Update the current object with data in the HierarchicalConfiguration
void	setAdditionalArgs(@NotNull Iterable<String> additionalArgs)
void	setDataVolumes(@NotNull Iterable<DataVolume> dataVolumes)
void	setEnabled(boolean enabled)
void	setImage(String image)
@NotNull org.apache.commons.configuration.HierarchicalConfiguration	toConfiguration()	Generate a HierarchicalConfiguration from the current state of the object
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

CONFIG_FIELD_PREFIX

public static final String CONFIG_FIELD_PREFIX

PROGRAM_ARGUMENT

public static final String PROGRAM_ARGUMENT

See Also:

• Constant Field Values

Constructor Details

DockerPipelineConfigurationImpl

public DockerPipelineConfigurationImpl()

DockerPipelineConfigurationImpl

public DockerPipelineConfigurationImpl(@NotNull
 @NotNull DockerPipelineConfiguration dockerPipelineConfiguration)

Method Details

populateFromConfig

public void populateFromConfig(@NotNull
 @NotNull org.apache.commons.configuration.HierarchicalConfiguration config)

Description copied from interface: ConvertibleFromConfig

Update the current object with data in the HierarchicalConfiguration

Specified by:

populateFromConfig in interface ConvertibleFromConfig

toConfiguration

@NotNull
public @NotNull org.apache.commons.configuration.HierarchicalConfiguration toConfiguration()

Description copied from interface: ConvertibleFromConfig

Generate a HierarchicalConfiguration from the current state of the object

Specified by:

toConfiguration in interface ConvertibleFromConfig

Returns:

Always returns an HierarchicalConfiguration. Never null

isValid

public boolean isValid()

Description copied from interface: OptionallyConvertibleFromConfig

Is the object state valid after it has been initialised from properties.

Specified by:

isValid in interface OptionallyConvertibleFromConfig

Returns:

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isEnabled

public boolean isEnabled()

Description copied from interface: DockerPipelineConfiguration

Whether the Docker pipeline is enabled.

Specified by:

isEnabled in interface DockerPipelineConfiguration

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface DockerPipelineConfiguration

getImage

@Nullable
public @Nullable String getImage()

Description copied from interface: DockerPipelineConfiguration

Docker image to be used for the Docker pipeline. The value can be any valid image identifier accepted by Docker, in particular it can consist of registry information, namespace, image name and tag name.

Example: localhost:5000/atlassian/docker-image:version-5

Specified by:

getImage in interface DockerPipelineConfiguration

setImage

public void setImage(String image)

Specified by:

setImage in interface DockerPipelineConfiguration

getDataVolumes

@NotNull
public @NotNull List<DataVolume> getDataVolumes()

Description copied from interface: DockerPipelineConfiguration

List of data volume mapping between host and container.

Specified by:

getDataVolumes in interface DockerPipelineConfiguration

setDataVolumes

public void setDataVolumes(@NotNull
 @NotNull Iterable<DataVolume> dataVolumes)

Specified by:

setDataVolumes in interface DockerPipelineConfiguration

getAdditionalArgs

@NotNull
public @NotNull List<String> getAdditionalArgs()

Description copied from interface: DockerPipelineConfiguration

Additional arguments for docker command.

Specified by:

getAdditionalArgs in interface DockerPipelineConfiguration

setAdditionalArgs

@NotNull
public void setAdditionalArgs(@NotNull
 @NotNull Iterable<String> additionalArgs)

Specified by:

setAdditionalArgs in interface DockerPipelineConfiguration