com.atlassian.bamboo.build.artifact

Class ArtifactHandlerDecoratorSupport

java.lang.Object

com.atlassian.bamboo.build.artifact.ArtifactHandlerDecoratorSupport

All Implemented Interfaces:

ArtifactHandler, BambooPluginModule

Direct Known Subclasses:

ArtifactHandlerPackagingDecorator

public abstract class ArtifactHandlerDecoratorSupport
extends Object
implements ArtifactHandler

Allows to decorate an ArtifactHandler by overwriting some of it's methods. By default all methods are forwarded to the underlying ArtifactHandler returned by delegate().

Field Summary

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

LAN_SPEED, LOCAL_SPEED, NEVER_ARCHIVE, WAN_SPEED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ArtifactHandlerDecoratorSupport() Constructor for use by subclasses.

Method Summary

Modifier and Type	Method and Description
boolean	canHandleArtifact(ArtifactDefinitionContext artifact, Map<String,String> artifactHandlersConfiguration)
protected abstract ArtifactHandler	delegate() Returns the delegate instance that methods are forwarded to.
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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ArtifactHandlerDecoratorSupport

protected ArtifactHandlerDecoratorSupport()

Constructor for use by subclasses.

Method Detail

delegate

@NotNull
protected abstract ArtifactHandler delegate()

Returns the delegate instance that methods are forwarded to. Subclasses should override this method to supply the instance being decorated.

publish

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

Specified by:

publish in interface ArtifactHandler

Throws:

Exception

retrieve

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

Description copied from interface: ArtifactHandler

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

Specified by:

retrieve in interface ArtifactHandler

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
public Set<AgentType> getSupportedAgents()

Specified by:

getSupportedAgents in interface ArtifactHandler

getModuleDescriptor

@NotNull
public ArtifactHandlerModuleDescriptor getModuleDescriptor()

Specified by:

getModuleDescriptor in interface ArtifactHandler

canHandleArtifact

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

Specified by:

canHandleArtifact in interface ArtifactHandler

getDefaultConfiguration

@NotNull
public Map<String,String> getDefaultConfiguration()

Specified by:

getDefaultConfiguration in interface ArtifactHandler

getSpeed

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

Description copied from interface: ArtifactHandler

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.

Specified by:

getSpeed in interface ArtifactHandler

Parameters:

artifactHandlersConfiguration - artifact handler configuration

Returns:

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

removeArtifactFromStorage

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

Description copied from interface: ArtifactHandler

Removes artifact files for a single artifact.

Specified by:

removeArtifactFromStorage in interface ArtifactHandler

removeArtifactFromStorage

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

Description copied from interface: ArtifactHandler

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

Specified by:

removeArtifactFromStorage in interface ArtifactHandler

removeArtifactsFromStorage

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

Description copied from interface: ArtifactHandler

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

Specified by:

removeArtifactsFromStorage in interface ArtifactHandler

removeArtifactsFromStorage

public void removeArtifactsFromStorage(@NotNull
                                       PlanKey planKey,
                                       @NotNull
                                       ArtifactHandlerConfigProvider artifactHandlerConfigProvider)

Description copied from interface: ArtifactHandler

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 ArtifactHandler

moveArtifactToGlobalStorage

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

Description copied from interface: ArtifactHandler

Move artifact to a 'global storage'. Artifacts in 'global storage' should only be removed when ArtifactHandler.removeArtifactFromStorage(Artifact, ArtifactHandlerConfigProvider) 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 ArtifactHandler

Returns:

true if move successful

Throws:

IOException

getArtifactLinkDataProvider

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

Specified by:

getArtifactLinkDataProvider in interface ArtifactHandler

getArtifactLinkDataProvider

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

Specified by:

getArtifactLinkDataProvider in interface ArtifactHandler

getMaxUnarchivedFilesPerArtifact

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

Description copied from interface: ArtifactHandler

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 ArtifactHandler.NEVER_ARCHIVE if packaging of artifacts is disabled, to always send files unarchived.

Specified by:

getMaxUnarchivedFilesPerArtifact in interface ArtifactHandler

Parameters:

artifactHandlersConfiguration - artifact handler configuration

Returns:

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

toString

public String toString()

Overrides:

toString in class Object