com.ksc.mission.base.s3

Class S3ClientConnector

java.lang.Object

com.ksc.mission.base.relatedobjects.OwnedObject<IOwnedService,OwningContainer>

com.ksc.mission.base.relatedobjects.OwnedService

com.ksc.mission.base.s3.S3ClientConnector

All Implemented Interfaces:

IFollow, ILog, Initializable<IOwnedService>, IOwned<IOwnedService,OwningContainer>, IOwnedN<IOwnedService,OwningContainer>, IOwner, ISave, ISend, IOwnedService, Serializable

public class S3ClientConnector
extends OwnedService

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	bucketName
protected com.amazonaws.services.s3.AmazonS3	s3Client

Fields inherited from class com.ksc.mission.base.relatedobjects.OwnedObject

id, owningCollection

Constructor Summary

Constructors

Constructor and Description
S3ClientConnector(com.amazonaws.services.s3.AmazonS3 s3Client, String bucketName, boolean versioning)

Method Summary

Modifier and Type	Method and Description
void	createOrReplaceObject(String key, File file)
void	createOrReplaceObject(String key, String contents)
static com.amazonaws.services.s3.AmazonS3	defaultS3Client()
void	deleteAllObjects()
void	deleteAllObjects(List<com.amazonaws.services.s3.model.DeleteObjectsRequest.KeyVersion> keyVersions)
void	deleteObject(String key)
void	deleteObjectVersion(String key, String version)
boolean	doesBucketExist(String bucketName)
boolean	exists(String key)
static S3ClientConnector	forBucket(String bucketName, boolean versioning)
void	getObject(String key)
void	getObject(String key, String versionId)
com.amazonaws.services.s3.model.ObjectMetadata	getObjectMetadata(String key, String versionId)
boolean	getRange(com.amazonaws.services.s3.model.GetObjectRequest request, int[] buffer)
boolean	getRange(String file, long position, int[] buffer)
boolean	getRange(String file, String versionId, long position, int[] buffer)
String	getVersionId(String key)
List<com.amazonaws.services.s3.model.S3ObjectSummary>	list()
List<com.amazonaws.services.s3.model.S3VersionSummary>	listVersions(String prefix)
List<com.amazonaws.services.s3.model.S3VersionSummary>	listVersionsWithPattern(String pattern)
List<com.amazonaws.services.s3.model.S3ObjectSummary>	listWithPattern(String pattern)
List<com.amazonaws.services.s3.model.S3ObjectSummary>	listWithPrefix(String prefix)
PositionableReadStream	openPositionableReadStream(String key)
PositionableReadStream	openPositionableReadStream(String key, long position)
PositionableReadStream	openPositionableReadStream(String key, com.amazonaws.services.s3.model.ObjectMetadata metadata, long position)
PositionableReadStream	openPositionableReadStream(String key, String versionId)
PositionableReadStream	openPositionableReadStream(String key, String versionId, long position)
static com.amazonaws.services.s3.AmazonS3	s3ClientFor(String endpoint, String region, com.amazonaws.auth.AWSCredentials credentialsProvider)
void	setBucketVersioning(boolean versioning)
void	start()

Methods inherited from class com.ksc.mission.base.relatedobjects.OwnedObject

_nextId, delete, exists, getDescription, getHighestUnsavedOwner, getId, getOwner, getOwningCollection, getPublisherId, getRoot, hasBeenSaved, initializeFromObjects, initializeFromStrings, isRoot, save, setId, setOwningCollection, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ksc.mission.base.relatedobjects.IOwnedService

isLogger

Methods inherited from interface com.ksc.mission.base.interfaces.IOwnedN

delete, getOwner, getOwningCollection, save, setOwningCollection

Methods inherited from interface com.ksc.mission.base.interfaces.IOwned

exists, getDescription, getHighestUnsavedOwner, getId, getLocatorPath, getMessageHub, hasBeenSaved, setId, toString

