Package com.ksc.mission.base.s3

Class S3ClientConnector

  • All Implemented Interfaces:
    com.ksc.mission.base.interfaces.IFollow, com.ksc.mission.base.interfaces.ILog, com.ksc.mission.base.interfaces.Initializable<com.ksc.mission.base.relatedobjects.IOwnedService>, com.ksc.mission.base.interfaces.IOwned<com.ksc.mission.base.relatedobjects.IOwnedService,​com.ksc.mission.base.relatedobjects.OwningContainer>, com.ksc.mission.base.interfaces.IOwnedN<com.ksc.mission.base.relatedobjects.IOwnedService,​com.ksc.mission.base.relatedobjects.OwningContainer>, com.ksc.mission.base.interfaces.IOwner, com.ksc.mission.base.interfaces.ISave, com.ksc.mission.base.interfaces.ISend, com.ksc.mission.base.relatedobjects.IOwnedService, java.io.Serializable
    public class S3ClientConnector
extends com.ksc.mission.base.relatedobjects.OwnedService
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.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 Description
      S3ClientConnector​(com.amazonaws.services.s3.AmazonS3 s3Client, java.lang.String bucketName, boolean versioning)  

    • Method Summary

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

      • Methods inherited from class com.ksc.mission.base.relatedobjects.OwnedService

        loadClassFromJar

      • 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.interfaces.IFollow

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

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

        logDebug, logError, logError, logInfo, logWarn

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

        initializeFromObjects, initializeFromStrings

      • 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.IOwnedN

        delete, getOwner, getOwningCollection, save, setOwningCollection

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

        isLogger

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

        getRoot, isRoot

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

        getPublisherId, publish, publish, send, send

    • Field Detail

      • s3Client

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

      • bucketName

        protected final java.lang.String bucketName

    • Constructor Detail

      • S3ClientConnector

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

    • Method Detail

      • defaultS3Client

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

      • s3ClientFor

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

      • forBucket

        public static S3ClientConnector forBucket​(java.lang.String bucketName,
                                          boolean versioning)

      • start

        public void start()

      • setBucketVersioning

        public void setBucketVersioning​(boolean versioning)

      • deleteAllObjects

        public void deleteAllObjects()

      • deleteAllObjects

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

      • deleteObject

        public void deleteObject​(java.lang.String key)

      • deleteObjectVersion

        public void deleteObjectVersion​(java.lang.String key,
                                java.lang.String version)

      • createOrReplaceObject

        public void createOrReplaceObject​(java.lang.String key,
                                  java.lang.String contents)

      • getObject

        public void getObject​(java.lang.String key)

      • getObject

        public void getObject​(java.lang.String key,
                      java.lang.String versionId)

      • createOrReplaceObject

        public void createOrReplaceObject​(java.lang.String key,
                                  java.io.File file)

      • doesBucketExist

        public boolean doesBucketExist​(java.lang.String bucketName)

      • exists

        public boolean exists​(java.lang.String key)

      • listWithPrefix

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

      • listWithPattern

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

      • list

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

      • listVersions

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

      • listVersionsWithPattern

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

      • openPositionableReadStream

        public PositionableReadStream openPositionableReadStream​(java.lang.String key)

      • openPositionableReadStream

        public PositionableReadStream openPositionableReadStream​(java.lang.String key,
                                                         java.lang.String versionId)

      • openPositionableReadStream

        public PositionableReadStream openPositionableReadStream​(java.lang.String key,
                                                         long position)

      • openPositionableReadStream

        public PositionableReadStream openPositionableReadStream​(java.lang.String key,
                                                         java.lang.String versionId,
                                                         long position)

      • openPositionableReadStream

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

      • getObjectMetadata

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

      • getRange

        public boolean getRange​(java.lang.String file,
                        long position,
                        int[] buffer)

      • getRange

        public boolean getRange​(java.lang.String file,
                        java.lang.String versionId,
                        long position,
                        int[] buffer)

      • getRange

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

      • getVersionId

        public java.lang.String getVersionId​(java.lang.String key)