hudson.plugins.s3

Class S3Profile

java.lang.Object

hudson.plugins.s3.S3Profile

public class S3Profile
extends Object

Constructor Summary

Constructors

Constructor and Description
S3Profile()
S3Profile(String name, String accessKey, String secretKey, String proxyHost, String proxyPort, boolean useRole, int signedUrlExpirySeconds, String maxUploadRetries, String retryWaitTime)
S3Profile(String name, String accessKey, String secretKey, String proxyHost, String proxyPort, boolean useRole, String maxUploadRetries, String retryWaitTime)

Method Summary

Methods

Modifier and Type	Method and Description
void	check()
void	delete(hudson.model.Run build, FingerprintRecord record) Delete some artifacts of a given run
List<FingerprintRecord>	downloadAll(hudson.model.Run build, List<FingerprintRecord> artifacts, String expandedFilter, hudson.FilePath targetDir, boolean flatten, PrintStream console) Download all artifacts from a given build
String	getAccessKey()
com.amazonaws.services.s3.AmazonS3Client	getClient()
String	getDownloadURL(hudson.model.Run build, FingerprintRecord record) Generate a signed download request for a redirect from s3/download.
int	getMaxUploadRetries()
String	getName()
String	getProxyHost()
String	getProxyPort()
int	getRetryWaitTime()
hudson.util.Secret	getSecretKey()
int	getSignedUrlExpirySeconds()
boolean	getUseRole()
boolean	isUseRole()
List<String>	list(hudson.model.Run build, String bucket, String expandedFilter)
void	setAccessKey(String accessKey)
void	setName(String name)
void	setUseRole(boolean useRole)
FingerprintRecord	upload(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener, String bucketName, hudson.FilePath filePath, int searchPathLength, List<MetadataPair> userMetadata, String storageClass, String selregion, boolean uploadFromSlave, boolean managedArtifacts, boolean useServerSideEncryption, boolean flatten)

Methods inherited from class java.lang.Object

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

Constructor Detail

S3Profile

public S3Profile()

S3Profile

public S3Profile(String name,
         String accessKey,
         String secretKey,
         String proxyHost,
         String proxyPort,
         boolean useRole,
         String maxUploadRetries,
         String retryWaitTime)

S3Profile

@DataBoundConstructor
public S3Profile(String name,
                              String accessKey,
                              String secretKey,
                              String proxyHost,
                              String proxyPort,
                              boolean useRole,
                              int signedUrlExpirySeconds,
                              String maxUploadRetries,
                              String retryWaitTime)

Method Detail

getAccessKey

public final String getAccessKey()

setAccessKey

public void setAccessKey(String accessKey)

getSecretKey

public final hudson.util.Secret getSecretKey()

getMaxUploadRetries

public final int getMaxUploadRetries()

getRetryWaitTime

public final int getRetryWaitTime()

getName

public final String getName()

setName

public void setName(String name)

getUseRole

public final boolean getUseRole()

setUseRole

public void setUseRole(boolean useRole)

getProxyHost

public String getProxyHost()

getProxyPort

public String getProxyPort()

isUseRole

public boolean isUseRole()

getSignedUrlExpirySeconds

public int getSignedUrlExpirySeconds()

getClient

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

check

public void check()
           throws Exception

Throws:

Exception

upload

public FingerprintRecord upload(hudson.model.AbstractBuild<?,?> build,
                       hudson.model.BuildListener listener,
                       String bucketName,
                       hudson.FilePath filePath,
                       int searchPathLength,
                       List<MetadataPair> userMetadata,
                       String storageClass,
                       String selregion,
                       boolean uploadFromSlave,
                       boolean managedArtifacts,
                       boolean useServerSideEncryption,
                       boolean flatten)
                         throws IOException,
                                InterruptedException

Throws:

IOException

InterruptedException

list

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

downloadAll

public List<FingerprintRecord> downloadAll(hudson.model.Run build,
                                  List<FingerprintRecord> artifacts,
                                  String expandedFilter,
                                  hudson.FilePath targetDir,
                                  boolean flatten,
                                  PrintStream console)

Download all artifacts from a given build

delete

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

Delete some artifacts of a given run

Parameters:

build -

artifact -

getDownloadURL

public String getDownloadURL(hudson.model.Run build,
                    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.