org.springframework.cloud

Class Cloud

java.lang.Object

org.springframework.cloud.Cloud

public class Cloud
extends Object

The main user-level API access to application and services for the app in which this instance is embedded in. The class connects application and the underlying cloud. Besides passing along information about the application instance, it allows simple access for using services. It uses ServiceInfos obtained using the underlying CloudConnector and allows translating those to service connector such as a DataSource. It also passes along information obtained through CloudConnector to let application take control on how to use bound services.

NOTE: Users or cloud providers shouldn't need to instantiate an instance of this class (constructor has package-access only for unit-testing purpose). Instead, they can obtain an appropriate instance through CloudFactory

Author:

Ramnivas Laddad

Method Summary

Modifier and Type	Method and Description
ApplicationInstanceInfo	getApplicationInstanceInfo()
Properties	getCloudProperties() Get properties for app and services.
<SC> SC	getServiceConnector(String serviceId, Class<SC> serviceConnectorType, ServiceConnectorConfig serviceConnectorConfig) Get a service connector for the given service id, the connector type, configured with the given config
ServiceInfo	getServiceInfo(String serviceId) Get ServiceInfo for the given service id
List<ServiceInfo>	getServiceInfos()
<T> List<ServiceInfo>	getServiceInfos(Class<T> serviceConnectorType) Get ServiceInfos for the bound services that could be mapped to the given service connector type.
<T extends ServiceInfo> List<T>	getServiceInfosByType(Class<T> serviceInfoType) Get all ServiceInfos for the given service info type.
<SC> SC	getSingletonServiceConnector(Class<SC> serviceConnectorType, ServiceConnectorConfig serviceConnectorConfig) Get the singleton service connector for the given connector type, configured with the given config
<T extends ServiceInfo> T	getSingletonServiceInfoByType(Class<T> serviceInfoType) Get the singleton ServiceInfo for the given service info type.
void	registerServiceConnectorCreator(ServiceConnectorCreator<?,? extends ServiceInfo> serviceConnectorCreator) Register a new service connector creator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getApplicationInstanceInfo

public ApplicationInstanceInfo getApplicationInstanceInfo()

Returns:

information about the application instance

See Also:

CloudConnector.getApplicationInstanceInfo()

getServiceInfo

public ServiceInfo getServiceInfo(String serviceId)

Get ServiceInfo for the given service id

Parameters:

serviceId - service id

Returns:

info for the serviceId

getServiceInfos

public List<ServiceInfo> getServiceInfos()

Returns:

information about all services bound to the application

See Also:

CloudConnector.getServiceInfos()

getServiceInfos

public <T> List<ServiceInfo> getServiceInfos(Class<T> serviceConnectorType)

Get ServiceInfos for the bound services that could be mapped to the given service connector type.

For example, if the connector type is DataSource, then the method will return all ServiceInfo objects matching bound relational database services.

Type Parameters:

T - The class of the connector to find services for.

Parameters:

serviceConnectorType - service connector type. Passing null returns all ServiceInfos (matching that of getServiceInfos()

Returns:

information about services bound to the application that could be transformed into the given connector type

getServiceInfosByType

public <T extends ServiceInfo> List<T> getServiceInfosByType(Class<T> serviceInfoType)

Get all ServiceInfos for the given service info type.

Unlike getServiceInfos(Class) which checks if the service info can be mapped to the given service connector type, this method only checks the type of the service info.

Type Parameters:

T - the class of service info to return

Parameters:

serviceInfoType - service info type

Returns:

a list of service info of the given type

getSingletonServiceInfoByType

public <T extends ServiceInfo> T getSingletonServiceInfoByType(Class<T> serviceInfoType)

Get the singleton ServiceInfo for the given service info type.

Type Parameters:

T - the class of service info to return

Parameters:

serviceInfoType - service info type

Returns:

the single service info of the given type

Throws:

CloudException - if there are either 0 or more than 1 service info of the given type.

getServiceConnector

public <SC> SC getServiceConnector(String serviceId,
                                   Class<SC> serviceConnectorType,
                                   ServiceConnectorConfig serviceConnectorConfig)

Get a service connector for the given service id, the connector type, configured with the given config

Type Parameters:

SC - The class of the service connector to return.

Parameters:

serviceId - the service id

serviceConnectorType - The expected class of service connector such as, DataSource.class.

serviceConnectorConfig - service connector configuration (such as pooling parameters).

Returns:

a service connector of the specified type with the given configuration applied

getSingletonServiceConnector

public <SC> SC getSingletonServiceConnector(Class<SC> serviceConnectorType,
                                            ServiceConnectorConfig serviceConnectorConfig)

Get the singleton service connector for the given connector type, configured with the given config

Type Parameters:

SC - The class of the service connector to return.

Parameters:

serviceConnectorType - The expected class of service connector such as, DataSource.class.

serviceConnectorConfig - service connector configuration (such as pooling parameters).

Returns:

the single service connector of the specified type with the given configuration applied

registerServiceConnectorCreator

public void registerServiceConnectorCreator(ServiceConnectorCreator<?,? extends ServiceInfo> serviceConnectorCreator)

Register a new service connector creator

Parameters:

serviceConnectorCreator - the service connector to register

getCloudProperties

public Properties getCloudProperties()

Get properties for app and services.

Application properties always include cloud.application.app-id and cloud.application.instance-id with values bound to application id and instance id. The rest of the properties are cloud-provider specific, but take the cloud.application.<property-name> form.

 cloud.application.app-id = helloworld
 cloud.application.instance-id = instance-0-0fab098f
 cloud.application.<property-name> = <property-value>
 

Service specific properties are exposed for each bound service, with each key starting in cloud.services. Like application properties, these too are cloud and service specific. Each key for a specific service starts with cloud.services.<service-id>

 cloud.services.customerDb.type = mysql-5.1
 cloud.services.customerDb.plan = free
 cloud.services.customerDb.connection.hostname = ...
 cloud.services.customerDb.connection.port = ...
 etc...
 

If a there is only a single service of a given type (as defined by the {link ServiceInfo.ServiceLabel} annoation's value of the corresponding ServiceInfo class), that service is aliased to the service type. Keys for such properties start in cloud.services.<service-type>. For example, if there is only a single MySQL service bound to the application, the service properties will also be exposed starting with 'cloud.services.mysql' key:

 cloud.services.mysql.type = mysql-5.1
 cloud.services.mysql.plan = free
 cloud.services.mysql.connection.hostname = ...
 cloud.services.mysql.connection.port = ...
 etc...
 

Returns:

the properties object