Methods inherited from interface com.ksc.mission.base.interfaces.IOwner

getRoot, isRoot

Methods inherited from interface com.ksc.mission.base.interfaces.ILog

logDebug, logError, logError, logInfo, logWarn

Methods inherited from interface com.ksc.mission.base.interfaces.ISend

getPublisherId, publish, publish, send, send

Methods inherited from interface com.ksc.mission.base.interfaces.IFollow

listen, listen, stopListening, stopListening, subscribe, subscribe, unsubscribe, unsubscribe

Methods inherited from interface com.ksc.mission.base.interfaces.Initializable

initializeFromObjects, initializeFromStrings

Field Detail

s3Client

protected final transient com.amazonaws.services.s3.AmazonS3 s3Client

bucketName

protected final String bucketName

Constructor Detail

S3ClientConnector

public S3ClientConnector(com.amazonaws.services.s3.AmazonS3 s3Client,
                         String bucketName,
                         boolean versioning)

Method Detail

defaultS3Client

public static com.amazonaws.services.s3.AmazonS3 defaultS3Client()

s3ClientFor

public static com.amazonaws.services.s3.AmazonS3 s3ClientFor(String endpoint,
                                                             String region,
                                                             com.amazonaws.auth.AWSCredentials credentialsProvider)

forBucket

public static S3ClientConnector forBucket(String bucketName,
                                          boolean versioning)

start

public void start()

setBucketVersioning

public void setBucketVersioning(boolean versioning)

deleteAllObjects

public void deleteAllObjects()

deleteAllObjects

public void deleteAllObjects(List<com.amazonaws.services.s3.model.DeleteObjectsRequest.KeyVersion> keyVersions)

deleteObject

public void deleteObject(String key)

deleteObjectVersion

public void deleteObjectVersion(String key,
                                String version)

createOrReplaceObject

public void createOrReplaceObject(String key,
                                  String contents)

getObject

public void getObject(String key)

getObject

public void getObject(String key,
                      String versionId)

createOrReplaceObject

public void createOrReplaceObject(String key,
                                  File file)

doesBucketExist

public boolean doesBucketExist(String bucketName)

exists

public boolean exists(String key)

listWithPrefix

public List<com.amazonaws.services.s3.model.S3ObjectSummary> listWithPrefix(String prefix)

listWithPattern

public List<com.amazonaws.services.s3.model.S3ObjectSummary> listWithPattern(String pattern)

list

public List<com.amazonaws.services.s3.model.S3ObjectSummary> list()

listVersions

public List<com.amazonaws.services.s3.model.S3VersionSummary> listVersions(String prefix)

listVersionsWithPattern

public List<com.amazonaws.services.s3.model.S3VersionSummary> listVersionsWithPattern(String pattern)

openPositionableReadStream

public PositionableReadStream openPositionableReadStream(String key)

openPositionableReadStream

public PositionableReadStream openPositionableReadStream(String key,
                                                         String versionId)

openPositionableReadStream

public PositionableReadStream openPositionableReadStream(String key,
                                                         long position)

openPositionableReadStream

public PositionableReadStream openPositionableReadStream(String key,
                                                         String versionId,
                                                         long position)

openPositionableReadStream

public PositionableReadStream openPositionableReadStream(String key,
                                                         com.amazonaws.services.s3.model.ObjectMetadata metadata,
                                                         long position)

getObjectMetadata

public com.amazonaws.services.s3.model.ObjectMetadata getObjectMetadata(String key,
                                                                        String versionId)

getRange

public boolean getRange(String file,
                        long position,
                        int[] buffer)

getRange

public boolean getRange(String file,
                        String versionId,
                        long position,
                        int[] buffer)

getRange

public boolean getRange(com.amazonaws.services.s3.model.GetObjectRequest request,
                        int[] buffer)

getVersionId

public String getVersionId(String key)