com.atlassian.bamboo.build.artifact
Interface ArtifactLinkManager

All Known Implementing Classes:
DefaultArtifactLinkManager

public interface ArtifactLinkManager

A manager for ArtifactLink.


Method Summary
 ArtifactLink addArtifactLink(BuildResultsSummary producerResult, ArtifactDefinitionBase artifactDefinitionBase)
          Deprecated. since 4.4 without replacement
 ArtifactLink addArtifactLink(BuildResultsSummary producerResult, ArtifactDefinitionContext artifactDefinitionContext)
          Deprecated. since 4.4 use $addArtifactLink(com.atlassian.bamboo.resultsummary.BuildResultsSummary, com.atlassian.bamboo.plan.artifact.ArtifactDefinitionContext, String)
 ArtifactLink addArtifactLink(BuildResultsSummary producerResult, ArtifactDefinitionContext artifactDefinitionContext, java.lang.String publisherPluginKey)
          Create ArtifactLink object and add it to the BuildResultsSummary.
 ArtifactLink addPlanLevelArtifactLink(ChainResultsSummary planResultSummary, ArtifactDefinitionContext artifactDefinitionContext)
          Deprecated. since 4.4 use $addPlanLevelArtifactLink(com.atlassian.bamboo.chains.ChainResultsSummary, com.atlassian.bamboo.plan.artifact.ArtifactDefinitionContext, String)
 ArtifactLink addPlanLevelArtifactLink(ChainResultsSummary planResultSummary, ArtifactDefinitionContext artifactDefinitionContext, java.lang.String publisherPluginKey)
          Create ArtifactLink object and add it to the ChainResultsSummary.
 ArtifactLinkDataProvider getArtifactLinkDataProvider(Artifact artifact)
           
 ArtifactLinkDataProvider getArtifactLinkDataProvider(ArtifactLink artifactLink)
           
 java.util.Collection<ArtifactLink> getArtifactLinks(ResultsSummary resultsSummary, java.lang.String linkType)
          Gets all the ArtifactLinks for the given ResultsSummary and optionally ArtifactLink.getLinkType()
 java.util.Collection<ArtifactLink> getArtifactLinksForLinkType(ResultsSummary resultsSummary, java.lang.String linkType)
          Deprecated. since 5.0 use $getArtifactLinks(com.atlassian.bamboo.resultsummary.ResultsSummary, String)
 void removeArtifactLink(ArtifactLink artifactLink)
          Remove an artifact link.
 void removeArtifactLink(long artifactLinkId)
          Remove an artifact link.
 void removeArtifactLinks(BuildResultsSummary buildResultsSummary)
          Remove all artifact links from the BuildResultsSummary.
 void removeArtifactLinks(ChainResultsSummary chainResultsSummary)
          Remove all artifact links from the ChainResultsSummary.
 void removeArtifactLinks(ChainResultsSummary chainResultsSummary, Plan plan)
          Deprecated. since 5.0, use removeArtifactLinks(com.atlassian.bamboo.chains.ChainResultsSummary)
 void removeProducedArtifactLinks(BuildResultsSummary buildResultsSummary)
          Remove all artifacts produced by a job in a build.
 

Method Detail

addArtifactLink

@NotNull
@Deprecated
ArtifactLink addArtifactLink(@NotNull
                                                BuildResultsSummary producerResult,
                                                @NotNull
                                                ArtifactDefinitionBase artifactDefinitionBase)
Deprecated. since 4.4 without replacement

Create ArtifactLink object and add it to the BuildResultsSummary.

Parameters:
producerResult - ResultsSummary object representing build that produced the artifact
artifactDefinitionBase - artifact definition object
Returns:
ArtifactLink object which has been added to BuildResultsSummary
Since:
3.0

addArtifactLink

@NotNull
@Deprecated
ArtifactLink addArtifactLink(@NotNull
                                                BuildResultsSummary producerResult,
                                                @NotNull
                                                ArtifactDefinitionContext artifactDefinitionContext)
Deprecated. since 4.4 use $addArtifactLink(com.atlassian.bamboo.resultsummary.BuildResultsSummary, com.atlassian.bamboo.plan.artifact.ArtifactDefinitionContext, String)

Create ArtifactLink object and add it to the BuildResultsSummary.

