Package com.atlassian.bamboo.specs.builders.task

Class AbstractDockerRegistryTask<T extends AbstractDockerRegistryTask<T>>

java.lang.Object

com.atlassian.bamboo.specs.api.builders.EntityPropertiesBuilder<P>

com.atlassian.bamboo.specs.api.builders.task.Task<T,P>

com.atlassian.bamboo.specs.builders.task.AbstractDockerTask<T,DockerRegistryTaskProperties>

com.atlassian.bamboo.specs.builders.task.AbstractDockerRegistryTask<T>

Direct Known Subclasses:

DockerPullImageTask, DockerPushImageTask

public abstract class AbstractDockerRegistryTask<T extends AbstractDockerRegistryTask<T>>
extends AbstractDockerTask<T,DockerRegistryTaskProperties>

Class containing common parts to Docker tasks which operates on Docker registry, like DockerPushImageTask or DockerPullImageTask.

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable String	email
protected @NotNull String	image
protected @Nullable String	password
protected DockerRegistryTaskProperties.RegistryType	registryType
protected @Nullable SharedCredentialsIdentifierProperties	sharedCredentialsIdentifier
protected @Nullable String	username

Fields inherited from class com.atlassian.bamboo.specs.builders.task.AbstractDockerTask

environmentVariables, workingSubdirectory

Fields inherited from class com.atlassian.bamboo.specs.api.builders.task.Task

conditions, description, requirements, taskEnabled

Constructor Summary

Constructors

Constructor	Description
AbstractDockerRegistryTask()

Method Summary

Modifier and Type	Method	Description
T	authentication(@NotNull SharedCredentialsIdentifier sharedCredentialsIdentifier)	Sets authentication settings to authenticate to Docker registry by Shared credentials.
T	authentication(@NotNull String username, @NotNull String password)	Sets authentication settings to authenticate to Docker registry.
T	authentication(@NotNull String username, @NotNull String password, @NotNull String email)	Sets authentication settings to authenticate to Docker registry.
T	customRegistryImage(@NotNull String image)
T	defaultAuthentication()	Use agent's ~/.dockercfg credentials to authenticate to Docker registry.
T	dockerHubImage(@NotNull String image)
boolean	equals(Object o)
int	hashCode()

Methods inherited from class com.atlassian.bamboo.specs.builders.task.AbstractDockerTask

environmentVariables, workingSubdirectory

Methods inherited from class com.atlassian.bamboo.specs.api.builders.task.Task

build, conditions, description, enabled, requirements, toString

Methods inherited from class java.lang.Object

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

Field Detail

image

@NotNull
protected @NotNull String image

registryType

@NotNull
protected DockerRegistryTaskProperties.RegistryType registryType

username

@Nullable
protected @Nullable String username

password

@Nullable
protected @Nullable String password

email

@Nullable
protected @Nullable String email

sharedCredentialsIdentifier

@Nullable
protected @Nullable SharedCredentialsIdentifierProperties sharedCredentialsIdentifier

Constructor Detail

AbstractDockerRegistryTask

public AbstractDockerRegistryTask()

Method Detail

dockerHubImage

public T dockerHubImage(@NotNull
                        @NotNull String image)

customRegistryImage

public T customRegistryImage(@NotNull
                             @NotNull String image)

authentication

public T authentication(@NotNull
                        @NotNull String username,
                        @NotNull
                        @NotNull String password,
                        @NotNull
                        @NotNull String email)

Sets authentication settings to authenticate to Docker registry. All fields are required. You can also use default authentication method by defaultAuthentication()

authentication

public T authentication(@NotNull
                        @NotNull String username,
                        @NotNull
                        @NotNull String password)

Sets authentication settings to authenticate to Docker registry. All fields are required. You can also use default authentication method by defaultAuthentication()

authentication

public T authentication(@NotNull
                        @NotNull SharedCredentialsIdentifier sharedCredentialsIdentifier)

Sets authentication settings to authenticate to Docker registry by Shared credentials.

defaultAuthentication

public T defaultAuthentication()

Use agent's ~/.dockercfg credentials to authenticate to Docker registry.

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractDockerTask<T extends AbstractDockerRegistryTask<T>,DockerRegistryTaskProperties>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDockerTask<T extends AbstractDockerRegistryTask<T>,DockerRegistryTaskProperties>