com.atlassian.bamboo.build.artifact

Interface ArtifactManager

All Known Implementing Classes:

AbstractArtifactManager, LocalArtifactManager, RemoteArtifactManager

@PublicApi
public interface ArtifactManager

A common interface for artifact managers

Method Summary

Modifier and Type	Method and Description
List<ArtifactHandler>	getArtifactHandlersForAgent(AgentType agentType) Get list of enabled artifact handlers usable on agent of a given type.
void	moveArtifactToGlobalStorage(Artifact artifact) Move artifact to a 'global storage'.
ArtifactPublishingResult	publish(BuildLogger buildLogger, PlanResultKey planResultKey, File baseDirectory, ArtifactDefinitionContext artifact, Map<String,String> artifactHandlerConfiguration, int minExpectedFilesCnt) Request copy of artifacts from a designated location to artifact storage.
boolean	publish(BuildLogger buildLogger, PlanResultKey planResultKey, File baseDirectory, ArtifactDefinitionContext artifact, Map<String,String> artifactHandlerConfiguration, Set<String> successfulPublishers, int minExpectedFilesCnt) Deprecated. since 5.7 use publish(com.atlassian.bamboo.build.logger.BuildLogger, com.atlassian.bamboo.plan.PlanResultKey, java.io.File, com.atlassian.bamboo.plan.artifact.ArtifactDefinitionContext, java.util.Map, int) }
void	removeArtifactFromStorage(Artifact artifact) Removes artifact files for a single artifact.
void	removeArtifactFromStorage(PlanResultKey planResultKey, ImmutableArtifactDefinitionBase artifact) Deprecated. since 5.5 use removeArtifactFromStorage(Artifact)
void	removeArtifactsFromStorage(Iterable<ArtifactLink> artifactLinks) Removes artifact files for all plan results attached to supplied links.
void	removeArtifactsFromStorage(PlanKey planKey) Removes artifact files for all results of a single.
void	removeArtifactsFromStorage(PlanResultKey planResultKey) Deprecated. since 5.7
boolean	removeOrphanedArtifacts()
boolean	retrieve(BuildLogger buildLogger, PlanResultKey planResultKey, ArtifactSubscriptionContext artifactSubscription, Map<String,String> artifactHandlerConfiguration, File buildWorkingDirectory, com.google.common.collect.Multimap<String,Artifact> availableArtifacts) Retrieves a plan artifact from artifact storage.
boolean	retrieve(BuildLogger buildLogger, PlanResultKey planResultKey, ResultKey clientKey, ArtifactDefinitionContext artifactDefinitionContext, String destinationPath, Map<String,String> artifactHandlersConfiguration, File buildWorkingDirectory, com.google.common.collect.Multimap<String,Artifact> availableArtifacts) Retrieves an artifact from artifact storage.
ErrorCollection	validateArtifactsSize(File baseDirectory, ArtifactContext artifactContext) Validates total size of artifacts produced for single build result

Method Detail

publish

ArtifactPublishingResult publish(@Nullable
                                 BuildLogger buildLogger,
                                 @NotNull
                                 PlanResultKey planResultKey,
                                 @NotNull
                                 File baseDirectory,
                                 @NotNull
                                 ArtifactDefinitionContext artifact,
                                 @NotNull
                                 Map<String,String> artifactHandlerConfiguration,
                                 int minExpectedFilesCnt)

Request copy of artifacts from a designated location to artifact storage.

Parameters:

buildLogger - optional, used to log messages

planResultKey - key of a plan result that created the artifact

artifact - definition of the artifact

minExpectedFilesCnt - how many files are necessary to consider the artifact complete, null if no requirements are made

Returns:

true if publish operation result allows the build to continue

publish

@Deprecated
boolean publish(@Nullable
                            BuildLogger buildLogger,
                            @NotNull
                            PlanResultKey planResultKey,
                            @NotNull
                            File baseDirectory,
                            @NotNull
                            ArtifactDefinitionContext artifact,
                            @NotNull
                            Map<String,String> artifactHandlerConfiguration,
                            @NotNull
                            Set<String> successfulPublishers,
                            int minExpectedFilesCnt)

Deprecated. since 5.7 use publish(com.atlassian.bamboo.build.logger.BuildLogger, com.atlassian.bamboo.plan.PlanResultKey, java.io.File, com.atlassian.bamboo.plan.artifact.ArtifactDefinitionContext, java.util.Map, int) }

Request copy of artifacts from a designated location to artifact storage.

Parameters:

buildLogger - optional, used to log messages

planResultKey - key of a plan result that created the artifact

artifact - definition of the artifact

successfulPublishers - used to return a list of plugin keys for ArtifactHandlers that succesfully published artifacts

minExpectedFilesCnt - how many files are necessary to consider the artifact complete, null if no requirements are made

Returns:

true if publish operation result allows the build to continue

retrieve

boolean retrieve(@Nullable
                 BuildLogger buildLogger,
                 @NotNull
                 PlanResultKey planResultKey,
                 @NotNull
                 ArtifactSubscriptionContext artifactSubscription,
                 @NotNull
                 Map<String,String> artifactHandlerConfiguration,
                 @NotNull
                 File buildWorkingDirectory,
                 @NotNull
                 com.google.common.collect.Multimap<String,Artifact> availableArtifacts)

Retrieves a plan artifact from artifact storage.

Parameters:

buildLogger - to use

planResultKey - the plan result that contains the artifact

artifactSubscription - the artifact subscription used to identify artifact

buildWorkingDirectory - working directory of current build

availableArtifacts - artifacts found in source result

Returns:

true if retrieval was successful, false otherwise

retrieve

boolean retrieve(@Nullable
                 BuildLogger buildLogger,
                 @NotNull
                 PlanResultKey planResultKey,
                 @NotNull
                 ResultKey clientKey,
                 @NotNull
                 ArtifactDefinitionContext artifactDefinitionContext,
                 @NotNull
                 String destinationPath,
                 @NotNull
                 Map<String,String> artifactHandlersConfiguration,
                 @NotNull
                 File buildWorkingDirectory,
                 @NotNull
                 com.google.common.collect.Multimap<String,Artifact> availableArtifacts)

Retrieves an artifact from artifact storage. The important difference for that method is, that NO subscription information is updated. Useful for retrieving artifacts in non standard way (cross-plan for example) If versionArtifacts parameter is specified, the method will first try to match requested artifact with the content of the map. If match is found, information in Artifact object will be used to find artifact in the storage.

Parameters:

buildLogger -

planResultKey -

clientKey -

artifactDefinitionContext -

destinationPath -

artifactHandlersConfiguration -

buildWorkingDirectory -

availableArtifacts -

Returns:

validateArtifactsSize

ErrorCollection validateArtifactsSize(@NotNull
                                      File baseDirectory,
                                      @NotNull
                                      ArtifactContext artifactContext)

Validates total size of artifacts produced for single build result

Parameters:

baseDirectory -

artifactContext - contains artifacts size quota if set

Returns:

error set in in case of exceeding quota if set

removeArtifactFromStorage

void removeArtifactFromStorage(@NotNull
                               Artifact artifact)

Removes artifact files for a single artifact.

removeArtifactFromStorage

@Deprecated
void removeArtifactFromStorage(@NotNull
                                           PlanResultKey planResultKey,
                                           @NotNull
                                           ImmutableArtifactDefinitionBase artifact)

Deprecated. since 5.5 use removeArtifactFromStorage(Artifact)

Removes artifact files for a single artifact.

removeArtifactsFromStorage

@Deprecated
void removeArtifactsFromStorage(@NotNull
                                            PlanResultKey planResultKey)

Deprecated. since 5.7

Removes artifact files for a single plan result. Called when removing ResultsSummary Should not remove artifacts that were moved to global storage.

removeArtifactsFromStorage

void removeArtifactsFromStorage(@NotNull
                                Iterable<ArtifactLink> artifactLinks)

Removes artifact files for all plan results attached to supplied links. Called when removing ResultsSummary Should not remove artifacts that were moved to global storage.

removeArtifactsFromStorage

void removeArtifactsFromStorage(@NotNull
                                PlanKey planKey)

Removes artifact files for all results of a single. Called when removing Plan Should not remove artifacts that were moved to global storage.

moveArtifactToGlobalStorage

void moveArtifactToGlobalStorage(@NotNull
                                 Artifact artifact)
                          throws IOException

Move artifact to a 'global storage'. Artifacts in 'global storage' should only be removed when removeArtifactFromStorage(Artifact) is called. It is not a requirement to physically move the files as long as the above contract is fulfilled.

Parameters:

artifact -

Throws:

IOException

Since:

5.0

removeOrphanedArtifacts

boolean removeOrphanedArtifacts()

Returns:

true if something was removed

getArtifactHandlersForAgent

@NotNull
List<ArtifactHandler> getArtifactHandlersForAgent(@NotNull
                                                           AgentType agentType)

Get list of enabled artifact handlers usable on agent of a given type. This method should be called by agents and it doesn't filter artifact handlers according to - Bamboo instance type