com.adobe.testing.s3mock.domain

Class FileStore

java.lang.Object

com.adobe.testing.s3mock.domain.FileStore

@Component
public class FileStore
extends Object

S3 Mock file store.

Constructor Summary

Constructors

Constructor and Description
FileStore(String rootDirectory) Constructs a new FileStore.

Method Summary

Modifier and Type	Method and Description
void	abortMultipartUpload(String bucketName, String fileName, String uploadId) Aborts the upload.
String	completeMultipartUpload(String bucketName, String fileName, String uploadId) Finishes the upload.
String	completeMultipartUpload(String bucketName, String fileName, String uploadId, String encryption, String kmsKeyId) Completes an Multipart Upload for the given Id.
String	copyPart(String bucket, String key, int from, int to, String partNumber, String destinationBucket, String destinationFilename, String uploadId) Copies the range, define by from/to, from the S3 Object, identified by the given key to given destination into the given bucket.
CopyObjectResult	copyS3Object(String sourceBucketName, String sourceObjectName, String destinationBucketName, String destinationObjectName) Copies an object, identified by bucket and name, to a another bucket and objectName.
CopyObjectResult	copyS3ObjectEncrypted(String sourceBucketName, String sourceObjectName, String destinationBucketName, String destinationObjectName, String encryption, String kmsKeyId) Copies an object to another bucket and encrypted object.
Bucket	createBucket(String bucketName) Creates a new bucket.
boolean	deleteBucket(String bucketName) Deletes a Bucket and all of its contents.
boolean	deleteObject(String bucketName, String objectName) Removes an object from a bucket.
Boolean	doesBucketExist(String bucketName) Checks if the specified bucket exists.
Bucket	getBucket(String bucketName) Retrieves a bucket identified by its name.
List<Part>	getMultipartUploadParts(String bucketName, String fileName, String uploadId) Get all multipart upload parts.
S3Object	getS3Object(String bucketName, String objectName) Retrieves an Object from a bucket.
List<S3Object>	getS3Objects(String bucketName, String prefix) Retrieves list of Objects from a bucket.
List<Bucket>	listBuckets() Lists all buckets managed by this FileStore.
Collection<MultipartUpload>	listMultipartUploads() Lists the not-yet completed parts of an multipart upload.
MultipartUpload	prepareMultipartUpload(String bucketName, String fileName, String contentType, String contentEncoding, String uploadId, Owner owner, Owner initiator) Prepares everything to store files uploaded as multipart upload.
MultipartUpload	prepareMultipartUpload(String bucketName, String fileName, String contentType, String contentEncoding, String uploadId, Owner owner, Owner initiator, Map<String,String> userMetadata) Prepares everything to store files uploaded as multipart upload.
String	putPart(String bucketName, String fileName, String uploadId, String partNumber, InputStream inputStream, boolean useV4ChunkedWithSigningFormat) Uploads a part of a multipart upload.
S3Object	putS3Object(String bucketName, String fileName, String contentType, String contentEncoding, InputStream dataStream, boolean useV4ChunkedWithSigningFormat) Stores a File inside a Bucket.
S3Object	putS3Object(String bucketName, String fileName, String contentType, String contentEncoding, InputStream dataStream, boolean useV4ChunkedWithSigningFormat, Map<String,String> userMetadata) Stores a File inside a Bucket.
S3Object	putS3ObjectWithKMSEncryption(String bucketName, String fileName, String contentType, InputStream dataStream, boolean useV4ChunkedWithSigningFormat, Map<String,String> userMetadata, String encryption, String kmsKeyId) Stores an encrypted File inside a Bucket.
S3Object	putS3ObjectWithKMSEncryption(String bucketName, String fileName, String contentType, InputStream dataStream, boolean useV4Signing, String encryption, String kmsKeyId) Stores an encrypted File inside a Bucket.
void	setObjectTags(String bucketName, String fileName, List<Tag> tags) Sets tags for a given object.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileStore

public FileStore(@Value(value="${root:}")
                 String rootDirectory)

Constructs a new FileStore.

Parameters:

rootDirectory - The directory to use. If omitted, a temp directory will be used.

Method Detail

createBucket

public Bucket createBucket(String bucketName)
                    throws IOException

Creates a new bucket.

Parameters:

bucketName - name of the Bucket to be created.

Returns:

the newly created Bucket.

Throws:

IOException - if the bucket cannot be created or the bucket already exists but is not a directory.

listBuckets

public List<Bucket> listBuckets()

Lists all buckets managed by this FileStore.

Returns:

List of all Buckets.

getBucket

public Bucket getBucket(String bucketName)

Retrieves a bucket identified by its name.

Parameters:

bucketName - name of the bucket to be retrieved

Returns:

the Bucket or null if not found

putS3Object

public S3Object putS3Object(String bucketName,
                            String fileName,
                            String contentType,
                            String contentEncoding,
                            InputStream dataStream,
                            boolean useV4ChunkedWithSigningFormat)
                     throws IOException

