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 java.lang.Object
implements ArtifactManager

Constructor Summary

AbstractArtifactManager(com.atlassian.plugin.PluginAccessor pluginAccessor, CustomVariableContext customVariableContext)

Method Summary

static org.apache.tools.ant.types.FileSet	createFileSet(java.io.File baseDirectory, ArtifactDefinitionContext artifact, boolean useRelativeLocation) Deprecated. since 4.2 use $ArtifactHandlingUtils.createFileSet()
protected java.lang.Iterable<ArtifactHandler>	getArtifactHandlers(ArtifactDefinitionContext artifact, java.util.Map<java.lang.String,java.lang.String> artifactHandlersConfiguration)
protected abstract void	markSubscriptionAsConsumed(PlanResultKey planResultKey, ArtifactSubscriptionContext artifactSubscription)
boolean	publish(BuildLogger buildLogger, PlanResultKey planResultKey, java.io.File baseDirectory, ArtifactDefinitionContext artifact, int minExpectedFilesCnt) Request copy of artifacts from a designated location to artifact storage.
boolean	publish(BuildLogger buildLogger, PlanResultKey planResultKey, java.io.File baseDirectory, ArtifactDefinitionContext artifact, java.util.Map<java.lang.String,java.lang.String> artifactHandlerConfiguration, int minExpectedFilesCnt) Request copy of artifacts from a designated location to artifact storage.
protected boolean	publishFileSet(PlanResultKey planResultKey, ArtifactDefinitionContext artifact, org.apache.tools.ant.types.FileSet sourceFileSet, java.util.Map<java.lang.String,java.lang.String> artifactHandlersConfiguration)
boolean	retrieve(BuildLogger buildLogger, PlanResultKey planResultKey, ArtifactSubscriptionContext artifactSubscription, java.util.Map<java.lang.String,java.lang.String> artifactHandlersConfiguration, java.io.File buildWorkingDirectory) Retrieves an artifact from artifact storage.
boolean	retrieve(PlanResultKey planResultKey, ArtifactSubscriptionContext artifactSubscription, java.io.File buildWorkingDirectory) Retrieves an artifact from artifact storage.
ErrorCollection	validateArtifactsSize(java.io.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

Constructor Detail

AbstractArtifactManager

public AbstractArtifactManager(com.atlassian.plugin.PluginAccessor pluginAccessor,
                               CustomVariableContext customVariableContext)

Method Detail

createFileSet

@Deprecated
@Nullable
public static org.apache.tools.ant.types.FileSet createFileSet(java.io.File baseDirectory,
                                                                                   ArtifactDefinitionContext artifact,
                                                                                   boolean useRelativeLocation)

Deprecated. since 4.2 use $ArtifactHandlingUtils.createFileSet()

Creates a FileSet object.

Parameters:

baseDirectory - directory used to resolve the copy patterns

artifact - artifact definition

useRelativeLocation - used to determine whether the relative location information from artifact definition should be used

Returns:

the created FileSet

publish

public boolean publish(@Nullable
                       BuildLogger buildLogger,
                       @NotNull
                       PlanResultKey planResultKey,
                       @NotNull
                       java.io.File baseDirectory,
                       @NotNull
                       ArtifactDefinitionContext artifact,
                       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

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

public boolean publish(@Nullable
                       BuildLogger buildLogger,
                       @NotNull
                       PlanResultKey planResultKey,
                       @NotNull
                       java.io.File baseDirectory,
                       @NotNull
                       ArtifactDefinitionContext artifact,
                       @NotNull
                       java.util.Map<java.lang.String,java.lang.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

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

validateArtifactsSize

public final ErrorCollection validateArtifactsSize(@NotNull
                                                   java.io.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 boolean publishFileSet(PlanResultKey planResultKey,
                                 ArtifactDefinitionContext artifact,
                                 org.apache.tools.ant.types.FileSet sourceFileSet,
                                 java.util.Map<java.lang.String,java.lang.String> artifactHandlersConfiguration)

retrieve

public boolean retrieve(@NotNull
                        PlanResultKey planResultKey,
                        @NotNull
                        ArtifactSubscriptionContext artifactSubscription,
                        @NotNull
                        java.io.File buildWorkingDirectory)

Description copied from interface: ArtifactManager

Retrieves an artifact from artifact storage.

Specified by:

retrieve in interface ArtifactManager

Parameters:

planResultKey - the plan result that contains the artifact

artifactSubscription - the artifact subscription used to identify artifact

buildWorkingDirectory - working directory of current build

Returns:

true if retrieval was successful, false otherwise

retrieve

public boolean retrieve(@Nullable
                        BuildLogger buildLogger,
                        @NotNull
                        PlanResultKey planResultKey,
                        @NotNull
                        ArtifactSubscriptionContext artifactSubscription,
                        @NotNull
                        java.util.Map<java.lang.String,java.lang.String> artifactHandlersConfiguration,
                        @NotNull
                        java.io.File buildWorkingDirectory)

Description copied from interface: ArtifactManager

Retrieves an 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

Returns:

true if retrieval was successful, false otherwise

markSubscriptionAsConsumed

protected abstract void markSubscriptionAsConsumed(PlanResultKey planResultKey,
                                                   ArtifactSubscriptionContext artifactSubscription)

getArtifactHandlers

protected java.lang.Iterable<ArtifactHandler> getArtifactHandlers(ArtifactDefinitionContext artifact,
                                                                  java.util.Map<java.lang.String,java.lang.String> artifactHandlersConfiguration)