S3HttpApiModule (Apache jclouds 2.0.0 API)

java.lang.Object
- com.google.inject.AbstractModule
- - org.jclouds.rest.config.RestModule
  - - org.jclouds.rest.config.HttpApiModule<A>
    - - org.jclouds.aws.config.AWSHttpApiModule<S>
      - org.jclouds.s3.config.S3HttpApiModule<S>

All Implemented Interfaces:

com.google.inject.Module

Direct Known Subclasses:

AWSS3HttpApiModule
```
public class S3HttpApiModule<S extends S3Client>
extends AWSHttpApiModule<S>
```
Configures the S3 connection, including logging and http transport.

Field Summary
- Fields inherited from class org.jclouds.rest.config.HttpApiModule
  api
- Fields inherited from class org.jclouds.rest.config.RestModule
  authException

Constructor Summary

Constructors
Modifier Constructor and Description

S3HttpApiModule()

protected S3HttpApiModule(Class<S> syncClientType)

Constructors
Modifier	Constructor and Description
	`S3HttpApiModule()`
`protected`	`S3HttpApiModule(Class<S> syncClientType)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`bindErrorHandlers()` overrides this to change the default error handlers for the http engine ex.
`protected void`	`bindRequestSigner()`
`protected void`	`bindRetryHandlers()` overrides this to change the default retry handlers for the http engine ex.
`protected com.google.common.cache.LoadingCache<String,com.google.common.base.Optional<String>>`	`bucketToRegion(com.google.common.cache.CacheLoader<String,com.google.common.base.Optional<String>> loader)`
`protected com.google.common.cache.CacheLoader<String,com.google.common.base.Optional<String>>`	`bucketToRegion(com.google.common.base.Supplier<Set<String>> regionSupplier, S3Client client)`
`protected void`	`configure()`
`protected com.google.common.base.Supplier<String>`	`defaultRegionForBucket(com.google.common.base.Supplier<String> defaultRegion)`
`protected String`	`guiceProvideTimeStamp(com.google.common.base.Supplier<String> cache)`
`protected com.google.common.base.Supplier<Date>`	`guiceProvideTimeStampCacheDate(long seconds, com.google.common.base.Supplier<String> timestamp, DateService dateService)` borrowing concurrency code to ensure that caching takes place properly
`protected com.google.common.cache.CacheLoader<String,com.google.common.base.Optional<String>>`	`provideBucketToRegion(com.google.common.base.Supplier<Set<String>> regionSupplier, S3Client client)`
`protected com.google.common.base.Supplier<URI>`	`provideBucketURI(com.google.common.base.Supplier<String> defaultRegion, RegionToEndpointOrProviderIfNull regionToEndpoint)`
`protected com.google.common.base.Supplier<String>`	`provideDefaultRegionForBucket(com.google.common.base.Supplier<String> defaultRegion)`
`protected RequestSigner`	`provideRequestSigner(RequestAuthorizeSignature in)`
`protected String`	`provideTimeStamp(com.google.common.base.Supplier<String> cache)`
`protected com.google.common.base.Supplier<String>`	`provideTimeStampCache(long seconds, DateService dateService)` borrowing concurrency code to ensure that caching takes place properly
`protected com.google.common.base.Supplier<Date>`	`provideTimeStampCacheDate(long seconds, com.google.common.base.Supplier<String> timestamp, DateService dateService)`
`protected Date`	`provideTimeStampDate(com.google.common.base.Supplier<Date> cache)`

Methods inherited from class org.jclouds.aws.config.AWSHttpApiModule
provideRetryableCodes, provideRetryableServerCodes

Methods inherited from class org.jclouds.rest.config.RestModule
installLocations

Methods inherited from class com.google.inject.AbstractModule
addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

S3HttpApiModule
```
public S3HttpApiModule()
```

S3HttpApiModule

protected S3HttpApiModule(Class<S> syncClientType)

Method Detail

provideBucketToRegion

@Provides
@Singleton
protected final com.google.common.cache.CacheLoader<String,com.google.common.base.Optional<String>> provideBucketToRegion(com.google.common.base.Supplier<Set<String>> regionSupplier,
                                                                                                                           S3Client client)

bucketToRegion

protected com.google.common.cache.CacheLoader<String,com.google.common.base.Optional<String>> bucketToRegion(com.google.common.base.Supplier<Set<String>> regionSupplier,
                                                                                                 S3Client client)

bucketToRegion

@Provides
@Singleton
protected final com.google.common.cache.LoadingCache<String,com.google.common.base.Optional<String>> bucketToRegion(com.google.common.cache.CacheLoader<String,com.google.common.base.Optional<String>> loader)

provideDefaultRegionForBucket

@Provides
@Singleton
protected final com.google.common.base.Supplier<String> provideDefaultRegionForBucket(com.google.common.base.Supplier<String> defaultRegion)

defaultRegionForBucket

protected com.google.common.base.Supplier<String> defaultRegionForBucket(com.google.common.base.Supplier<String> defaultRegion)

provideBucketURI

@Provides
@Singleton
protected final com.google.common.base.Supplier<URI> provideBucketURI(com.google.common.base.Supplier<String> defaultRegion,
                                                                       RegionToEndpointOrProviderIfNull regionToEndpoint)

configure
```
protected void configure()
```
Overrides:

configure in class HttpApiModule<S extends S3Client>

bindErrorHandlers

protected void bindErrorHandlers()

Description copied from class: HttpApiModule

overrides this to change the default error handlers for the http engine ex.

 bind(HttpErrorHandler.class).annotatedWith(Redirection.class).to(ParseAWSErrorFromXmlContent.class);
 bind(HttpErrorHandler.class).annotatedWith(ClientError.class).to(ParseAWSErrorFromXmlContent.class);
 bind(HttpErrorHandler.class).annotatedWith(ServerError.class).to(ParseAWSErrorFromXmlContent.class);

Overrides:: bindErrorHandlers in class AWSHttpApiModule<S extends S3Client>

bindRequestSigner
```
protected void bindRequestSigner()
```

provideRequestSigner

@Provides
@Singleton
protected final RequestSigner provideRequestSigner(RequestAuthorizeSignature in)

bindRetryHandlers

protected void bindRetryHandlers()

Description copied from class: HttpApiModule

overrides this to change the default retry handlers for the http engine ex.

 bind(HttpRetryHandler.class).annotatedWith(Redirection.class).to(AWSRedirectionRetryHandler.class);
 bind(HttpRetryHandler.class).annotatedWith(ClientError.class).to(AWSClientErrorRetryHandler.class);

Overrides:: bindRetryHandlers in class AWSHttpApiModule<S extends S3Client>

guiceProvideTimeStamp

@Provides
protected final String guiceProvideTimeStamp(com.google.common.base.Supplier<String> cache)

provideTimeStamp

protected String provideTimeStamp(com.google.common.base.Supplier<String> cache)

provideTimeStampCache

@Provides
@Singleton
protected final com.google.common.base.Supplier<String> provideTimeStampCache(@Named(value="jclouds.session-interval")
                                                                               long seconds,
                                                                               DateService dateService)

borrowing concurrency code to ensure that caching takes place properly

provideTimeStampDate

@Provides
protected Date provideTimeStampDate(com.google.common.base.Supplier<Date> cache)

guiceProvideTimeStampCacheDate

@Provides
@Singleton
protected final com.google.common.base.Supplier<Date> guiceProvideTimeStampCacheDate(@Named(value="jclouds.session-interval")
                                                                                      long seconds,
                                                                                      com.google.common.base.Supplier<String> timestamp,
                                                                                      DateService dateService)

borrowing concurrency code to ensure that caching takes place properly

provideTimeStampCacheDate

protected com.google.common.base.Supplier<Date> provideTimeStampCacheDate(@Named(value="jclouds.session-interval")
                                                              long seconds,
                                                              com.google.common.base.Supplier<String> timestamp,
                                                              DateService dateService)

Class S3HttpApiModule<S extends S3Client>

Field Summary

Fields inherited from class org.jclouds.rest.config.HttpApiModule

Fields inherited from class org.jclouds.rest.config.RestModule

Constructor Summary

Method Summary

Methods inherited from class org.jclouds.aws.config.AWSHttpApiModule

Methods inherited from class org.jclouds.rest.config.RestModule

Methods inherited from class com.google.inject.AbstractModule

Methods inherited from class java.lang.Object

Constructor Detail

S3HttpApiModule

S3HttpApiModule

Method Detail

provideBucketToRegion

bucketToRegion

bucketToRegion

provideDefaultRegionForBucket

defaultRegionForBucket

provideBucketURI

configure

bindErrorHandlers

bindRequestSigner

provideRequestSigner

bindRetryHandlers

guiceProvideTimeStamp

provideTimeStamp

provideTimeStampCache

provideTimeStampDate

guiceProvideTimeStampCacheDate

provideTimeStampCacheDate