Stores a File inside a Bucket.

Parameters:

bucketName - Bucket to store the File in.

fileName - name of the File to be stored.

contentType - The files Content Type.

contentEncoding - The files Content Encoding.

dataStream - The File as InputStream.

useV4ChunkedWithSigningFormat - If true, V4-style signing is enabled.

Returns:

S3Object.

Throws:

IOException - if an I/O error occurs.

putS3Object

public S3Object putS3Object(String bucketName,
                            String fileName,
                            String contentType,
                            String contentEncoding,
                            InputStream dataStream,
                            boolean useV4ChunkedWithSigningFormat,
                            Map<String,String> userMetadata)
                     throws IOException

Stores a File inside a Bucket.

Parameters:

bucketName - Bucket to store the File in.

fileName - name of the File to be stored.

contentType - The files Content Type.

contentEncoding - The files Content Encoding.

dataStream - The File as InputStream.

useV4ChunkedWithSigningFormat - If true, V4-style signing is enabled.

userMetadata - User metadata to store for this object, will be available for the object with the key prefixed with "x-amz-meta-".

Returns:

S3Object.

Throws:

IOException - if an I/O error occurs.

putS3ObjectWithKMSEncryption

public S3Object putS3ObjectWithKMSEncryption(String bucketName,
                                             String fileName,
                                             String contentType,
                                             InputStream dataStream,
                                             boolean useV4Signing,
                                             String encryption,
                                             String kmsKeyId)
                                      throws IOException

Stores an encrypted File inside a Bucket.

Parameters:

bucketName - Bucket to store the File in.

fileName - name of the File to be stored.

contentType - The files Content Type.

dataStream - The File as InputStream.

useV4Signing - If true, V4-style signing is enabled.

encryption - The Encryption Type.

kmsKeyId - The KMS encryption key id.

Returns:

S3Object.

Throws:

IOException - if an I/O error occurs.

putS3ObjectWithKMSEncryption

public S3Object putS3ObjectWithKMSEncryption(String bucketName,
                                             String fileName,
                                             String contentType,
                                             InputStream dataStream,
                                             boolean useV4ChunkedWithSigningFormat,
                                             Map<String,String> userMetadata,
                                             String encryption,
                                             String kmsKeyId)
                                      throws IOException

Stores an encrypted File inside a Bucket.

Parameters:

bucketName - Bucket to store the File in.

fileName - name of the File to be stored.

contentType - The files Content Type.

dataStream - The File as InputStream.

useV4ChunkedWithSigningFormat - If true, V4-style signing is enabled.

userMetadata - User metadata to store for this object, will be available for the object with the key prefixed with "x-amz-meta-".

encryption - The Encryption Type.

kmsKeyId - The KMS encryption key id.

Returns:

S3Object.

Throws:

IOException - if an I/O error occurs.

setObjectTags

public void setObjectTags(String bucketName,
                          String fileName,
                          List<Tag> tags)
                   throws IOException

Sets tags for a given object.

Parameters:

bucketName - Bucket where the file is stored in.

fileName - name of the file to which tags have to be attached.

tags - List of tag objects.

Throws:

IOException - if an I/O error occurs.

getS3Object

public S3Object getS3Object(String bucketName,
                            String objectName)

Retrieves an Object from a bucket.

Parameters:

bucketName - the Bucket in which to look the file in.

objectName - name of the object.

Returns:

the retrieved S3Object or null if not found

getS3Objects

public List<S3Object> getS3Objects(String bucketName,
                                   String prefix)
                            throws IOException

Retrieves list of Objects from a bucket.

Parameters:

bucketName - the Bucket in which to list the file(s) in.

prefix - String object file name starts with

Returns:

the retrieved List<S3Object> or null if not found

Throws:

IOException - if directory stream fails

copyS3Object

public CopyObjectResult copyS3Object(String sourceBucketName,
                                     String sourceObjectName,
                                     String destinationBucketName,
                                     String destinationObjectName)
                              throws IOException

Copies an object, identified by bucket and name, to a another bucket and objectName.

Parameters:

sourceBucketName - name of the bucket to copy from.

sourceObjectName - name of the object to copy.

destinationBucketName - name of the destination bucket.

destinationObjectName - name of the destination object.

Returns:

an CopyObjectResult or null if source couldn't be found.

Throws:

FileNotFoundException - no FileInputStream of the sourceFile can be created.

IOException - If File can't be read.

copyS3ObjectEncrypted

public CopyObjectResult copyS3ObjectEncrypted(String sourceBucketName,
                                              String sourceObjectName,
                                              String destinationBucketName,
                                              String destinationObjectName,
                                              String encryption,
                                              String kmsKeyId)
                                       throws IOException

Copies an object to another bucket and encrypted object.

Parameters:

sourceBucketName - name of the bucket to copy from.

sourceObjectName - name of the object to copy.

destinationBucketName - name of the destination bucket.

destinationObjectName - name of the destination object.

encryption - The Encryption Type.

