com.atlassian.bamboo.plan.artifact

Interface ArtifactSubscriptionContext

All Superinterfaces:

Serializable

All Known Implementing Classes:

ArtifactSubscriptionContextImpl

public interface ArtifactSubscriptionContext
extends Serializable

This class holds build-time information on artifact subscription. It's used from BuildContext, transferred to the agent and should not contain any lazily references unresolvable on the agent side.

Method Summary

Modifier and Type	Method and Description
ArtifactDefinitionContext	getArtifactDefinitionContext()
@NotNull String	getDestinationPath()
@NotNull String	getEffectiveDestinationPath()
@NotNull SecureToken	getToken()
@NotNull String	getVariableName()
boolean	isSingleFile()
void	setEffectiveDestinationPath(@NotNull String relativeDestinationPath)
void	setSingleFile(boolean singleFile)
void	substituteVariables(@NotNull CustomVariableContext customVariableContext)

Method Detail

getArtifactDefinitionContext

ArtifactDefinitionContext getArtifactDefinitionContext()

Returns:

representation of transferred artifact

getToken

@NotNull
@NotNull SecureToken getToken()

Returns:

secure token used for artifact transfer

getDestinationPath

@NotNull
@NotNull String getDestinationPath()

Returns:

path to artifact as defined in ArtifactSubscription

getVariableName

@NotNull
@NotNull String getVariableName()

Returns:

name of the variable which contains artifact path

isSingleFile

boolean isSingleFile()

Returns:

true iff artifact is a single file

setSingleFile

void setSingleFile(boolean singleFile)

getEffectiveDestinationPath

@NotNull
@NotNull String getEffectiveDestinationPath()

Returns:

actual path to artifact

setEffectiveDestinationPath

void setEffectiveDestinationPath(@NotNull
                                 @NotNull String relativeDestinationPath)

substituteVariables

void substituteVariables(@NotNull
                         @NotNull CustomVariableContext customVariableContext)