Package com.atlassian.bamboo.build

Class DefaultJob

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.AbstractPlan

com.atlassian.bamboo.build.DefaultJob

All Implemented Interfaces:

Buildable, Job, BambooIdProvider, BambooObject, BambooObjectWithOid, EntityWithOid, ImmutableEntityWithOid, Deletable, Describable, ImmutableBuildable, ImmutableDeletable, ImmutableJob, ImmutablePlan, Plan, PlanIdentifier, PlanKeyProvider, TaskContainer, DescriptionProvider, NameProvider, Versionable, VersionedEntityComponent<Chain>, Cloneable, Comparable<Plan>

@Entity
public class DefaultJob
extends AbstractPlan
implements Job, Buildable

Field Summary

Fields

Modifier and Type	Field	Description
static final int	NUMBER_OF_RESULTS

Fields inherited from class com.atlassian.bamboo.plan.AbstractPlan

internalResultsSummaryAccessor

Fields inherited from interface com.atlassian.bamboo.plan.cache.ImmutablePlan

MAX_PREVIOUS_BUILD_FOR_AVE, STATUS_CURRENTLY_BUILDING, STATUS_FAIL, STATUS_NO_BUILDS, STATUS_NOT_RUN, STATUS_SUCCESS

Fields inherited from interface com.atlassian.bamboo.plan.PlanIdentifier

NAME_DELIMITER

Fields inherited from interface com.atlassian.bamboo.plan.PlanKeyProvider

getPlanKey

Constructor Summary

Constructors

Constructor	Description
DefaultJob()

Method Summary

Modifier and Type	Method	Description
@NotNull List<ArtifactDefinition>	getArtifactDefinitions()
@NotNull List<ArtifactSubscription>	getArtifactSubscriptions()
long	getAverageBuildDuration()	Returns an average duration of the recent builds
@NotNull String	getCurrentStatus()
@NotNull RequirementSet	getEffectiveRequirementSet()	Return effective value of RequirementSet, that is value that is considered when checking which agents, elastic images and ephemeral templates can build this Buildable.
Job	getMaster()	Return the master plan if one exists.
@NotNull String	getName()	Returns the full name for the build in the form of "project name - build name" e.g.
@NotNull Chain	getParent()	The Chain that this Job is a member of
@NotNull PlanType	getPlanType()
@NotNull RequirementSet	getRequirementSet()
@Nullable Chain	getRoot()	Returns the versioned root of the object.
@NotNull ChainStage	getStage()	The ChainStage that this Job is a member of
@NotNull List<TaskDefinition>	getTaskDefinitions()
boolean	isActive()	Is the plan queued or building?
boolean	isDivergent()	Is part of divergent branch.
boolean	isExecuting()	Is the build currently being executed?
void	setArtifactDefinitionManager(ArtifactDefinitionManager artifactDefinitionManager)
void	setArtifactSubscriptionManager(ArtifactSubscriptionManager artifactSubscriptionManager)
void	setBuildExecutionManager(BuildExecutionManager buildExecutionManager)
void	setMaster(Plan master)	Set which plan is the master of this plan.
void	setRequirementSet(RequirementSet requirementSet)
void	setStage(@Nullable ChainStage chainStage)

Methods inherited from class com.atlassian.bamboo.plan.AbstractPlan

compareTo, equals, getBuildDefinition, getBuildDefinitionXml, getBuildKey, getBuildLogger, getBuildName, getDatabaseId, getDescription, getDiscriminator, getEffectiveVariables, getFirstBuildNumber, getKey, getLabellings, getLabelNames, getLastBuildNumber, getLatestResultsSummary, getMasterId, getMasterIdIfExists, getPlanKey, getProject, getRelatedLabellings, getType, getVariables, getVersion, hashCode, hasMaster, isBusy, isMarkedForDeletion, isSuspendedFromBuilding, setBuildDefinitionManager, setBuildDefinitionXml, setBuildKey, setBuildLoggerManager, setBuildName, setDescription, setDiscriminator, setInternalResultsSummaryAccessor, setKey, setLabellings, setLabelManager, setMarkedForDeletion, setName, setPlanExecutionManager, setPlanKey, setProject, setSuspendedFromBuilding, setVariableDefinitionManager, setVersion

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

getId, getOid, setId, setOid

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

clone, getCreationDate, getCurrentDate, getLastModificationDate, 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.core.BambooObject

setId

Methods inherited from interface com.atlassian.bamboo.deletion.Deletable

setMarkedForDeletion

Methods inherited from interface com.atlassian.bamboo.Describable

setDescription, setName

Methods inherited from interface com.atlassian.bamboo.utils.DescriptionProvider

getDescription

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

setOid

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

getOid

Methods inherited from interface com.atlassian.bamboo.plan.cache.ImmutableJob

getEntityType

Methods inherited from interface com.atlassian.bamboo.plan.cache.ImmutablePlan

getBuildDefinition, getBuildLogger, getEffectiveVariables, getFirstBuildNumber, getKey, getLabelNames, getLastBuildNumber, getProject, getType, getVariables, hasMaster, isBusy, isMarkedForDeletion

Methods inherited from interface com.atlassian.bamboo.plan.Plan

getBuildDefinitionXml, getLabellings, getLatestResultsSummary, getRelatedLabellings, setBuildDefinitionXml, setBuildKey, setBuildName, setKey, setLabellings, setPlanKey, setProject, setSuspendedFromBuilding

Methods inherited from interface com.atlassian.bamboo.plan.PlanIdentifier