kmsKeyId - The KMS encryption key id.

Returns:

an CopyObjectResult or null if source couldn't be found.

Throws:

FileNotFoundException - no FileInputStream of the sourceFile can be created.

IOException - If File can't be read.

doesBucketExist

public Boolean doesBucketExist(String bucketName)

Checks if the specified bucket exists. Amazon S3 buckets are named in a global namespace; use this method to determine if a specified bucket name already exists, and therefore can't be used to create a new bucket.

Parameters:

bucketName - Name of the bucket to check for existence

Returns:

true if Bucket exists

deleteObject

public boolean deleteObject(String bucketName,
                            String objectName)
                     throws IOException

Removes an object from a bucket.

Parameters:

bucketName - name of the bucket containing the object.

objectName - name of the object to be deleted.

Returns:

true if deletion succeeded.

Throws:

IOException - if File could not be accessed.

deleteBucket

public boolean deleteBucket(String bucketName)
                     throws IOException

Deletes a Bucket and all of its contents.

Parameters:

bucketName - name of the bucket to be deleted.

Returns:

true if deletion succeeded.

Throws:

IOException - if bucket-file could not be accessed.

prepareMultipartUpload

public MultipartUpload prepareMultipartUpload(String bucketName,
                                              String fileName,
                                              String contentType,
                                              String contentEncoding,
                                              String uploadId,
                                              Owner owner,
                                              Owner initiator,
                                              Map<String,String> userMetadata)

Prepares everything to store files uploaded as multipart upload.

Parameters:

bucketName - in which to upload

fileName - of the file to upload

contentType - the content type

contentEncoding - the content encoding

uploadId - id of the upload

owner - owner of the upload

initiator - initiator of the upload

userMetadata - custom metadata

Returns:

upload result

prepareMultipartUpload

public MultipartUpload prepareMultipartUpload(String bucketName,
                                              String fileName,
                                              String contentType,
                                              String contentEncoding,
                                              String uploadId,
                                              Owner owner,
                                              Owner initiator)

Prepares everything to store files uploaded as multipart upload.

Parameters:

bucketName - in which to upload

fileName - of the file to upload

contentType - the content type

contentEncoding - the content encoding

uploadId - id of the upload

owner - owner of the upload

initiator - initiator of the upload

Returns:

upload result

listMultipartUploads

public Collection<MultipartUpload> listMultipartUploads()

Lists the not-yet completed parts of an multipart upload.

Returns:

the list of not-yet completed multipart uploads.

abortMultipartUpload

public void abortMultipartUpload(String bucketName,
                                 String fileName,
                                 String uploadId)

Aborts the upload.

Parameters:

bucketName - to which was uploaded

fileName - which was uploaded

uploadId - of the upload

putPart

public String putPart(String bucketName,
                      String fileName,
                      String uploadId,
                      String partNumber,
                      InputStream inputStream,
                      boolean useV4ChunkedWithSigningFormat)
               throws IOException

Uploads a part of a multipart upload.

Parameters:

bucketName - in which to upload

fileName - of the file to upload

uploadId - id of the upload

partNumber - number of the part to store

inputStream - file data to be stored

useV4ChunkedWithSigningFormat - If true, V4-style signing is enabled.

Returns:

the md5 hash of this part

Throws:

IOException - if file could not be read to calculate digest

completeMultipartUpload

public String completeMultipartUpload(String bucketName,
                                      String fileName,
                                      String uploadId)

Finishes the upload.

Parameters:

bucketName - to which was uploaded.

fileName - which was uploaded.

uploadId - of the upload.

Returns:

the etag of the complete file.

completeMultipartUpload

public String completeMultipartUpload(String bucketName,
                                      String fileName,
                                      String uploadId,
                                      String encryption,
                                      String kmsKeyId)

Completes an Multipart Upload for the given Id.

Parameters:

bucketName - in which to upload.

fileName - of the file to upload.

uploadId - id of the upload.

encryption - The Encryption Type.

kmsKeyId - The KMS encryption key id.

Returns:

etag of the uploaded file.

getMultipartUploadParts

public List<Part> getMultipartUploadParts(String bucketName,
                                          String fileName,
                                          String uploadId)

Get all multipart upload parts.

Parameters:

bucketName - name of the bucket

fileName - name of the file (object key)

uploadId - upload identifier

Returns:

Array of Files

copyPart

public String copyPart(String bucket,
                       String key,
                       int from,
                       int to,
                       String partNumber,
                       String destinationBucket,
                       String destinationFilename,
                       String uploadId)
                throws IOException

Copies the range, define by from/to, from the S3 Object, identified by the given key to given destination into the given bucket.

Parameters:

bucket - The source Bucket.

key - Identifies the S3 Object.

from - Byte range form.

to - Byte range to.

partNumber - The part to copy.

destinationBucket - The Bucket the target file (will) reside in.

destinationFilename - The target file.

uploadId - id of the upload.

Returns:

etag of the uploaded file.

Throws:

IOException - When writing the file fails.