Package com.atlassian.bamboo.build.docker

Interface DockerHandlerProvider

All Superinterfaces:

BambooPluginModule, InitablePluginModule<DockerHandlerModuleDescriptor>

All Known Implementing Classes:

DefaultDockerHandlerProvider, TestDockerHandlerProvider

@ExperimentalApi
public interface DockerHandlerProvider
extends InitablePluginModule<DockerHandlerModuleDescriptor>

Experimental API, work in progress.

Method Summary

Modifier and Type	Method	Description
default @Nullable String	getEnvironmentConfigurationKey()	Returns custom handler provider key.
DockerHandler	getHandler(@NotNull Map<String,Object> webFragmentsContextMap, boolean create)
DockerHandler	getHandler(@Nullable BuildDefinition job, boolean create)
DockerHandler	getHandler(@Nullable Environment environment, boolean create)
String	getIsolationType()
String	getIsolationTypeLabel(com.opensymphony.xwork2.TextProvider textProvider)
default boolean	isCustomDedicatedAgentExpected(@NotNull BuildDefinition buildDefinition)	If an environment is configured by this plugin to use ephemeral agents.
default boolean	isCustomDedicatedAgentExpected(@NotNull Map<String,String> environmentCustomConfig)	If an environment is configured by this plugin to use ephemeral agents.

Methods inherited from interface com.atlassian.bamboo.plugin.InitablePluginModule

init

Method Detail

getIsolationType

String getIsolationType()

getIsolationTypeLabel

String getIsolationTypeLabel(com.opensymphony.xwork2.TextProvider textProvider)

getHandler

DockerHandler getHandler(@Nullable
                         @Nullable BuildDefinition job,
                         boolean create)

getHandler

DockerHandler getHandler(@Nullable
                         @Nullable Environment environment,
                         boolean create)

getHandler

DockerHandler getHandler(@NotNull
                         @NotNull Map<String,Object> webFragmentsContextMap,
                         boolean create)

isCustomDedicatedAgentExpected

default boolean isCustomDedicatedAgentExpected(@NotNull
                                               @NotNull BuildDefinition buildDefinition)

If an environment is configured by this plugin to use ephemeral agents.

isCustomDedicatedAgentExpected

default boolean isCustomDedicatedAgentExpected(@NotNull
                                               @NotNull Map<String,String> environmentCustomConfig)

If an environment is configured by this plugin to use ephemeral agents. The passed configuration won't be null, but it can be empty.

getEnvironmentConfigurationKey

@Nullable
default @Nullable String getEnvironmentConfigurationKey()

Returns custom handler provider key. Could be used if it differs from