S3

Value Members

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

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

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

   

   Definition Classes

   AnyRef → Any

4. def apply[T](config: T)(implicit ws: StandaloneAhcWSClient, provider: URIProvider[T]): Try[WSS3]

   

   Tries to create a S3 client from an URI using the following format: s3:http://accessKey:[email protected]/?style=[virtualHost|path]

   Tries to create a S3 client from an URI using the following format: s3:http://accessKey:[email protected]/?style=[virtualHost|path]

   The accessKey and secretKey must not be URI-encoded.

   import play.api.libs.ws.ahc.StandaloneAhcWSClient
   import com.zengularity.benji.s3.S3
   
   def init1(implicit wc: StandaloneAhcWSClient) =
     S3("s3:http://accessKey:[email protected]/?style=virtualHost")
   
   // or
   def init2(implicit wc: StandaloneAhcWSClient) =
     S3(new java.net.URI("s3:https://accessKey:[email protected]/?style=path"))

   T

   the config type to be consumed by the provider typeclass

   config

   the config element used by the provider to generate the URI

   provider

   a typeclass that try to generate an URI from the config element

   returns

   Success if the WSS3 was properly created, otherwise Failure

5. def apply(accessKeyId: String, secretAccessKeyId: String, scheme: String, host: String)(implicit ws: StandaloneAhcWSClient): WSS3

   

   Returns the S3 client in the path style (and signature V1/V2).

   Returns the S3 client in the path style (and signature V1/V2).

   accessKeyId

   the user access key

   secretAccessKeyId

   the user secret key

   scheme

   the scheme

   host

   the host name (or IP address)

   returns

   A WSS3 instance configured to work with the S3-compatible API of a the server

   def init(implicit wc: play.api.libs.ws.ahc.StandaloneAhcWSClient) =
     com.zengularity.benji.s3.S3(
       accessKeyId = "accessKey",
       secretAccessKeyId = "secretAccessKey",
       scheme = "https",
       host = "s3.amazonaws.com")

6. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

7. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

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

   

   Definition Classes

   AnyRef

9. def equals(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

10. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

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

    

    Definition Classes

    AnyRef → Any

12. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

13. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

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

    

    Definition Classes

    AnyRef

15. final def notify(): Unit

    

    Definition Classes

    AnyRef

16. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

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

    

    Definition Classes

    AnyRef

18. def toString(): String

    

    Definition Classes

    AnyRef → Any

19. def virtualHost(accessKeyId: String, secretAccessKeyId: String, scheme: String, host: String)(implicit ws: StandaloneAhcWSClient): WSS3

    

    Returns the S3 client in the virtual host style.

    Returns the S3 client in the virtual host style. A S3 signature V1/V2 is used (see virtualHostAwsV4).

    accessKeyId

    the user access key

    secretAccessKeyId

    the user secret key

    scheme

    the scheme

    host

    the host name (or IP address)

    returns

    A WSS3 instance configured to work with the S3-compatible API of a the server

    def init(implicit wc: play.api.libs.ws.ahc.StandaloneAhcWSClient) =
      com.zengularity.benji.s3.S3.virtualHost(
        accessKeyId = "accessKey",
        secretAccessKeyId = "secretAccessKey",
        scheme = "https",
        host = "s3.amazonaws.com")

20. def virtualHostAwsV4(accessKeyId: String, secretAccessKeyId: String, scheme: String, host: String, region: String)(implicit ws: StandaloneAhcWSClient): WSS3

    

    Returns the S3 client in the virtual host style.

    Returns the S3 client in the virtual host style. A AWS signature V4 is used (see virtualHostAwsV4 and Signature Version 4 Signing Process.

    accessKeyId

    the user access key

    secretAccessKeyId

    the user secret key

    scheme

    the scheme

    host

    the host name (or IP address)

    region

    the AWS/S3 region

    returns

    A WSS3 instance configured to work with the AWS V4

    def init(implicit wc: play.api.libs.ws.ahc.StandaloneAhcWSClient) =
      com.zengularity.benji.s3.S3.virtualHostAwsV4(
        accessKeyId = "accessKey",
        secretAccessKeyId = "secretAccessKey",
        scheme = "https",
        host = "s3.amazonaws.com",
        region = "us-east-1")

21. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )