com.atlassian.bamboo.build.artifact

Interface ArtifactLinkManager

All Known Implementing Classes:

DefaultArtifactLinkManager

public interface ArtifactLinkManager

A manager for ArtifactLink.

Method Summary

Modifier and Type	Method and Description
@NotNull ArtifactLink	addArtifactLink(@NotNull BuildResultsSummary producerResult, @NotNull ArtifactDefinitionContext artifactDefinitionContext, @NotNull String publisherPluginKey) Deprecated. since 5.7 use addArtifactLinks(com.atlassian.bamboo.resultsummary.BuildResultsSummary, com.atlassian.bamboo.plan.artifact.ArtifactPublishingResult)
@NotNull Collection<ArtifactLink>	addArtifactLinks(@NotNull BuildResultsSummary producerResult, @NotNull ArtifactPublishingResult result) Create ArtifactLink object and add it to the BuildResultsSummary.
@NotNull Collection<ArtifactLink>	findArtifactLinksByChainResultKey(@NotNull PlanResultKey chainResultKey)
@NotNull com.google.common.collect.Multimap<String,Artifact>	findArtifactsByChainResultKey(@NotNull PlanResultKey chainResultKey) Gets all the Artifacts for the given PlanResultKey
@Nullable ArtifactLinkDataProvider	getArtifactLinkDataProvider(@NotNull Artifact artifact)
@Nullable ArtifactLinkDataProvider	getArtifactLinkDataProvider(@NotNull ArtifactLink artifactLink) Deprecated. since 5.6 use the getArtifactLinkDataProvider(com.atlassian.bamboo.artifact.Artifact)
@NotNull Collection<ArtifactLink>	getArtifactLinks(@NotNull ResultsSummary resultsSummary, @Nullable String linkType) Gets all the ArtifactLinks for the given ResultsSummary and optionally Artifact.getLinkType()
@NotNull Collection<ArtifactLink>	getArtifactLinksForLinkType(@NotNull ResultsSummary resultsSummary, @NotNull String linkType) Deprecated. since 5.0 use getArtifactLinks(com.atlassian.bamboo.resultsummary.ResultsSummary, String)
void	removeArtifactLink(@NotNull ArtifactLink artifactLink) Remove an artifact link.
void	removeArtifactLink(long artifactLinkId) Remove an artifact link.
void	removeArtifactLinks(@NotNull BuildResultsSummary buildResultsSummary) Remove all artifact links from the BuildResultsSummary.
void	removeArtifactLinks(@NotNull ChainResultsSummary chainResultsSummary) Remove all artifact links from the ChainResultsSummary.
void	removeProducedArtifactLinks(@NotNull BuildResultsSummary buildResultsSummary) Remove all artifacts produced by a job in a build.

Method Detail

addArtifactLink

@NotNull
 @Deprecated
@NotNull ArtifactLink addArtifactLink(@NotNull
                                                            @NotNull BuildResultsSummary producerResult,
                                                            @NotNull
                                                            @NotNull ArtifactDefinitionContext artifactDefinitionContext,
                                                            @NotNull
                                                            @NotNull String publisherPluginKey)

Deprecated. since 5.7 use addArtifactLinks(com.atlassian.bamboo.resultsummary.BuildResultsSummary, com.atlassian.bamboo.plan.artifact.ArtifactPublishingResult)

Create ArtifactLink object and add it to the BuildResultsSummary.

Parameters:

producerResult - ResultsSummary object representing build that produced the artifact

artifactDefinitionContext - artifact definition context

publisherPluginKey - the plugin key of the artifact handler used to publish the artifact

Returns:

ArtifactLink object which has been added to BuildResultsSummary

Since:

3.0

addArtifactLinks

@NotNull
@NotNull Collection<ArtifactLink> addArtifactLinks(@NotNull
                                                            @NotNull BuildResultsSummary producerResult,
                                                            @NotNull
                                                            @NotNull ArtifactPublishingResult result)

Create ArtifactLink object and add it to the BuildResultsSummary.

Parameters:

producerResult - ResultsSummary object representing build that produced the artifact

result - the artifact publishing result

Returns:

ArtifactLink objects which has been added to BuildResultsSummary

removeArtifactLink

void removeArtifactLink(@NotNull
                        @NotNull ArtifactLink artifactLink)
                 throws IOException

Remove an artifact link.

Parameters:

artifactLink -

Throws:

IOException

removeArtifactLink

void removeArtifactLink(long artifactLinkId)
                 throws IOException

Remove an artifact link.

Parameters:

artifactLinkId -

Throws:

IOException

removeArtifactLinks

void removeArtifactLinks(@NotNull
                         @NotNull BuildResultsSummary buildResultsSummary)

Remove all artifact links from the BuildResultsSummary.

Parameters:

buildResultsSummary -

removeProducedArtifactLinks

void removeProducedArtifactLinks(@NotNull
                                 @NotNull BuildResultsSummary buildResultsSummary)
                          throws IOException

Remove all artifacts produced by a job in a build.

Parameters:

buildResultsSummary -

Throws:

IOException

removeArtifactLinks

void removeArtifactLinks(@NotNull
                         @NotNull ChainResultsSummary chainResultsSummary)
                  throws IOException

Remove all artifact links from the ChainResultsSummary.

Parameters:

chainResultsSummary -

Throws:

IOException

getArtifactLinks

@NotNull
@NotNull Collection<ArtifactLink> getArtifactLinks(@NotNull
                                                            @NotNull ResultsSummary resultsSummary,
                                                            @Nullable
                                                            @Nullable String linkType)

Gets all the ArtifactLinks for the given ResultsSummary and optionally Artifact.getLinkType()

Parameters:

resultsSummary -

linkType -

Returns:

artifactLinks

getArtifactLinksForLinkType

@Deprecated
 @NotNull
@NotNull Collection<ArtifactLink> getArtifactLinksForLinkType(@NotNull
                                                                                    @NotNull ResultsSummary resultsSummary,
                                                                                    @NotNull
                                                                                    @NotNull String linkType)

Deprecated. since 5.0 use getArtifactLinks(com.atlassian.bamboo.resultsummary.ResultsSummary, String)

Gets all the ArtifactLinks for the given ResultsSummary and ArtifactLink.getLinkType()

Parameters:

resultsSummary -

linkType -

Returns:

artifactLinks

Since:

3.0

getArtifactLinkDataProvider

@Deprecated
 @Nullable
@Nullable ArtifactLinkDataProvider getArtifactLinkDataProvider(@NotNull
                                                                                      @NotNull ArtifactLink artifactLink)

Deprecated. since 5.6 use the getArtifactLinkDataProvider(com.atlassian.bamboo.artifact.Artifact)

Parameters:

artifactLink -

Returns:

getArtifactLinkDataProvider

@Nullable
@Nullable ArtifactLinkDataProvider getArtifactLinkDataProvider(@NotNull
                                                                         @NotNull Artifact artifact)

findArtifactsByChainResultKey

@NotNull
@NotNull com.google.common.collect.Multimap<String,Artifact> findArtifactsByChainResultKey(@NotNull
                                                                                                    @NotNull PlanResultKey chainResultKey)

Gets all the Artifacts for the given PlanResultKey

Parameters:

chainResultKey -

Since:

5.10

findArtifactLinksByChainResultKey

@NotNull
@NotNull Collection<ArtifactLink> findArtifactLinksByChainResultKey(@NotNull
                                                                             @NotNull PlanResultKey chainResultKey)