Package com.atlassian.bamboo.build.docker

Interface DockerHandler

All Known Implementing Classes:

DefaultDockerHandlerImpl, TestDockerHandler

@ExperimentalApi
public interface DockerHandler

Implementations provide UI options for the Job/Environment Docker tab. Experimental API, work in progress.

Method Summary

Modifier and Type	Method	Description
void	appendConfiguration(BuildConfiguration buildConfiguration, Map<String,Object> webFragmentsContextMap, boolean enabled)
void	disable(BuildDefinition buildDefinition, Job job)	Called for Docker isolation options that were not selected in Job related UIs.
void	disable(Environment environment)	Called for Docker isolation options that were not selected in Environment related UIs.
void	enableAndUpdate(BuildDefinition buildDefinition, Job job, Map<String,Object> webFragmentsContextMap)	Called for the selected Docker isolation option in Job related UIs.
void	enableAndUpdate(Environment environment, Map<String,Object> webFragmentsContextMap)	Called for the selected Docker isolation option in Environment related UIs.
String	getEditHtml()	Renders the edit page.
String	getIsolationType()	Identifier of Docker isolation type.
String	getViewHtml()	Renders the view page.
boolean	isEnabled()	Returns enablement state of the implementation.
ErrorCollection	validateConfig(Map<String,Object> webFragmentsContextMap)	Construct configuration from webFragmentContextMap and validate that the config is valid.

Method Detail

getEditHtml

String getEditHtml()

Renders the edit page.

getViewHtml

String getViewHtml()

Renders the view page.

isEnabled

boolean isEnabled()

Returns enablement state of the implementation. Typically either 0 or 1 of the implementations are enabled.

Returns:

true if enabled.

getIsolationType

String getIsolationType()

Identifier of Docker isolation type.

Returns:

validateConfig

ErrorCollection validateConfig(Map<String,Object> webFragmentsContextMap)

Construct configuration from webFragmentContextMap and validate that the config is valid.

Parameters:

webFragmentsContextMap -

Returns:

enableAndUpdate

void enableAndUpdate(BuildDefinition buildDefinition,
                     Job job,
                     Map<String,Object> webFragmentsContextMap)

Called for the selected Docker isolation option in Job related UIs. The implementation is to construct the object from webFragmentsContextMap and store it in provided buildDefinition that is later stored by the infrastructure.

Parameters:

buildDefinition -

job -

webFragmentsContextMap -

enableAndUpdate

void enableAndUpdate(Environment environment,
                     Map<String,Object> webFragmentsContextMap)

Called for the selected Docker isolation option in Environment related UIs. The implementation is to construct the object from webFragmentsContextMap and save the new values.

Parameters:

environment -

webFragmentsContextMap -

disable

void disable(BuildDefinition buildDefinition,
             Job job)

Called for Docker isolation options that were not selected in Job related UIs. The implementation is to disable itself, perform cleanup of configuration in provided buildDefition object.

Parameters:

buildDefinition -

job -

disable

void disable(Environment environment)

Called for Docker isolation options that were not selected in Environment related UIs.

Parameters:

environment -

appendConfiguration

void appendConfiguration(BuildConfiguration buildConfiguration,
                         Map<String,Object> webFragmentsContextMap,
                         boolean enabled)