services.s3

S3ByteStorageService

class S3ByteStorageService extends ByteStorageService

A ByteStorageService for Clowder that enables use of S3-compatible object stores to serve as the file backing for Clowder. This allows you to use an S3 bucket on AWS or Minio to store your files.

Available Configuration Options: clowder.s3.serviceEndpoint - Host/port of the service to use for storage clowder.s3.bucketName - the name of the bucket that should be used to store files clowder.s3.accessKey - access key with which to access the bucket clowder.s3.secretKey - secret key associated with the access key above clowder.s3.region - the region where your S3 bucket lives (currently unused)

Linear Supertypes
ByteStorageService, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. S3ByteStorageService
  2. ByteStorageService
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new S3ByteStorageService()

    Annotations
    @Inject()

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def delete(fullPath: String, ignored: String): Boolean

    Given a path, delete the file located at the path within the configured S3 bucket.

    Given a path, delete the file located at the path within the configured S3 bucket.

    fullPath

    the path of the file inside the bucket

    ignored

    unused parameter in this context

    returns

    true, if bytes were deleted

    Definition Classes
    S3ByteStorageService → ByteStorageService

  9. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  12. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  13. def handleACE(ace: AmazonClientException): None.type

  14. def handleASE(ase: AmazonServiceException): None.type

  15. def handleIOE(err: IOException): None.type

  16. def handleUnknownError(err: Exception = null): None.type

  17. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  19. def load(fullPath: String, ignored: String): Option[InputStream]

    Given a path, retrieve the bytes located at that path inside the configured S3 bucket.

    Given a path, retrieve the bytes located at that path inside the configured S3 bucket.

    fullPath

    the full path of the file to load

    ignored

    unused parameter in this context

    returns

    a stream of bytes read from the file

    Definition Classes
    S3ByteStorageService → ByteStorageService

  20. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  23. def parsePath(fullPath: String): (Option[String], Option[String], Option[String])

    Given a fullPath (e.

    Given a fullPath (e.g. serviceEndpoint, bucketName, fileName), parse the path and return the separate segments.

    fullPath

    the full path to parse into segments

    returns

    the different segments within the path

  24. def s3Bucket(serviceEndpoint: Option[String] = ...): AmazonS3

    Grabs config parameters from Clowder to return a AmazonS3 pointing at the given service endpoint.

    Grabs config parameters from Clowder to return a AmazonS3 pointing at the given service endpoint. By default, the configured bucket will be used.

    serviceEndpoint

    the endpoint to connect to

    returns

    an AmazonS3 client

  25. def s3Bucket(serviceEndpoint: String): AmazonS3

    Convenience method for calling s3Bucket with a String instead of an Option[String].

    Convenience method for calling s3Bucket with a String instead of an Option[String].

    serviceEndpoint

    the endpoint to connect to

    returns

    an AmazonS3 client

  26. def save(inputStream: InputStream, ignored: String): Option[(String, Long)]

    Store bytes to the specified path within the configured S3 bucket.

    Store bytes to the specified path within the configured S3 bucket.

    inputStream

    stream of bytes to save to the bucket

    ignored

    unused parameter in this context

    returns

    (path to file aka loader_id, length of file)

    Definition Classes
    S3ByteStorageService → ByteStorageService

  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  28. def toString(): String

    Definition Classes
    AnyRef → Any

  29. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ByteStorageService

Inherited from AnyRef

Inherited from Any

Ungrouped