Parameters:
producerResult - ResultsSummary object representing build that produced the artifact
artifactDefinitionContext - artifact definition context
Returns:
ArtifactLink object which has been added to BuildResultsSummary
Since:
3.0

addArtifactLink

@NotNull
ArtifactLink addArtifactLink(@NotNull
                                     BuildResultsSummary producerResult,
                                     @NotNull
                                     ArtifactDefinitionContext artifactDefinitionContext,
                                     @NotNull
                                     java.lang.String publisherPluginKey)
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

addPlanLevelArtifactLink

@NotNull
@Deprecated
ArtifactLink addPlanLevelArtifactLink(@NotNull
                                                         ChainResultsSummary planResultSummary,
                                                         @NotNull
                                                         ArtifactDefinitionContext artifactDefinitionContext)
Deprecated. since 4.4 use $addPlanLevelArtifactLink(com.atlassian.bamboo.chains.ChainResultsSummary, com.atlassian.bamboo.plan.artifact.ArtifactDefinitionContext, String)

Create ArtifactLink object and add it to the ChainResultsSummary. ArtifactLink created with this method does not have a producer Job result specified.

Parameters:
planResultSummary - result of a plan producing the artifact
artifactDefinitionContext - artifact definition context
Returns:
ArtifactLink object which has been added to BuildResultsSummary
Since:
3.0

addPlanLevelArtifactLink

@NotNull
ArtifactLink addPlanLevelArtifactLink(@NotNull
                                              ChainResultsSummary planResultSummary,
                                              @NotNull
                                              ArtifactDefinitionContext artifactDefinitionContext,
                                              @NotNull
                                              java.lang.String publisherPluginKey)
Create ArtifactLink object and add it to the ChainResultsSummary. ArtifactLink created with this method does not have a producer Job result specified.

Parameters:
planResultSummary - result of a plan producing 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

removeArtifactLink

void removeArtifactLink(@NotNull
                        ArtifactLink artifactLink)
Remove an artifact link.

Parameters:
artifactLink -

removeArtifactLink

void removeArtifactLink(long artifactLinkId)
Remove an artifact link.

Parameters:
artifactLinkId -

removeArtifactLinks

void removeArtifactLinks(@NotNull
                         BuildResultsSummary buildResultsSummary)
Remove all artifact links from the BuildResultsSummary.

Parameters:
buildResultsSummary -

removeProducedArtifactLinks

void removeProducedArtifactLinks(@NotNull
                                 BuildResultsSummary buildResultsSummary)
Remove all artifacts produced by a job in a build.

Parameters:
buildResultsSummary -

removeArtifactLinks

@Deprecated
void removeArtifactLinks(@NotNull
                                    ChainResultsSummary chainResultsSummary,
                                    @Nullable
                                    Plan plan)
Deprecated. since 5.0, use removeArtifactLinks(com.atlassian.bamboo.chains.ChainResultsSummary)

Remove all artifact links from the ChainResultsSummary.

Parameters:
chainResultsSummary -
plan - optional, to avoid costly plan lookup

removeArtifactLinks

void removeArtifactLinks(@NotNull
                         ChainResultsSummary chainResultsSummary)
Remove all artifact links from the ChainResultsSummary.

Parameters:
chainResultsSummary -

getArtifactLinks

@NotNull
java.util.Collection<ArtifactLink> getArtifactLinks(@NotNull
                                                            ResultsSummary resultsSummary,
                                                            @Nullable
                                                            java.lang.String linkType)
Gets all the ArtifactLinks for the given ResultsSummary and optionally ArtifactLink.getLinkType()

Parameters:
resultsSummary -
linkType -
Returns:
artifactLinks

getArtifactLinksForLinkType

@NotNull
java.util.Collection<ArtifactLink> getArtifactLinksForLinkType(@NotNull
                                                                       ResultsSummary resultsSummary,
                                                                       @NotNull
                                                                       java.lang.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

@Nullable
ArtifactLinkDataProvider getArtifactLinkDataProvider(@NotNull
                                                              ArtifactLink artifactLink)

getArtifactLinkDataProvider

@Nullable
ArtifactLinkDataProvider getArtifactLinkDataProvider(@NotNull
                                                              Artifact artifact)


Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.