hudson.plugins.s3

Class S3Profile

java.lang.Object

hudson.plugins.s3.S3Profile

public class S3Profile
extends Object

Constructor Summary

Constructors

Constructor and Description
S3Profile(String name, String accessKey, String secretKey, boolean useRole, int signedUrlExpirySeconds, String maxUploadRetries, String uploadRetryTime, String maxDownloadRetries, String downloadRetryTime, boolean keepStructure)

Method Summary

Modifier and Type	Method and Description
void	delete(hudson.model.Run run, FingerprintRecord record) Delete some artifacts of a given run
List<FingerprintRecord>	downloadAll(hudson.model.Run build, List<FingerprintRecord> artifacts, String includeFilter, String excludeFilter, hudson.FilePath targetDir, boolean flatten) Download all artifacts from a given build
String	getAccessKey()
com.amazonaws.services.s3.AmazonS3Client	getClient()
int	getDownloadRetryTime()
String	getDownloadURL(hudson.model.Run run, FingerprintRecord record) Generate a signed download request for a redirect from s3/download.
int	getMaxDownloadRetries()
int	getMaxUploadRetries()
String	getName()
hudson.util.Secret	getSecretKey()
int	getSignedUrlExpirySeconds()
int	getUploadRetryTime()
boolean	getUseRole()
boolean	isKeepStructure()
boolean	isUseRole()
List<String>	list(hudson.model.Run build, String bucket)
String	toString()
List<FingerprintRecord>	upload(hudson.model.Run<?,?> run, String bucketName, List<hudson.FilePath> filePaths, List<String> fileNames, Map<String,String> userMetadata, String storageClass, String selregion, boolean uploadFromSlave, boolean managedArtifacts, boolean useServerSideEncryption, boolean gzipFiles)

Methods inherited from class java.lang.Object

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

Constructor Detail

S3Profile

@DataBoundConstructor
public S3Profile(String name,
                                       String accessKey,
                                       String secretKey,
                                       boolean useRole,
                                       int signedUrlExpirySeconds,
                                       String maxUploadRetries,
                                       String uploadRetryTime,
                                       String maxDownloadRetries,
                                       String downloadRetryTime,
                                       boolean keepStructure)

Method Detail

isKeepStructure

public boolean isKeepStructure()

getMaxDownloadRetries

public int getMaxDownloadRetries()

getDownloadRetryTime

public int getDownloadRetryTime()

getAccessKey

public final String getAccessKey()

getSecretKey

public final hudson.util.Secret getSecretKey()

getMaxUploadRetries

public final int getMaxUploadRetries()

getUploadRetryTime

public final int getUploadRetryTime()

getName

public final String getName()

getUseRole

public final boolean getUseRole()

isUseRole

public boolean isUseRole()

getSignedUrlExpirySeconds

public int getSignedUrlExpirySeconds()

getClient

public com.amazonaws.services.s3.AmazonS3Client getClient()

upload

public List<FingerprintRecord> upload(hudson.model.Run<?,?> run,
                                      String bucketName,
                                      List<hudson.FilePath> filePaths,
                                      List<String> fileNames,
                                      Map<String,String> userMetadata,
                                      String storageClass,
                                      String selregion,
                                      boolean uploadFromSlave,
                                      boolean managedArtifacts,
                                      boolean useServerSideEncryption,
                                      boolean gzipFiles)
                               throws IOException,
                                      InterruptedException

Throws:

IOException

InterruptedException

list

public List<String> list(hudson.model.Run build,
                         String bucket)

downloadAll

public List<FingerprintRecord> downloadAll(hudson.model.Run build,
                                           List<FingerprintRecord> artifacts,
                                           String includeFilter,
                                           String excludeFilter,
                                           hudson.FilePath targetDir,
                                           boolean flatten)
                                    throws IOException,
                                           InterruptedException

Download all artifacts from a given build

Throws:

IOException

InterruptedException

delete

public void delete(hudson.model.Run run,
                   FingerprintRecord record)

Delete some artifacts of a given run

getDownloadURL

public String getDownloadURL(hudson.model.Run run,
                             FingerprintRecord record)

Generate a signed download request for a redirect from s3/download. When the user asks to download a file, we sign a short-lived S3 URL for them and redirect them to it, so we don't have to proxy for the download and there's no need for the user to have credentials to access S3.

toString

public String toString()

Overrides:

toString in class Object