com.atlassian.bamboo.plan.artifact

Class ArtifactDefinitionImpl

java.lang.Object

com.atlassian.core.bean.EntityObject

com.atlassian.bamboo.core.BambooEntityObject

com.atlassian.bamboo.core.BambooEntityWithOid

com.atlassian.bamboo.hibernate.HibernateBambooEntityWithOid

com.atlassian.bamboo.plan.artifact.ArtifactDefinitionImpl

All Implemented Interfaces:

BambooIdProvider, BambooObject, EntityWithOid, ImmutableEntityWithOid, ArtifactDefinition, ArtifactDefinitionBase, ImmutableArtifactDefinition, ImmutableArtifactDefinitionBase, NameProvider, Cloneable

@Entity
public class ArtifactDefinitionImpl
extends HibernateBambooEntityWithOid
implements ArtifactDefinition

Constructor Summary

Constructors

Constructor and Description
ArtifactDefinitionImpl()
ArtifactDefinitionImpl(ArtifactDefinition sourceArtifact, Job newProducerJob, boolean sharedArtifact, boolean required, boolean httpCompressionOn) Constructor used for cloning artifact definitions while a job is being cloned.
ArtifactDefinitionImpl(Job producerJob, String name, String location, String copyPattern) Create a build artifact identified in the UI by the label.
ArtifactDefinitionImpl(String name, String location, String copyPattern) Create a build artifact identified in the UI by the label.

Method Summary

Modifier and Type	Method and Description
@NotNull String	getCopyPattern() Get artifact copy pattern
@NotNull List<String>	getCopyPatterns() Get artifact copy patterns
@NotNull List<String>	getExclusionPatterns() Get artifact exclusion patterns
String	getLocation() Get artifact location
@NotNull String	getName() Get artifact name
@NotNull Job	getProducerJob() Get Buildable that is a producer of artifact
@NotNull List<ArtifactSubscription>	getSubscriptions() Get List of ArtifactSubscriptions on this ArtifactDefinition.
boolean	hasSubscriptions()
boolean	isHttpCompressionOn()
boolean	isRequired()
boolean	isSharedArtifact() Get value of "SharedArtifact" flag.
void	setCopyPattern(@NotNull String copyPattern) Set copy pattern
void	setCopyPatterns(@NotNull List<String> copyPatterns) Set copy patterns
void	setExclusionPatterns(@Nullable List<String> exclusionPatterns) Set exclusion patterns
void	setHttpCompressionOn(boolean httpCompressionOn) Sets "httpCompressionOn" flag
void	setLocation(@Nullable String location) Set artifact location
void	setName(@NotNull String name) Set label
void	setProducerJob(@NotNull Job producerJob) Set Buildable that is a producer of artifact
void	setRequired(boolean requiredArtifact)
void	setSharedArtifact(boolean sharedArtifact) Set "SharedArtifact" flag
void	setSubscriptions(@NotNull List<ArtifactSubscription> subscriptions) Set subscriptions on this artifact definition.

Methods inherited from class com.atlassian.bamboo.hibernate.HibernateBambooEntityWithOid

getId, getOid, setId, setOid

Methods inherited from class com.atlassian.core.bean.EntityObject

clone, equals, getCreationDate, getCurrentDate, getLastModificationDate, hashCode, setClock, setCreationDate, setLastModificationDate

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

getEntityType, getId

Methods inherited from interface com.atlassian.bamboo.core.ImmutableEntityWithOid

getOid

Methods inherited from interface com.atlassian.bamboo.core.BambooObject

setId

Methods inherited from interface com.atlassian.bamboo.core.EntityWithOid

setOid

Constructor Detail

ArtifactDefinitionImpl

public ArtifactDefinitionImpl()

ArtifactDefinitionImpl

public ArtifactDefinitionImpl(String name,
                              String location,
                              String copyPattern)

Create a build artifact identified in the UI by the label. We use the Ant style pattern match to identify the files that need to be copies across into the archive repository.

Parameters:

name - The UI text label

location - Directory to which copy pattern applies

copyPattern - The ANT style copy pattern, relative to the source code directory

ArtifactDefinitionImpl

public ArtifactDefinitionImpl(Job producerJob,
                              String name,
                              String location,
                              String copyPattern)

Create a build artifact identified in the UI by the label. We use the Ant style pattern match to identify the files that need to be copies across into the archive repository.

Parameters:

producerJob - producer job

name - The UI text label

location - Directory to which copy pattern applies

