VCloudHttpApiModule (Apache jclouds 1.7.3 API)

java.lang.Object
- com.google.inject.AbstractModule
- - org.jclouds.rest.config.RestModule
  - - org.jclouds.rest.config.HttpApiModule<VCloudApi>
    - - org.jclouds.vcloud.config.VCloudHttpApiModule

All Implemented Interfaces:

com.google.inject.Module
```
public class VCloudHttpApiModule
extends HttpApiModule<VCloudApi>
```
Configures the VCloud authentication service connection, including logging and http transport.

Author:

Adrian Cole

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`VCloudHttpApiModule.OrgCatalogItemSupplier`
`static class`	`VCloudHttpApiModule.OrgCatalogSupplier`
`static class`	`VCloudHttpApiModule.OrgMapSupplier`
`static class`	`VCloudHttpApiModule.OrgVDCSupplier`
`static class`	`VCloudHttpApiModule.URItoVDC`

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

Constructor Summary

Constructors
Constructor and Description

VCloudHttpApiModule()

Constructors
Constructor and Description
`VCloudHttpApiModule()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`bindCacheLoaders()`
`protected void`	`bindErrorHandlers()` overrides this to change the default error handlers for the http engine ex.
`protected void`	`configure()`
`protected FenceMode`	`defaultFenceMode(String fenceMode)`
`protected com.google.common.cache.LoadingCache<URI,Envelope>`	`envelopes(com.google.common.cache.CacheLoader<URI,Envelope> envelopes)`
`protected void`	`installDefaultVCloudEndpointsModule()`
`protected void`	`installLocations()`
`protected com.google.common.base.Supplier<URI>`	`provideAuthenticationURI(VCloudVersionsApi versionService, String version)`
`protected com.google.common.base.Supplier<Org>`	`provideOrg(com.google.common.base.Supplier<Map<String,Org>> orgSupplier, com.google.common.base.Supplier<ReferenceType> defaultOrg)`
`protected com.google.common.base.Supplier<Map<String,Map<String,Catalog>>>`	`provideOrgCatalogItemMapSupplierCache(long seconds, AtomicReference<AuthorizationException> authException, VCloudHttpApiModule.OrgCatalogSupplier supplier)`
`protected com.google.common.base.Supplier<Map<String,Map<String,Map<String,CatalogItem>>>>`	`provideOrgCatalogItemSupplierCache(long seconds, AtomicReference<AuthorizationException> authException, VCloudHttpApiModule.OrgCatalogItemSupplier supplier)`
`protected com.google.common.base.Supplier<URI>`	`provideOrgListURI(com.google.common.base.Supplier<VCloudSession> sessionSupplier)`
`protected com.google.common.base.Supplier<Map<String,Org>>`	`provideOrgMapCache(long seconds, AtomicReference<AuthorizationException> authException, VCloudHttpApiModule.OrgMapSupplier supplier)`
`protected com.google.common.base.Supplier<Map<String,Map<String,VDC>>>`	`provideOrgVDCSupplierCache(long seconds, AtomicReference<AuthorizationException> authException, VCloudHttpApiModule.OrgVDCSupplier supplier)`
`protected com.google.common.base.Supplier<Map<URI,VDC>>`	`provideURIToVDC(long seconds, AtomicReference<AuthorizationException> authException, VCloudHttpApiModule.URItoVDC supplier)`
`protected com.google.common.base.Supplier<VCloudSession>`	`provideVCloudTokenCache(long seconds, AtomicReference<AuthorizationException> authException, VCloudLoginApi login)`
`protected com.google.common.base.Supplier<Map<String,ReferenceType>>`	`provideVDCtoORG(long seconds, AtomicReference<AuthorizationException> authException, org.jclouds.vcloud.config.VCloudHttpApiModule.OrgNameToOrgSupplier supplier)`
`protected com.google.common.base.Supplier<Map<String,String>>`	`provideVDCtoORG(com.google.common.base.Supplier<Map<String,Org>> orgNameToOrgSupplier)`
`protected com.google.common.base.Predicate<URI>`	`successTester(com.google.inject.Injector injector, long completed)`
`protected com.google.common.cache.LoadingCache<URI,VAppTemplate>`	`vAppTemplates(com.google.common.cache.CacheLoader<URI,VAppTemplate> vAppTemplates)`

Methods inherited from class org.jclouds.rest.config.HttpApiModule
bindRetryHandlers

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
- VCloudHttpApiModule
```
public VCloudHttpApiModule()
```

Method Detail

provideVCloudTokenCache

@Provides
@Singleton
protected com.google.common.base.Supplier<VCloudSession> provideVCloudTokenCache(@Named(value="jclouds.session-interval")
                                                                                        long seconds,
                                                                                        AtomicReference<AuthorizationException> authException,
                                                                                        VCloudLoginApi login)

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

configure in class HttpApiModule<VCloudApi>

bindCacheLoaders
```
protected void bindCacheLoaders()
```

provideVDCtoORG

@Provides
@Singleton
protected com.google.common.base.Supplier<Map<String,String>> provideVDCtoORG(com.google.common.base.Supplier<Map<String,Org>> orgNameToOrgSupplier)

provideOrgMapCache

@Provides
@Singleton
protected com.google.common.base.Supplier<Map<String,Org>> provideOrgMapCache(@Named(value="jclouds.session-interval")
                                                                                     long seconds,
                                                                                     AtomicReference<AuthorizationException> authException,
                                                                                     VCloudHttpApiModule.OrgMapSupplier supplier)

provideOrgListURI

@Provides
@Singleton
protected com.google.common.base.Supplier<URI> provideOrgListURI(com.google.common.base.Supplier<VCloudSession> sessionSupplier)

installDefaultVCloudEndpointsModule

protected void installDefaultVCloudEndpointsModule()

provideVDCtoORG

@Provides
@Singleton
protected com.google.common.base.Supplier<Map<String,ReferenceType>> provideVDCtoORG(@Named(value="jclouds.session-interval")
                                                                                            long seconds,
                                                                                            AtomicReference<AuthorizationException> authException,
                                                                                            org.jclouds.vcloud.config.VCloudHttpApiModule.OrgNameToOrgSupplier supplier)

provideURIToVDC

@Provides
@Singleton
protected com.google.common.base.Supplier<Map<URI,VDC>> provideURIToVDC(@Named(value="jclouds.session-interval")
                                                                               long seconds,
                                                                               AtomicReference<AuthorizationException> authException,
                                                                               VCloudHttpApiModule.URItoVDC supplier)

provideAuthenticationURI

@Provides
@Singleton
protected com.google.common.base.Supplier<URI> provideAuthenticationURI(VCloudVersionsApi versionService,
                                                                               String version)

provideOrg

@Provides
@Singleton
protected com.google.common.base.Supplier<Org> provideOrg(com.google.common.base.Supplier<Map<String,Org>> orgSupplier,
                                                                 com.google.common.base.Supplier<ReferenceType> defaultOrg)

successTester

@Provides
@Singleton
protected com.google.common.base.Predicate<URI> successTester(com.google.inject.Injector injector,
                                                                     @Named(value="jclouds.vcloud.timeout.task-complete")
                                                                     long completed)

provideOrgCatalogItemMapSupplierCache

@Provides
@Singleton
protected com.google.common.base.Supplier<Map<String,Map<String,Catalog>>> provideOrgCatalogItemMapSupplierCache(@Named(value="jclouds.session-interval")
                                                                                                                        long seconds,
                                                                                                                        AtomicReference<AuthorizationException> authException,
                                                                                                                        VCloudHttpApiModule.OrgCatalogSupplier supplier)

provideOrgVDCSupplierCache

@Provides
@Singleton
protected com.google.common.base.Supplier<Map<String,Map<String,VDC>>> provideOrgVDCSupplierCache(@Named(value="jclouds.session-interval")
                                                                                                         long seconds,
                                                                                                         AtomicReference<AuthorizationException> authException,
                                                                                                         VCloudHttpApiModule.OrgVDCSupplier supplier)

provideOrgCatalogItemSupplierCache

@Provides
@Singleton
protected com.google.common.base.Supplier<Map<String,Map<String,Map<String,CatalogItem>>>> provideOrgCatalogItemSupplierCache(@Named(value="jclouds.session-interval")
                                                                                                                                     long seconds,
                                                                                                                                     AtomicReference<AuthorizationException> authException,
                                                                                                                                     VCloudHttpApiModule.OrgCatalogItemSupplier supplier)

defaultFenceMode

@Provides
@Singleton
protected FenceMode defaultFenceMode(@Named(value="jclouds.vcloud.defaults.fencemode")
                                            String fenceMode)

vAppTemplates

@Provides
@Singleton
protected com.google.common.cache.LoadingCache<URI,VAppTemplate> vAppTemplates(com.google.common.cache.CacheLoader<URI,VAppTemplate> vAppTemplates)

envelopes

@Provides
@Singleton
protected com.google.common.cache.LoadingCache<URI,Envelope> envelopes(com.google.common.cache.CacheLoader<URI,Envelope> envelopes)

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 HttpApiModule<VCloudApi>

installLocations
```
protected void installLocations()
```
Overrides:

installLocations in class RestModule

Class VCloudHttpApiModule

Nested Class Summary

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.rest.config.HttpApiModule

Methods inherited from class com.google.inject.AbstractModule

Methods inherited from class java.lang.Object

Constructor Detail

VCloudHttpApiModule

Method Detail

provideVCloudTokenCache

configure

bindCacheLoaders

provideVDCtoORG

provideOrgMapCache

provideOrgListURI

installDefaultVCloudEndpointsModule

provideVDCtoORG

provideURIToVDC

provideAuthenticationURI

provideOrg

successTester

provideOrgCatalogItemMapSupplierCache

provideOrgVDCSupplierCache

provideOrgCatalogItemSupplierCache

defaultFenceMode

vAppTemplates

envelopes

bindErrorHandlers

installLocations