com.atlassian.bamboo.build.artifact
Interface ArtifactManager

All Known Implementing Classes:
AbstractArtifactManager, LocalArtifactManager, RemoteArtifactManager

public interface ArtifactManager

Common interface for artifact publishers.


Method Summary
 boolean publish(BuildLogger buildLogger, PlanResultKey planResultKey, java.io.File baseDirectory, ArtifactDefinitionContext artifact, boolean deleteSource, int minExpectedFilesCnt)
          Request copy of artifacts from a designated location to artifact storage.
 boolean retrieve(PlanResultKey planResultKey, ArtifactSubscriptionContext artifactSubscription)
          Deprecated. since 3.3 use retrieve(PlanResultKey, ArtifactSubscriptionContext, File)
 boolean retrieve(PlanResultKey planResultKey, ArtifactSubscriptionContext artifactSubscription, java.io.File buildWorkingDirectory)
          Retrieves an artifact from artifact storage.
 

Method Detail

publish

boolean publish(@Nullable
                BuildLogger buildLogger,
                @NotNull
                PlanResultKey planResultKey,
                @NotNull
                java.io.File baseDirectory,
                @NotNull
                ArtifactDefinitionContext artifact,
                boolean deleteSource,
                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
deleteSource - true performs move instead of copy
minExpectedFilesCnt - how many files are necessary to consider the artifact complete, null if no requirements are made
size -
Returns:
true if publish operation result allows the build to continue

retrieve

@Deprecated
boolean retrieve(@NotNull
                            PlanResultKey planResultKey,
                            @NotNull
                            ArtifactSubscriptionContext artifactSubscription)
Deprecated. since 3.3 use retrieve(PlanResultKey, ArtifactSubscriptionContext, File)

Retrieves an artifact from artifact storage.

Parameters:
planResultKey - the plan result that contains the artifact
artifactSubscription - the artifact subscription used to identify artifact
Returns:
true if retrieval was successful, false otherwise

retrieve

boolean retrieve(@NotNull
                 PlanResultKey planResultKey,
                 @NotNull
                 ArtifactSubscriptionContext artifactSubscription,
                 @NotNull
                 java.io.File buildWorkingDirectory)
Retrieves an artifact from artifact storage.

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


Copyright © 2012 Atlassian. All Rights Reserved.