Package jenkins.plugins.itemstorage.s3

Class S3Profile

java.lang.Object

jenkins.plugins.itemstorage.s3.S3Profile

public class S3Profile
extends Object

Based on same named class in S3 Jenkins Plugin

Reusable class for interacting with S3 for file operations

Author:

Peter Hayes

Constructor Summary

Constructors

Constructor	Description
S3Profile(com.cloudbees.jenkins.plugins.awscredentials.AmazonWebServicesCredentials credentials, String endpoint, String region, String prefix, String signerVersion, boolean pathStyleAccess, boolean parallelDownloads)

Method Summary

Modifier and Type	Method	Description
void	delete(String bucketName, String pathPrefix)
void	download(String bucketName, String key, FilePath target)
int	downloadAll(String bucketName, String pathPrefix, String fileMask, String excludes, boolean useDefaultExcludes, FilePath target)
boolean	exists(String bucketName, String path)
void	rename(String bucketName, String currentPathPrefix, String newPathPrefix)
void	upload(String bucketName, String path, FilePath source, Map<String,String> userMetadata, String storageClass, boolean useServerSideEncryption)
int	uploadAll(String bucketName, String path, String fileMask, String excludes, boolean useDefaultExcludes, FilePath source, Map<String,String> userMetadata, String storageClass, boolean useServerSideEncryption)

Methods inherited from class java.lang.Object

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

Constructor Detail

S3Profile

@DataBoundConstructor
public S3Profile(com.cloudbees.jenkins.plugins.awscredentials.AmazonWebServicesCredentials credentials,
                 String endpoint,
                 String region,
                 String prefix,
                 String signerVersion,
                 boolean pathStyleAccess,
                 boolean parallelDownloads)

Method Detail

upload

public void upload(String bucketName,
                   String path,
                   FilePath source,
                   Map<String,String> userMetadata,
                   String storageClass,
                   boolean useServerSideEncryption)
            throws IOException,
                   InterruptedException

Throws:

IOException

InterruptedException

uploadAll

public int uploadAll(String bucketName,
                     String path,
                     String fileMask,
                     String excludes,
                     boolean useDefaultExcludes,
                     FilePath source,
                     Map<String,String> userMetadata,
                     String storageClass,
                     boolean useServerSideEncryption)
              throws IOException,
                     InterruptedException

Throws:

IOException

InterruptedException

exists

public boolean exists(String bucketName,
                      String path)

download

public void download(String bucketName,
                     String key,
                     FilePath target)
              throws IOException,
                     InterruptedException

Throws:

IOException

InterruptedException

downloadAll

public int downloadAll(String bucketName,
                       String pathPrefix,
                       String fileMask,
                       String excludes,
                       boolean useDefaultExcludes,
                       FilePath target)
                throws IOException,
                       InterruptedException

Throws:

IOException

InterruptedException

delete

public void delete(String bucketName,
                   String pathPrefix)

rename

public void rename(String bucketName,
                   String currentPathPrefix,
                   String newPathPrefix)