com.atlassian.bamboo.plan.artifact

Interface ArtifactSubscriptionManager

All Known Implementing Classes:

ArtifactSubscriptionManagerImpl

@PublicApi
public interface ArtifactSubscriptionManager

Field Summary

Fields

Modifier and Type	Field and Description
static String	BAMBOO_ARTIFACTS_PATH_VARIABLE

Method Summary

Modifier and Type	Method and Description
List<ArtifactSubscription>	findCurrentSubscriptionsForPlan(ImmutableJob producerJob) Get list of subscriptions existing in a chain for given artifact
ArtifactSubscription	findSubscription(long id) Get artifact definition of specified id
List<ArtifactSubscription>	findSubscriptionsOfPlan(PlanIdentifier plan) Get list of artifact subscriptions associated with a plan
List<ArtifactDefinition>	findSubscriptionsPossibleForPlan(ImmutableJob job) Get list of chain level artifacts available for specified plan
com.google.common.collect.Multimap<ResultsSummary,ConsumedSubscription>	getConsumedSubscriptions(ResultsSummary resultsSummary) Returns list of ConsumedSubscription ordered by order of ResultsSummary execution.
boolean	isSubscriptionsValid(Job consumer, Chain chain, String stageName) Shorter for of validateSubscriptions method
List<ArtifactDefinitionContext>	prepareArtifactDefinitionContexts(ImmutableJob job, BuildContext buildContext, SecureToken secureToken) Helps prepare the artifact definitions
List<ArtifactSubscriptionContext>	prepareSubscriptionContexts(ImmutableJob job, BuildContext parentBuildContext, SecureToken secureToken)
void	removeArtifactSubscription(ArtifactSubscription artifactSubscription) Remove artifact subscription.
void	removeArtifactSubscriptions(Collection<ArtifactSubscription> artifactSubscriptions) Remove all artifact subscriptions in the collection.
void	removeArtifactSubscriptionsOfPlan(ImmutablePlan plan) Remove all artifact subscriptions for a plan
void	removeArtifactSubscriptionsOfPlan(Plan plan) Deprecated. since 6.2 use removeArtifactSubscriptionsOfPlan(ImmutablePlan) instead
void	saveArtifactSubscription(ArtifactSubscription artifactSubscription) Save artifact subscription.
void	saveArtifactSubscriptions(Collection<ArtifactSubscription> artifactSubscriptions) Save all artifact definitions in a collection.
void	saveConsumedSubscription(ArtifactSubscriptionContext artifactSubscription, PlanResultKey planResultKey) Deprecated. since 4.4 use saveConsumedSubscription(ArtifactSubscriptionContext, com.atlassian.bamboo.plan.PlanResultKey, String)
void	saveConsumedSubscription(ArtifactSubscriptionContext artifactSubscription, PlanResultKey planResultKey, String artifactLinkType) Store consumed subscription.
List<ArtifactSubscriptionSubstitutionAware>	transformSubscriptions(List<ArtifactSubscription> subscriptions)
List<ArtifactSubscription>	validateSubscribersForMovedJob(ImmutableJob producer, ImmutableChainStage producerStage) Validate all consumer artifact subscriptions to the artifacts produced by a Job against target stage
List<ArtifactSubscription>	validateSubscriptions(ImmutableJob consumer, ImmutableChain chain, String stageName) Validate consumer artifact subscriptions against target chain and stage
List<ArtifactSubscription>	validateSubscriptionsForMovedJob(ImmutableJob job, ImmutableChainStage targetStage) Validate all artifact subscriptions possibly affected by moving a job.
List<ArtifactSubscription>	validateSubscriptionsForMovedStage(ImmutableChainStage stage, int stageIndex) Validates all artifact subscriptions possibly affected by moving a stage.

Field Detail

BAMBOO_ARTIFACTS_PATH_VARIABLE

static final String BAMBOO_ARTIFACTS_PATH_VARIABLE

See Also:

Constant Field Values

Method Detail

findSubscription

@Nullable
ArtifactSubscription findSubscription(long id)

Get artifact definition of specified id

Parameters:

id - id of artifact subscription

Returns:

artifact definition of specified id or null if not found

findSubscriptionsOfPlan

@NotNull
List<ArtifactSubscription> findSubscriptionsOfPlan(@NotNull
                                                            PlanIdentifier plan)

Get list of artifact subscriptions associated with a plan

Parameters:

plan - plan which associated artifact subscriptions should be retrieved

Returns:

list of artifact subscriptions

findSubscriptionsPossibleForPlan

@NotNull
List<ArtifactDefinition> findSubscriptionsPossibleForPlan(@NotNull
                                                                   ImmutableJob job)

Get list of chain level artifacts available for specified plan

Parameters:

job -

Returns:

list of available artifact definitions

findCurrentSubscriptionsForPlan

@NotNull
List<ArtifactSubscription> findCurrentSubscriptionsForPlan(@NotNull
                                                                    ImmutableJob producerJob)

Get list of subscriptions existing in a chain for given artifact

Parameters:

producerJob -

Returns:

list of artifact subscriptions

prepareSubscriptionContexts

@NotNull
List<ArtifactSubscriptionContext> prepareSubscriptionContexts(@NotNull
                                                                       ImmutableJob job,
                                                                       @NotNull
                                                                       BuildContext parentBuildContext,
                                                                       SecureToken secureToken)

Parameters:

job -

parentBuildContext -

secureToken -

Returns:

removeArtifactSubscription

void removeArtifactSubscription(@NotNull
                                ArtifactSubscription artifactSubscription)

Remove artifact subscription.

