Package com.adobe.testing.s3mock.service

Class BucketService

java.lang.Object

com.adobe.testing.s3mock.service.BucketService

public class BucketService
extends Object

Constructor Summary

Constructors

Constructor	Description
BucketService(BucketStore bucketStore, ObjectStore objectStore)

Method Summary

Modifier and Type	Method	Description
Bucket	createBucket(String bucketName, boolean objectLockEnabled)	Creates a Bucket identified by its name.
boolean	deleteBucket(String bucketName)
void	deleteBucketLifecycleConfiguration(String bucketName)
boolean	doesBucketExist(String bucketName)
Bucket	getBucket(String bucketName)	Retrieves a Bucket identified by its name.
BucketLifecycleConfiguration	getBucketLifecycleConfiguration(String bucketName)
ObjectLockConfiguration	getObjectLockConfiguration(String bucketName)
List<S3Object>	getS3Objects(String bucketName, String prefix)	Retrieves S3Objects from a bucket.
boolean	isBucketEmpty(String bucketName)
ListAllMyBucketsResult	listBuckets()
ListBucketResult	listObjectsV1(String bucketName, String prefix, String delimiter, String marker, String encodingType, Integer maxKeys)	Deprecated.
ListBucketResultV2	listObjectsV2(String bucketName, String prefix, String delimiter, String encodingType, String startAfter, Integer maxKeys, String continuationToken)
void	setBucketLifecycleConfiguration(String bucketName, BucketLifecycleConfiguration configuration)
void	setObjectLockConfiguration(String bucketName, ObjectLockConfiguration configuration)
void	verifyBucketDoesNotExist(String bucketName)
void	verifyBucketExists(String bucketName)
void	verifyBucketIsEmpty(String bucketName)
void	verifyBucketNameIsAllowed(String bucketName)	API Reference Bucket Naming.
void	verifyBucketObjectLockEnabled(String bucketName)
void	verifyEncodingType(String encodingType)
void	verifyMaxKeys(Integer maxKeys)

Methods inherited from class java.lang.Object

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

Constructor Details

BucketService

public BucketService(BucketStore bucketStore,
 ObjectStore objectStore)

Method Details

isBucketEmpty

public boolean isBucketEmpty(String bucketName)

doesBucketExist

public boolean doesBucketExist(String bucketName)

listBuckets

public ListAllMyBucketsResult listBuckets()

getBucket

public Bucket getBucket(String bucketName)

Retrieves a Bucket identified by its name.

Parameters:

bucketName - of the Bucket to be retrieved

Returns:

the Bucket or null if not found

createBucket

public Bucket createBucket(String bucketName,
 boolean objectLockEnabled)

Creates a Bucket identified by its name.

Parameters:

bucketName - of the Bucket to be created

Returns:

the Bucket

deleteBucket

public boolean deleteBucket(String bucketName)

setObjectLockConfiguration

public void setObjectLockConfiguration(String bucketName,
 ObjectLockConfiguration configuration)

getObjectLockConfiguration

public ObjectLockConfiguration getObjectLockConfiguration(String bucketName)

setBucketLifecycleConfiguration

public void setBucketLifecycleConfiguration(String bucketName,
 BucketLifecycleConfiguration configuration)

deleteBucketLifecycleConfiguration

public void deleteBucketLifecycleConfiguration(String bucketName)

getBucketLifecycleConfiguration

public BucketLifecycleConfiguration getBucketLifecycleConfiguration(String bucketName)

getS3Objects

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

Retrieves S3Objects from a bucket.

Parameters:

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

prefix - String object file name starts with

Returns:

S3Objects found in bucket for the given prefix

listObjectsV2

public ListBucketResultV2 listObjectsV2(String bucketName,
 String prefix,
 String delimiter,
 String encodingType,
 String startAfter,
 Integer maxKeys,
 String continuationToken)

listObjectsV1

@Deprecated
public ListBucketResult listObjectsV1(String bucketName,
 String prefix,
 String delimiter,
 String marker,
 String encodingType,
 Integer maxKeys)

Deprecated.

verifyBucketExists

public void verifyBucketExists(String bucketName)

verifyBucketObjectLockEnabled

public void verifyBucketObjectLockEnabled(String bucketName)

verifyBucketNameIsAllowed

public void verifyBucketNameIsAllowed(String bucketName)

API Reference Bucket Naming.

verifyBucketIsEmpty

public void verifyBucketIsEmpty(String bucketName)

verifyBucketDoesNotExist

public void verifyBucketDoesNotExist(String bucketName)

verifyMaxKeys

public void verifyMaxKeys(Integer maxKeys)

verifyEncodingType

public void verifyEncodingType(String encodingType)