com.atlassian.bamboo.build.artifact

Interface ArtifactHandler

All Superinterfaces:

BambooPluginModule

All Known Implementing Classes:

AbstractArtifactHandler, AbstractLocalArtifactHandler, AgentLocalArtifactHandler, ArtifactHandlerDecoratorSupport, ArtifactHandlerPackagingDecorator, BambooRemoteArtifactHandler, S3ArtifactHandler, ServerLocalArtifactHandler

public interface ArtifactHandler
extends BambooPluginModule

Handles artifact storage. Should provide 'local' (i.e. per plan basis) and 'global' storage. Artifacts in 'global' storage should not be removed when producing result (plan) is removed.

Field Summary

Fields

Modifier and Type	Field and Description
static int	LAN_SPEED
static int	LOCAL_SPEED
static long	NEVER_ARCHIVE A value to be used within getMaxUnarchivedFilesPerArtifact(Map) to completely disable archiving of artifacts.
static int	WAN_SPEED

Method Summary

Modifier and Type	Method and Description
boolean	canHandleArtifact(ArtifactDefinitionContext artifact, Map<String,String> artifactHandlersConfiguration)
ArtifactLinkDataProvider	getArtifactLinkDataProvider(Artifact artifact, ArtifactHandlerConfigProvider artifactHandlerConfigProvider)
ArtifactLinkDataProvider	getArtifactLinkDataProvider(ArtifactLink artifactLink, ArtifactHandlerConfigProvider artifactHandlerConfigProvider)
Map<String,String>	getDefaultConfiguration()
long	getMaxUnarchivedFilesPerArtifact(Map<String,String> artifactHandlersConfiguration) Returns the maximum number of files that can exist per artifact which will not be compressed and combined into a single archive.
ArtifactHandlerModuleDescriptor	getModuleDescriptor()
int	getSpeed(Map<String,String> artifactHandlersConfiguration) Return approximate transfer speed of this artifact handler in bytes per second for the specified configuration.
Set<AgentType>	getSupportedAgents()
boolean	moveArtifactToGlobalStorage(Artifact artifact, ArtifactHandlerConfigProvider artifactHandlerConfigProvider) Move artifact to a 'global storage'.
ArtifactHandlerPublishingResult	publish(PlanResultKey planResultKey, ArtifactDefinitionContext artifact, ArtifactPublishingConfig artifactPublishingConfig)
void	removeArtifactFromStorage(Artifact artifact, ArtifactHandlerConfigProvider artifactHandlerConfigProvider) Removes artifact files for a single artifact.
void	removeArtifactFromStorage(PlanResultKey planResultKey, ImmutableArtifactDefinitionBase artifact, ArtifactHandlerConfigProvider artifactHandlerConfigProvider) Removes artifact files for a single artifact.
void	removeArtifactsFromStorage(PlanKey planKey, ArtifactHandlerConfigProvider artifactHandlerConfigProvider) Removes artifact files for all results of a single.
void	removeArtifactsFromStorage(PlanResultKey planResultKey, ArtifactHandlerConfigProvider artifactHandlerConfigProvider) Removes artifact files for a single plan result.
ArtifactRetrievalStatus	retrieve(ResultKey clientKey, Artifact artifact, ArtifactSubscriptionContext artifactSubscription, ArtifactRetrievalConfig artifactRetrievalConfig) Retrieve arbitrary Artifact.

Field Detail

NEVER_ARCHIVE

static final long NEVER_ARCHIVE

A value to be used within getMaxUnarchivedFilesPerArtifact(Map) to completely disable archiving of artifacts.

See Also:

Constant Field Values

LOCAL_SPEED

static final int LOCAL_SPEED

See Also:

Constant Field Values

LAN_SPEED

static final int LAN_SPEED

See Also:

Constant Field Values

WAN_SPEED

static final int WAN_SPEED

See Also:

Constant Field Values

Method Detail

publish

@NotNull
ArtifactHandlerPublishingResult publish(@NotNull
                                                 PlanResultKey planResultKey,
                                                 @NotNull
                                                 ArtifactDefinitionContext artifact,
                                                 @NotNull
                                                 ArtifactPublishingConfig artifactPublishingConfig)
                                          throws Exception

