com.atlassian.bamboo.plan.artifact

Class ArtifactDefinitionContextImpl

java.lang.Object

com.atlassian.bamboo.plan.artifact.ArtifactDefinitionContextImpl

All Implemented Interfaces:

BambooIdProvider, ImmutableEntityWithOid, ArtifactDefinitionBase, ArtifactDefinitionContext, ImmutableArtifactDefinitionBase, NameProvider, Serializable

public class ArtifactDefinitionContextImpl
extends Object
implements ArtifactDefinitionContext

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ArtifactDefinitionContextImpl(ImmutableArtifactDefinition definition, SecureToken secureToken)
ArtifactDefinitionContextImpl(String name, boolean sharedArtifact, SecureToken secureToken)

Method Summary

Modifier and Type	Method and Description
String	getCopyPattern() Get artifact copy pattern
long	getId() Exposes the id of the ArtifactDefinition
String	getLocation() Get artifact location
String	getName() Get artifact name
BambooEntityOid	getOid() OID assigned to this object.
SecureToken	getSecureToken() The secure token to use for authentication if needed
boolean	hasSubscribers() Marks if there are subscriptions for for this artifact.
boolean	isRequired()
boolean	isSharedArtifact() Get value of "SharedArtifact" flag.
void	setCopyPattern(String copyPattern) Set copy pattern
void	setId(long id)
void	setLocation(String location) Set artifact location
void	setName(String name) Set label
void	setRequired(boolean requiredArtifact)
void	setSharedArtifact(boolean sharedArtifact) Set "SharedArtifact" flag
void	substituteVariables(CustomVariableContext customVariableContext)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.bamboo.plan.artifact.ImmutableArtifactDefinitionBase

getEntityType

Constructor Detail

ArtifactDefinitionContextImpl

public ArtifactDefinitionContextImpl(String name,
                                     boolean sharedArtifact,
                                     @Nullable
                                     SecureToken secureToken)

ArtifactDefinitionContextImpl

public ArtifactDefinitionContextImpl(@NotNull
                                     ImmutableArtifactDefinition definition,
                                     @Nullable
                                     SecureToken secureToken)

Method Detail

getOid

public BambooEntityOid getOid()

Description copied from interface: ImmutableEntityWithOid

OID assigned to this object. The BambooEntityOid.getEntityType() should be the same as this object's ImmutableEntityWithOid.getEntityType().

Specified by:

getOid in interface ImmutableEntityWithOid

getSecureToken

@Nullable
public SecureToken getSecureToken()

Description copied from interface: ArtifactDefinitionContext

The secure token to use for authentication if needed

Specified by:

getSecureToken in interface ArtifactDefinitionContext

substituteVariables

public void substituteVariables(CustomVariableContext customVariableContext)

Specified by:

substituteVariables in interface ArtifactDefinitionContext

getName

@NotNull
public String getName()

Description copied from interface: ImmutableArtifactDefinitionBase

Get artifact name

Specified by:

getName in interface ImmutableArtifactDefinitionBase

Specified by:

getName in interface NameProvider

Returns:

Artifact name

setName

public void setName(@NotNull
                    String name)

Description copied from interface: ArtifactDefinitionBase

Set label

Specified by:

setName in interface ArtifactDefinitionBase

Parameters:

name - new value of label

getLocation

public String getLocation()

Description copied from interface: ImmutableArtifactDefinitionBase

Get artifact location

Specified by:

getLocation in interface ImmutableArtifactDefinitionBase

Returns:

artifact's contents path or null if none specified (then build root is supposed to be used)

setLocation

public void setLocation(@Nullable
                        String location)

Description copied from interface: ArtifactDefinitionBase

Set artifact location

Specified by:

setLocation in interface ArtifactDefinitionBase

Parameters:

location - new artifact location

getCopyPattern

@NotNull
public String getCopyPattern()

Description copied from interface: ImmutableArtifactDefinitionBase

Get artifact copy pattern

Specified by:

getCopyPattern in interface ImmutableArtifactDefinitionBase

Returns:

Ant-compatible copy pattern

setCopyPattern

public void setCopyPattern(@NotNull
                           String copyPattern)

Description copied from interface: ArtifactDefinitionBase

Set copy pattern

Specified by:

setCopyPattern in interface ArtifactDefinitionBase

Parameters:

copyPattern - new value of copy pattern

isSharedArtifact

public boolean isSharedArtifact()

Description copied from interface: ImmutableArtifactDefinitionBase

Get value of "SharedArtifact" flag.

Specified by:

isSharedArtifact in interface ImmutableArtifactDefinitionBase

Returns:

true if ArtifactDefinition is marked as "SharedArtifact"

setSharedArtifact

public void setSharedArtifact(boolean sharedArtifact)

Description copied from interface: ArtifactDefinitionBase

Set "SharedArtifact" flag

Specified by:

setSharedArtifact in interface ArtifactDefinitionBase

Parameters:

sharedArtifact - new value of "SharedArtifact" flag

isRequired

public boolean isRequired()

Specified by:

isRequired in interface ImmutableArtifactDefinitionBase

Returns:

true if artifact is required for successful build completion

setRequired

public void setRequired(boolean requiredArtifact)

Specified by:

setRequired in interface ArtifactDefinitionBase

Parameters:

requiredArtifact - if build should fail if can't publish artifact

hasSubscribers

public boolean hasSubscribers()

Description copied from interface: ArtifactDefinitionContext

Marks if there are subscriptions for for this artifact. If there are subscriptions and artifact is not created/uploaded properly, producer job will fail. Otherwise, plan job will continue

Specified by:

hasSubscribers in interface ArtifactDefinitionContext

Returns:

true if artifact has subscriptions

getId

public long getId()

Description copied from interface: ImmutableArtifactDefinitionBase

Exposes the id of the ArtifactDefinition

Specified by:

getId in interface BambooIdProvider

Specified by:

getId in interface ImmutableArtifactDefinitionBase

Returns:

-1 if the id is unknown

setId

public void setId(long id)

toString

public String toString()

Overrides:

toString in class Object