Parameters:

artifactSubscription - ArtifactSubscription to be removed

removeArtifactSubscriptions

void removeArtifactSubscriptions(@NotNull
                                 Collection<ArtifactSubscription> artifactSubscriptions)

Remove all artifact subscriptions in the collection.

Parameters:

artifactSubscriptions - collection of ArtifactSubscription to be removed

removeArtifactSubscriptionsOfPlan

@Deprecated
void removeArtifactSubscriptionsOfPlan(@NotNull
                                                   Plan plan)

Deprecated. since 6.2 use removeArtifactSubscriptionsOfPlan(ImmutablePlan) instead

Remove all artifact subscriptions for a plan

removeArtifactSubscriptionsOfPlan

void removeArtifactSubscriptionsOfPlan(@NotNull
                                       ImmutablePlan plan)

Remove all artifact subscriptions for a plan

saveArtifactSubscription

void saveArtifactSubscription(@NotNull
                              ArtifactSubscription artifactSubscription)

Save artifact subscription.

Parameters:

artifactSubscription - object to be saved

saveArtifactSubscriptions

void saveArtifactSubscriptions(@NotNull
                               Collection<ArtifactSubscription> artifactSubscriptions)

Save all artifact definitions in a collection.

Parameters:

artifactSubscriptions - collection of objects to be saved/updated

validateSubscriptions

@NotNull
List<ArtifactSubscription> validateSubscriptions(@NotNull
                                                          ImmutableJob consumer,
                                                          @NotNull
                                                          ImmutableChain chain,
                                                          @NotNull
                                                          String stageName)

Validate consumer artifact subscriptions against target chain and stage

Parameters:

consumer - job being consumer of artifact definitions

chain - target chain

stageName - target stage

Returns:

list of subscriptions that NOT satisfy

validateSubscribersForMovedJob

@NotNull
List<ArtifactSubscription> validateSubscribersForMovedJob(@NotNull
                                                                   ImmutableJob producer,
                                                                   @NotNull
                                                                   ImmutableChainStage producerStage)

Validate all consumer artifact subscriptions to the artifacts produced by a Job against target stage

Parameters:

producer - job being producer of the artifacts

producerStage - target stage

Returns:

list of subscriptions that NOT satisfy

validateSubscriptionsForMovedJob

@NotNull
List<ArtifactSubscription> validateSubscriptionsForMovedJob(@NotNull
                                                                     ImmutableJob job,
                                                                     @NotNull
                                                                     ImmutableChainStage targetStage)

Validate all artifact subscriptions possibly affected by moving a job. Artifact subscriptions will be broken if the producer is moved down, or if the consumer is moved up. This validation will return all artifact subscriptions that will be broken.

Parameters:

job - job being moved

targetStage - target stage

Returns:

list of ArtifactSubscription that won't qualify after the move

validateSubscriptionsForMovedStage

@NotNull
List<ArtifactSubscription> validateSubscriptionsForMovedStage(@NotNull
                                                                       ImmutableChainStage stage,
                                                                       int stageIndex)

Validates all artifact subscriptions possibly affected by moving a stage. Artifact subscriptions will be broken if the producer is moved down, or if the consumer is moved up. This validation will return all artifact subscriptions that will be broken.

Parameters:

stage - stage being moved

stageIndex - target stage index

Returns:

list of ArtifactSubscription that won't qualify after the move

isSubscriptionsValid

boolean isSubscriptionsValid(@NotNull
                             Job consumer,
                             @NotNull
                             Chain chain,
                             @NotNull
                             String stageName)

Shorter for of validateSubscriptions method

Parameters:

consumer - job being consumer of artifact definitions

chain - target chain

stageName - target stage

Returns:

true if all subscriptions are valid

saveConsumedSubscription

void saveConsumedSubscription(@NotNull
                              ArtifactSubscriptionContext artifactSubscription,
                              @NotNull
                              PlanResultKey planResultKey,
                              @NotNull
                              String artifactLinkType)

Store consumed subscription. Method should be called when artifacts are physically transferred to the agent

Parameters:

artifactSubscription -

planResultKey -

saveConsumedSubscription

@Deprecated
void saveConsumedSubscription(@NotNull
                                          ArtifactSubscriptionContext artifactSubscription,
                                          @NotNull
                                          PlanResultKey planResultKey)

Deprecated. since 4.4 use saveConsumedSubscription(ArtifactSubscriptionContext, com.atlassian.bamboo.plan.PlanResultKey, String)

Store consumed subscription. Method should be called when artifacts are physically transferred to the agent

Parameters:

artifactSubscription -

planResultKey -

getConsumedSubscriptions

@NotNull
com.google.common.collect.Multimap<ResultsSummary,ConsumedSubscription> getConsumedSubscriptions(@NotNull
                                                                                                          ResultsSummary resultsSummary)

Returns list of ConsumedSubscription ordered by order of ResultsSummary execution. Artifacts whose producer does not exists are appended at the end, with null key.

Parameters:

resultsSummary - a job result

Returns:

transformSubscriptions

List<ArtifactSubscriptionSubstitutionAware> transformSubscriptions(@NotNull
                                                                   List<ArtifactSubscription> subscriptions)

prepareArtifactDefinitionContexts

@NotNull
List<ArtifactDefinitionContext> prepareArtifactDefinitionContexts(@NotNull
                                                                           ImmutableJob job,
                                                                           @NotNull
                                                                           BuildContext buildContext,
                                                                           SecureToken secureToken)

Helps prepare the artifact definitions

Parameters:

job -

buildContext -

secureToken -

Returns: