com.atlassian.bamboo.build.artifact

Class AbstractArtifactManager

java.lang.Object

com.atlassian.bamboo.build.artifact.AbstractArtifactManager

All Implemented Interfaces:

ArtifactManager

Direct Known Subclasses:

LocalArtifactManager, RemoteArtifactManager

public abstract class AbstractArtifactManager
extends Object
implements ArtifactManager

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARTIFACT_SECURITY_TOKEN

Fields inherited from interface com.atlassian.bamboo.build.artifact.ArtifactManager

LOGS_FOR_BUILD

Constructor Summary

Constructors

Constructor and Description
AbstractArtifactManager()

Method Summary

Modifier and Type	Method and Description
protected Artifact	findMatchingArtifact(String artifactHandlerKey, Collection<Artifact> matchingArtifacts)
protected Iterable<ArtifactHandler>	getArtifactHandlers(ArtifactDefinitionContext artifact, Map<String,String> artifactHandlersConfiguration)
List<ArtifactHandler>	getArtifactHandlersForAgent(AgentType agentType) Get list of enabled artifact handlers usable on agent of a given type.
protected abstract void	markSubscriptionAsConsumed(PlanResultKey planResultKey, ArtifactSubscriptionContext artifactSubscription, String linkType)
void	moveArtifactToGlobalStorage(Artifact artifact) Move artifact to a 'global storage'.
ArtifactPublishingResult	publish(BuildLogger buildLogger, PlanResultKey resultKey, File baseDirectory, ArtifactDefinitionContext artifact, Map<String,String> artifactHandlerConfiguration, int minExpectedFilesCnt) Request copy of artifacts from a designated location to artifact storage.
ArtifactPublishingResult	publish(BuildLogger buildLogger, ResultKey resultKey, File baseDirectory, ArtifactDefinitionContext artifact, Map<String,String> artifactHandlerConfiguration, int minExpectedFilesCnt) Request copy of artifacts from a designated location to artifact storage.
protected ArtifactPublishingResult	publishFileSet(ResultKey resultKey, ArtifactDefinitionContext artifact, org.apache.tools.ant.types.FileSet sourceFileSet, Map<String,String> artifactHandlersConfiguration, BuildLogger buildLogger)
void	removeArtifactFromStorage(Artifact artifact) Removes artifact files for a single 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.
boolean	removeArtifactsIfOrphaned(List<Long> artifactIds) Removes artifacts identified by the ids on the list, but only if they are not referenced by any deployment version or build result.
boolean	removeOrphanedArtifacts()
boolean	retrieve(BuildLogger buildLogger, PlanResultKey planResultKey, ArtifactSubscriptionContext artifactSubscription, Map<String,String> artifactHandlersConfiguration, File buildWorkingDirectory, com.google.common.collect.Multimap<String,Artifact> availableArtifacts) Retrieves a plan artifact from artifact storage.
boolean	retrieve(BuildLogger buildLogger, PlanResultKey planResultKey, ResultKey resultKey, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ARTIFACT_SECURITY_TOKEN

public static final String ARTIFACT_SECURITY_TOKEN

See Also:

Constant Field Values

Constructor Detail

AbstractArtifactManager

public AbstractArtifactManager()

Method Detail

publish

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

Description copied from interface: ArtifactManager

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

Specified by:

publish in interface ArtifactManager

Parameters:

buildLogger - optional, used to log messages

resultKey - 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

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

Description copied from interface: ArtifactManager

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

Specified by:

publish in interface ArtifactManager

Parameters:

buildLogger - optional, used to log messages

resultKey - key of a plan or deployment 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

validateArtifactsSize

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

Description copied from interface: ArtifactManager

Validates total size of artifacts produced for single build result

Specified by:

validateArtifactsSize in interface ArtifactManager

artifactContext - contains artifacts size quota if set

Returns:

error set in in case of exceeding quota if set

publishFileSet

protected ArtifactPublishingResult publishFileSet(ResultKey resultKey,
                                                  ArtifactDefinitionContext artifact,
                                                  org.apache.tools.ant.types.FileSet sourceFileSet,
                                                  Map<String,String> artifactHandlersConfiguration,
                                                  BuildLogger buildLogger)

retrieve

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

Description copied from interface: ArtifactManager

Retrieves a plan artifact from artifact storage.

Specified by:

retrieve in interface ArtifactManager

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

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

Description copied from interface: ArtifactManager

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.

Specified by:

retrieve in interface ArtifactManager

Returns:

findMatchingArtifact

@Nullable
protected Artifact findMatchingArtifact(String artifactHandlerKey,
                                                  Collection<Artifact> matchingArtifacts)

markSubscriptionAsConsumed

protected abstract void markSubscriptionAsConsumed(PlanResultKey planResultKey,
                                                   ArtifactSubscriptionContext artifactSubscription,
                                                   String linkType)

getArtifactHandlers

protected Iterable<ArtifactHandler> getArtifactHandlers(ArtifactDefinitionContext artifact,
                                                        Map<String,String> artifactHandlersConfiguration)

removeArtifactsFromStorage

public void removeArtifactsFromStorage(@NotNull
                                       Iterable<ArtifactLink> artifactLinks)

Description copied from interface: ArtifactManager

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.

Specified by:

removeArtifactsFromStorage in interface ArtifactManager

removeArtifactsFromStorage

public void removeArtifactsFromStorage(@NotNull
                                       PlanKey planKey)

Description copied from interface: ArtifactManager

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

Specified by:

removeArtifactsFromStorage in interface ArtifactManager

removeArtifactFromStorage

public void removeArtifactFromStorage(@NotNull
                                      Artifact artifact)

Description copied from interface: ArtifactManager

Removes artifact files for a single artifact.

Specified by:

removeArtifactFromStorage in interface ArtifactManager

moveArtifactToGlobalStorage

public void moveArtifactToGlobalStorage(@NotNull
                                        Artifact artifact)
                                 throws IOException

Description copied from interface: ArtifactManager

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

Specified by:

moveArtifactToGlobalStorage in interface ArtifactManager

Throws:

IOException

removeOrphanedArtifacts

public boolean removeOrphanedArtifacts()

Specified by:

removeOrphanedArtifacts in interface ArtifactManager

Returns:

true if something was removed

removeArtifactsIfOrphaned

public boolean removeArtifactsIfOrphaned(@NotNull
                                         List<Long> artifactIds)

Description copied from interface: ArtifactManager

Removes artifacts identified by the ids on the list, but only if they are not referenced by any deployment version or build result.

Specified by:

removeArtifactsIfOrphaned in interface ArtifactManager

Returns:

true if anything was removed

getArtifactHandlersForAgent

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

Description copied from interface: ArtifactManager

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

Specified by:

getArtifactHandlersForAgent in interface ArtifactManager