Throws:

Exception

retrieve

@NotNull
ArtifactRetrievalStatus retrieve(@NotNull
                                          ResultKey clientKey,
                                          @NotNull
                                          Artifact artifact,
                                          @NotNull
                                          ArtifactSubscriptionContext artifactSubscription,
                                          @NotNull
                                          ArtifactRetrievalConfig artifactRetrievalConfig)
                                   throws Exception

Retrieve arbitrary Artifact. Artifact is found by the information in artifact parameter.

Parameters:

clientKey - identifier of plan or deployment doing the download

artifact - artifact information

artifactSubscription - download details (e.g. target path, copy pattern)

artifactRetrievalConfig - handler specific configuration

Throws:

Exception

getSupportedAgents

@NotNull
Set<AgentType> getSupportedAgents()

getModuleDescriptor

@NotNull
ArtifactHandlerModuleDescriptor getModuleDescriptor()

canHandleArtifact

boolean canHandleArtifact(ArtifactDefinitionContext artifact,
                          Map<String,String> artifactHandlersConfiguration)

getDefaultConfiguration

@NotNull
Map<String,String> getDefaultConfiguration()

getSpeed

int getSpeed(@NotNull
             Map<String,String> artifactHandlersConfiguration)

Return approximate transfer speed of this artifact handler in bytes per second for the specified configuration. Result of this method might be taken into account when deciding which artifact handler to use if multiple handlers are enabled.

Parameters:

artifactHandlersConfiguration - artifact handler configuration

Returns:

approximate transfer speed in Bps, for example: LOCAL_SPEED, LAN_SPEED, WAN_SPEED

removeArtifactFromStorage

void removeArtifactFromStorage(@NotNull
                               Artifact artifact,
                               @NotNull
                               ArtifactHandlerConfigProvider artifactHandlerConfigProvider)

Removes artifact files for a single artifact.

removeArtifactFromStorage

void removeArtifactFromStorage(@NotNull
                               PlanResultKey planResultKey,
                               @NotNull
                               ImmutableArtifactDefinitionBase artifact,
                               @NotNull
                               ArtifactHandlerConfigProvider artifactHandlerConfigProvider)

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

removeArtifactsFromStorage

void removeArtifactsFromStorage(@NotNull
                                PlanResultKey planResultKey,
                                @NotNull
                                ArtifactHandlerConfigProvider artifactHandlerConfigProvider)

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
                                PlanKey planKey,
                                @NotNull
                                ArtifactHandlerConfigProvider artifactHandlerConfigProvider)

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

moveArtifactToGlobalStorage

boolean moveArtifactToGlobalStorage(@NotNull
                                    Artifact artifact,
                                    @NotNull
                                    ArtifactHandlerConfigProvider artifactHandlerConfigProvider)
                             throws IOException

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

Parameters:

artifact -

Returns:

true if move successful

Throws:

IOException

Since:

5.0

getArtifactLinkDataProvider

@Nullable
ArtifactLinkDataProvider getArtifactLinkDataProvider(ArtifactLink artifactLink,
                                                               @NotNull
                                                               ArtifactHandlerConfigProvider artifactHandlerConfigProvider)

getArtifactLinkDataProvider

@Nullable
ArtifactLinkDataProvider getArtifactLinkDataProvider(Artifact artifact,
                                                               @NotNull
                                                               ArtifactHandlerConfigProvider artifactHandlerConfigProvider)

getMaxUnarchivedFilesPerArtifact

long getMaxUnarchivedFilesPerArtifact(@NotNull
                                      Map<String,String> artifactHandlersConfiguration)

Returns the maximum number of files that can exist per artifact which will not be compressed and combined into a single archive. If the threshold is exceeded, artifacts will be packaged into a single file before publishing.

ArtifactHandler does not need to treat archived artifacts differently - from ArtifactHandler perspective the packaging is transparent. Artifact files will be compressed before invoking #publish method and decompressed after invoking #retrieve method.

This method should return NEVER_ARCHIVE if packaging of artifacts is disabled, to always send files unarchived.

Parameters:

artifactHandlersConfiguration - artifact handler configuration

Returns:

maximum number of files per artifact that should not be packaged into a single file