copyPattern - The ANT style copy pattern, relative to the source code directory

Since:

5.15

ArtifactDefinitionImpl

public ArtifactDefinitionImpl(ArtifactDefinition sourceArtifact,
                              Job newProducerJob,
                              boolean sharedArtifact,
                              boolean required,
                              boolean httpCompressionOn)

Constructor used for cloning artifact definitions while a job is being cloned. Does not copy subscriptions.

Parameters:

sourceArtifact - artifact definition to be copied

newProducerJob - job that will produce artifacts according to the cloned definition

Method Detail

getCopyPattern

@NotNull
public @NotNull 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
                           @NotNull String copyPattern)

Description copied from interface: ArtifactDefinitionBase

Set copy pattern

Specified by:

setCopyPattern in interface ArtifactDefinitionBase

Parameters:

copyPattern - new value of copy pattern

setCopyPatterns

public void setCopyPatterns(@NotNull
                            @NotNull List<String> copyPatterns)

Description copied from interface: ArtifactDefinitionBase

Set copy patterns

Specified by:

setCopyPatterns in interface ArtifactDefinitionBase

Parameters:

copyPatterns - new copy patterns

getCopyPatterns

@NotNull
public @NotNull List<String> getCopyPatterns()

Description copied from interface: ImmutableArtifactDefinitionBase

Get artifact copy patterns

Specified by:

getCopyPatterns in interface ImmutableArtifactDefinitionBase

Returns:

Ant-compatible copy patterns

getExclusionPatterns

@NotNull
public @NotNull List<String> getExclusionPatterns()

Description copied from interface: ImmutableArtifactDefinitionBase

Get artifact exclusion patterns

Specified by:

getExclusionPatterns in interface ImmutableArtifactDefinitionBase

Returns:

Ant-compatible exclusion patterns

setExclusionPatterns

public void setExclusionPatterns(@Nullable
                                 @Nullable List<String> exclusionPatterns)

Description copied from interface: ArtifactDefinitionBase

Set exclusion patterns

Specified by:

setExclusionPatterns in interface ArtifactDefinitionBase

getName

@NotNull
public @NotNull 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
                    @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
                        @Nullable String location)

Description copied from interface: ArtifactDefinitionBase

Set artifact location

Specified by:

setLocation in interface ArtifactDefinitionBase

Parameters:

location - new artifact location

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

isHttpCompressionOn

public boolean isHttpCompressionOn()

Specified by:

isHttpCompressionOn in interface ImmutableArtifactDefinitionBase

Returns:

true if use of compression enabled to transfer artifact between server and agent (both directions)

setHttpCompressionOn

public void setHttpCompressionOn(boolean httpCompressionOn)

Description copied from interface: ArtifactDefinitionBase

Sets "httpCompressionOn" flag

Specified by:

setHttpCompressionOn in interface ArtifactDefinitionBase

Parameters:

httpCompressionOn - new value of "httpCompressionOn" flag

getProducerJob

@NotNull
public @NotNull Job getProducerJob()

Description copied from interface: ArtifactDefinition

Get Buildable that is a producer of artifact

Specified by:

getProducerJob in interface ArtifactDefinition

Specified by:

getProducerJob in interface ImmutableArtifactDefinition

Returns:

Job object

setProducerJob

public void setProducerJob(@NotNull
                           @NotNull Job producerJob)

Description copied from interface: ArtifactDefinition

Set Buildable that is a producer of artifact

Specified by:

setProducerJob in interface ArtifactDefinition

Parameters:

producerJob - new value of producer job

getSubscriptions

@NotNull
public @NotNull List<ArtifactSubscription> getSubscriptions()

Description copied from interface: ArtifactDefinition

Get List of ArtifactSubscriptions on this ArtifactDefinition.

Specified by:

getSubscriptions in interface ArtifactDefinition

Specified by:

getSubscriptions in interface ImmutableArtifactDefinition

Returns:

List of ArtifactSubscription objects

hasSubscriptions

public boolean hasSubscriptions()

Specified by:

hasSubscriptions in interface ImmutableArtifactDefinition

Returns:

true if this artifact has any subscriptions

setSubscriptions

public void setSubscriptions(@NotNull
                             @NotNull List<ArtifactSubscription> subscriptions)

Description copied from interface: ArtifactDefinition

Set subscriptions on this artifact definition.

Specified by:

setSubscriptions in interface ArtifactDefinition

Parameters:

subscriptions - non null list of ArtifactSubscription objects