getBuildKey, getBuildName, getDatabaseId, getId, getMasterId, getMasterIdIfExists, getPlanKey, isSuspendedFromBuilding

Methods inherited from interface com.atlassian.bamboo.versioning.Versionable

getVersion

Field Details

NUMBER_OF_RESULTS

public static final int NUMBER_OF_RESULTS

See Also:

• Constant Field Values

Constructor Details

DefaultJob

public DefaultJob()

Method Details

getTaskDefinitions

@NotNull
public @NotNull List<TaskDefinition> getTaskDefinitions()

Specified by:

getTaskDefinitions in interface TaskContainer

Returns:

an ordered list of taskDefinitions for this container.

getPlanType

@NotNull
public @NotNull PlanType getPlanType()

Specified by:

getPlanType in interface PlanIdentifier

Returns:

the type of this plan

getName

@NotNull
public @NotNull String getName()

Description copied from interface: PlanIdentifier

Returns the full name for the build in the form of "project name - build name" e.g. "Confluence - HEAD"

Specified by:

getName in interface DescriptionProvider

Specified by:

getName in interface NameProvider

Specified by:

getName in interface PlanIdentifier

Overrides:

getName in class AbstractPlan

Returns:

String

getParent

@NotNull
public @NotNull Chain getParent()

Description copied from interface: Job

The Chain that this Job is a member of

Specified by:

getParent in interface ImmutableJob

Specified by:

getParent in interface Job

Returns:

chain

getStage

@NotNull
public @NotNull ChainStage getStage()

Description copied from interface: Job

The ChainStage that this Job is a member of

Specified by:

getStage in interface ImmutableJob

Specified by:

getStage in interface Job

Returns:

stage

setStage

public void setStage(@Nullable
 @Nullable ChainStage chainStage)

Specified by:

setStage in interface Job

getMaster

public Job getMaster()

Description copied from interface: ImmutablePlan

Return the master plan if one exists. The master is the plan which this one is derived from. Configuration is pulled from the master if one exists.

Specified by:

getMaster in interface ImmutableJob

Specified by:

getMaster in interface ImmutablePlan

Specified by:

getMaster in interface Job

Returns:

the master Plan if one exists.

setMaster

public void setMaster(Plan master)

Description copied from interface: Plan

Set which plan is the master of this plan. The master is the plan which this one is derived from. Configuration is pulled from the master if one exists.

Specified by:

setMaster in interface Plan

isActive

public boolean isActive()

Description copied from interface: ImmutablePlan

Is the plan queued or building?

Specified by:

isActive in interface ImmutablePlan

getCurrentStatus

@NotNull
public @NotNull String getCurrentStatus()

Specified by:

getCurrentStatus in interface ImmutablePlan

Returns:

a string key as to what the status is. Can be "success", "failure", "current", "none" or "notRun". Mainly used for UI purposes.

isExecuting

public boolean isExecuting()

Description copied from interface: ImmutablePlan

Is the build currently being executed?

Specified by:

isExecuting in interface ImmutablePlan

Returns:

true if build is being executed

getArtifactDefinitions

@NotNull
public @NotNull List<ArtifactDefinition> getArtifactDefinitions()

Specified by:

getArtifactDefinitions in interface ImmutableJob

Specified by:

getArtifactDefinitions in interface Job

Returns:

list of produced artifacts

getArtifactSubscriptions

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

Specified by:

getArtifactSubscriptions in interface ImmutableJob

Specified by:

getArtifactSubscriptions in interface Job

Returns:

list of artifact subscriptions

getAverageBuildDuration

public long getAverageBuildDuration()

Description copied from interface: ImmutablePlan

Returns an average duration of the recent builds

Specified by:

getAverageBuildDuration in interface ImmutablePlan

Returns:

The duration in milliseconds

getRequirementSet

@NotNull
public @NotNull RequirementSet getRequirementSet()

Specified by:

getRequirementSet in interface ImmutableBuildable

Specified by:

getRequirementSet in interface ImmutableJob

setRequirementSet

public void setRequirementSet(RequirementSet requirementSet)

Specified by:

setRequirementSet in interface Buildable

getEffectiveRequirementSet

@NotNull
public @NotNull RequirementSet getEffectiveRequirementSet()

Description copied from interface: ImmutableBuildable

Return effective value of RequirementSet, that is value that is considered when checking which agents, elastic images and ephemeral templates can build this Buildable.

Specified by:

getEffectiveRequirementSet in interface ImmutableBuildable

Specified by:

getEffectiveRequirementSet in interface ImmutableJob

Returns:

the same as ImmutableBuildable.getRequirementSet() if ImmutablePlan.hasMaster() is false, getMaster().getRequirementSet() otherwise.

setBuildExecutionManager

public void setBuildExecutionManager(BuildExecutionManager buildExecutionManager)

setArtifactDefinitionManager

public void setArtifactDefinitionManager(ArtifactDefinitionManager artifactDefinitionManager)

setArtifactSubscriptionManager

public void setArtifactSubscriptionManager(ArtifactSubscriptionManager artifactSubscriptionManager)

isDivergent

public boolean isDivergent()

Description copied from interface: ImmutableJob

Is part of divergent branch.

Specified by:

isDivergent in interface ImmutableJob

getRoot

@Nullable
public @Nullable Chain getRoot()

Description copied from interface: VersionedEntityComponent

Returns the versioned root of the object.

Specified by:

getRoot in interface VersionedEntityComponent<Chain>

Returns:

the root of the object