org.springframework.cloud.config.java

Class CloudServiceConnectionFactory

java.lang.Object

org.springframework.cloud.config.java.CloudServiceConnectionFactory

All Implemented Interfaces:

ServiceConnectionFactory

public class CloudServiceConnectionFactory
extends java.lang.Object
implements ServiceConnectionFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.cloud.Cloud	cloud

Constructor Summary

Constructors

Constructor and Description
CloudServiceConnectionFactory(org.springframework.cloud.Cloud cloud)

Method Summary

Methods

Modifier and Type	Method and Description
javax.sql.DataSource	dataSource() Get the DataSource object associated with the only relational database service bound to the app.
javax.sql.DataSource	dataSource(DataSourceConfig dataSourceConfig) Get the DataSource object associated with the only relational database service bound to the app configured as specified.
javax.sql.DataSource	dataSource(java.lang.String serviceId) Get the DataSource object for the specified relational database service.
javax.sql.DataSource	dataSource(java.lang.String serviceId, DataSourceConfig dataSourceConfig) Get the DataSource object for the specified relational database service configured as specified.
org.springframework.data.mongodb.MongoDbFactory	mongoDbFactory() Get the MongoDbFactory object associated with the only MongoDB service bound to the app.
org.springframework.data.mongodb.MongoDbFactory	mongoDbFactory(MongoDbFactoryConfig mongoDbFactoryConfig) Get the MongoDbFactory object associated with the only MongoDB service bound to the app configured as specified.
org.springframework.data.mongodb.MongoDbFactory	mongoDbFactory(java.lang.String serviceId) Get the MongoDbFactory object for the specified MongoDB service.
org.springframework.data.mongodb.MongoDbFactory	mongoDbFactory(java.lang.String serviceId, MongoDbFactoryConfig mongoDbFactoryConfig) Get the MongoDbFactory object for the specified MongoDB service configured as specified.
org.springframework.amqp.rabbit.connection.ConnectionFactory	rabbitConnectionFactory() Get the ConnectionFactory object associated with the only RabbitMQ service bound to the app.
org.springframework.amqp.rabbit.connection.ConnectionFactory	rabbitConnectionFactory(RabbitConnectionFactoryConfig rabbitConnectionFactoryConfig) Get the ConnectionFactory object associated with the only RabbitMQ service bound to the app configured as specified.
org.springframework.amqp.rabbit.connection.ConnectionFactory	rabbitConnectionFactory(java.lang.String serviceId) Get the ConnectionFactory object for the specified RabbitMQ service.
org.springframework.amqp.rabbit.connection.ConnectionFactory	rabbitConnectionFactory(java.lang.String serviceId, RabbitConnectionFactoryConfig rabbitConnectionFactoryConfig) Get the ConnectionFactory object for the specified RabbitMQ service configured as specified.
org.springframework.data.redis.connection.RedisConnectionFactory	redisConnectionFactory() Get the RedisConnectionFactory object associated with the only Redis service bound to the app.
org.springframework.data.redis.connection.RedisConnectionFactory	redisConnectionFactory(PooledServiceConnectorConfig redisConnectionFactoryConfig) Get the RedisConnectionFactory object associated with the only Redis service bound to the app configured as specified.
org.springframework.data.redis.connection.RedisConnectionFactory	redisConnectionFactory(java.lang.String serviceId) Get the RedisConnectionFactory object for the specified Redis service.
org.springframework.data.redis.connection.RedisConnectionFactory	redisConnectionFactory(java.lang.String serviceId, PooledServiceConnectorConfig redisConnectionFactoryConfig) Get the RedisConnectionFactory object for the specified Redis service configured as specified.
java.lang.Object	service() Get the service connector object associated with the only service bound to the app.
<T> T	service(java.lang.Class<T> serviceConnectorType) Get the service connector object of the specified type if there is only one such candidate service This is equivalent to the <cloud:service connector-type="T.class"/> element.
java.lang.Object	service(java.lang.String serviceId) Get the service connector object for the specified service.
<T> T	service(java.lang.String serviceId, java.lang.Class<T> serviceConnectorType) Get the service connector object of the specified type and service ID This is equivalent to the <cloud:service service-id="serviceId" connector-type="T.class"/> element.
<T> T	service(java.lang.String serviceId, java.lang.Class<T> serviceConnectorType, org.springframework.cloud.service.ServiceConnectorConfig serviceConnectorConfig)

Methods inherited from class java.lang.Object

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

Field Detail

cloud

protected final org.springframework.cloud.Cloud cloud

Constructor Detail

CloudServiceConnectionFactory

public CloudServiceConnectionFactory(org.springframework.cloud.Cloud cloud)

Method Detail

dataSource

public javax.sql.DataSource dataSource()

Get the DataSource object associated with the only relational database service bound to the app. This is equivalent to the <cloud:data-source/> element.

Specified by:

dataSource in interface ServiceConnectionFactory

Returns:

data source

Throws:

org.springframework.cloud.CloudException - if there are either 0 or more than 1 relational database services.

dataSource

public javax.sql.DataSource dataSource(DataSourceConfig dataSourceConfig)

Get the DataSource object associated with the only relational database service bound to the app configured as specified. This is equivalent to the <cloud:data-source> element with nested <cloud:connection> and/or <cloud:pool> elements.

Specified by:

dataSource in interface ServiceConnectionFactory

Parameters:

dataSourceConfig - configuration for the data source created

Returns:

data source

Throws:

org.springframework.cloud.CloudException - if there are either 0 or more than 1 relational database services.

dataSource

public javax.sql.DataSource dataSource(java.lang.String serviceId)

Get the DataSource object for the specified relational database service. This is equivalent to the <cloud:data-source service-id="serviceId"/>

Specified by:

dataSource in interface ServiceConnectionFactory

Parameters:

serviceId - the name of the service

Returns:

data source

Throws:

org.springframework.cloud.CloudException - if the specified service doesn't exist

dataSource

public javax.sql.DataSource dataSource(java.lang.String serviceId,
                              DataSourceConfig dataSourceConfig)

Get the DataSource object for the specified relational database service configured as specified. This is equivalent to the <cloud:data-source service-id="serviceId"/> element with nested <cloud:connection> and/or <cloud:pool> elements.

Specified by:

dataSource in interface ServiceConnectionFactory

Parameters:

serviceId - the name of the service

dataSourceConfig - configuration for the data source created

Returns:

data source

Throws:

org.springframework.cloud.CloudException - if the specified service doesn't exist

mongoDbFactory

public org.springframework.data.mongodb.MongoDbFactory mongoDbFactory()

Get the MongoDbFactory object associated with the only MongoDB service bound to the app. This is equivalent to the <cloud:mongo-db-factory/> element.

Specified by:

mongoDbFactory in interface ServiceConnectionFactory

Returns:

mongo db factory

Throws:

org.springframework.cloud.CloudException - if there are either 0 or more than 1 mongodb services.

mongoDbFactory

public org.springframework.data.mongodb.MongoDbFactory mongoDbFactory(MongoDbFactoryConfig mongoDbFactoryConfig)

Get the MongoDbFactory object associated with the only MongoDB service bound to the app configured as specified. This is equivalent to the <cloud:mongo-db-factory> element with a nested <cloud:mongo-options> element.

Specified by:

mongoDbFactory in interface ServiceConnectionFactory

Parameters:

mongoDbFactoryConfig - configuration for the mondo db factory created

Returns:

mongo db factory

Throws:

org.springframework.cloud.CloudException - if there are either 0 or more than 1 mongodb services.

mongoDbFactory

public org.springframework.data.mongodb.MongoDbFactory mongoDbFactory(java.lang.String serviceId)

Get the MongoDbFactory object for the specified MongoDB service. This is equivalent to the <cloud:mongo-db-factory service-id="serviceId"> element.

Specified by:

mongoDbFactory in interface ServiceConnectionFactory

Parameters:

serviceId - the name of the service

Returns:

mongo db factory

Throws:

org.springframework.cloud.CloudException - if the specified service doesn't exist

mongoDbFactory

public org.springframework.data.mongodb.MongoDbFactory mongoDbFactory(java.lang.String serviceId,
                                                             MongoDbFactoryConfig mongoDbFactoryConfig)

Get the MongoDbFactory object for the specified MongoDB service configured as specified. This is equivalent to the <cloud:mongo-db-factory service-id="serviceId"> element with a nested <cloud:mongo-options> element.

Specified by:

mongoDbFactory in interface ServiceConnectionFactory

Parameters:

serviceId - the name of the service

mongoDbFactoryConfig - configuration for the mongo db factory created

Returns:

mongo db factory

Throws:

org.springframework.cloud.CloudException - if the specified service doesn't exist

rabbitConnectionFactory

public org.springframework.amqp.rabbit.connection.ConnectionFactory rabbitConnectionFactory()

Get the ConnectionFactory object associated with the only RabbitMQ service bound to the app. This is equivalent to the <cloud:rabbit-connection-factory> element.

Specified by:

rabbitConnectionFactory in interface ServiceConnectionFactory

Returns:

rabbit connection factory

Throws:

org.springframework.cloud.CloudException - if there are either 0 or more than 1 RabbitMQ services.

rabbitConnectionFactory

public org.springframework.amqp.rabbit.connection.ConnectionFactory rabbitConnectionFactory(RabbitConnectionFactoryConfig rabbitConnectionFactoryConfig)

Get the ConnectionFactory object associated with the only RabbitMQ service bound to the app configured as specified. This is equivalent to the <cloud:rabbit-connection-factory> element with a nested <cloud:rabbit-options> element.

Specified by:

rabbitConnectionFactory in interface ServiceConnectionFactory

Parameters:

rabbitConnectionFactoryConfig - configuration for the rabbit connection factory created

Returns:

rabbit connection factory

Throws:

org.springframework.cloud.CloudException - if there are either 0 or more than 1 RabbitMQ services.

rabbitConnectionFactory

public org.springframework.amqp.rabbit.connection.ConnectionFactory rabbitConnectionFactory(java.lang.String serviceId)

Get the ConnectionFactory object for the specified RabbitMQ service. This is equivalent to the <cloud:rabbit-connection-factory service-id="serviceId"> element.

Specified by:

rabbitConnectionFactory in interface ServiceConnectionFactory

Parameters:

serviceId - the name of the service

Returns:

rabbit connection factory

Throws:

org.springframework.cloud.CloudException - if the specified service doesn't exist

rabbitConnectionFactory

public org.springframework.amqp.rabbit.connection.ConnectionFactory rabbitConnectionFactory(java.lang.String serviceId,
                                                                                   RabbitConnectionFactoryConfig rabbitConnectionFactoryConfig)

Get the ConnectionFactory object for the specified RabbitMQ service configured as specified. This is equivalent to the <cloud:rabbit-connection-factory service-id="serviceId"> element with a nested <cloud:rabbit-options> element.

Specified by:

rabbitConnectionFactory in interface ServiceConnectionFactory

Parameters:

serviceId - the name of the service

rabbitConnectionFactoryConfig - configuration for the ConnectionFactory created

Returns:

rabbit connection factory

Throws:

org.springframework.cloud.CloudException - if the specified service doesn't exist

redisConnectionFactory

public org.springframework.data.redis.connection.RedisConnectionFactory redisConnectionFactory()

Get the RedisConnectionFactory object associated with the only Redis service bound to the app. This is equivalent to the <cloud:redis-connection-factory/> element

Specified by:

redisConnectionFactory in interface ServiceConnectionFactory

Returns:

redis connection factory

Throws:

org.springframework.cloud.CloudException - if there are either 0 or more than 1 redis services.

redisConnectionFactory

public org.springframework.data.redis.connection.RedisConnectionFactory redisConnectionFactory(PooledServiceConnectorConfig redisConnectionFactoryConfig)

Get the RedisConnectionFactory object associated with the only Redis service bound to the app configured as specified. This is equivalent to the <cloud:redis-connection-factory service-id="serviceId"> element with a nested <cloud:pool> element.

Specified by:

redisConnectionFactory in interface ServiceConnectionFactory

Parameters:

redisConnectionFactoryConfig - configuration for the RedisConnectionFactory created

Returns:

redis connection factory

Throws:

org.springframework.cloud.CloudException - if there are either 0 or more than 1 redis services.

redisConnectionFactory

public org.springframework.data.redis.connection.RedisConnectionFactory redisConnectionFactory(java.lang.String serviceId)

Get the RedisConnectionFactory object for the specified Redis service. This is equivalent to the <cloud:redis-connection-factory service-id="serviceId"> element.

Specified by:

redisConnectionFactory in interface ServiceConnectionFactory

Parameters:

serviceId - the name of the service

Returns:

redis connection factory

Throws:

org.springframework.cloud.CloudException - if the specified service doesn't exist

redisConnectionFactory

public org.springframework.data.redis.connection.RedisConnectionFactory redisConnectionFactory(java.lang.String serviceId,
                                                                                      PooledServiceConnectorConfig redisConnectionFactoryConfig)

Get the RedisConnectionFactory object for the specified Redis service configured as specified. This is equivalent to the <cloud:redis-connection-factory service-id="serviceId"> element with a nested <cloud:pool> element.

Specified by:

redisConnectionFactory in interface ServiceConnectionFactory

Parameters:

serviceId - the name of the service

redisConnectionFactoryConfig - configuration for the RedisConnectionFactory created

Returns:

redis connection factory

Throws:

org.springframework.cloud.CloudException - if the specified service doesn't exist

service

public java.lang.Object service()

Get the service connector object associated with the only service bound to the app. This is equivalent to the <cloud:service/> element.

Specified by:

service in interface ServiceConnectionFactory

Returns:

service connector object

Throws:

org.springframework.cloud.CloudException - if there are either 0 or more than 1 services.

service

public <T> T service(java.lang.Class<T> serviceConnectorType)

Get the service connector object of the specified type if there is only one such candidate service This is equivalent to the <cloud:service connector-type="T.class"/> element.

Specified by:

service in interface ServiceConnectionFactory

Type Parameters:

T - the type of the service connector to be returned

Parameters:

serviceConnectorType - the class of the service connector to be returned

Returns:

service connector object

Throws:

org.springframework.cloud.CloudException - if there are either 0 or more than 1 candidate services.

service

public java.lang.Object service(java.lang.String serviceId)

Get the service connector object for the specified service. This is equivalent to the <cloud:service service-id="serviceId"/> element.

Specified by:

service in interface ServiceConnectionFactory

Parameters:

serviceId - the service ID of the service to be returned

Returns:

service connector object

Throws:

org.springframework.cloud.CloudException - if the specified service doesn't exist

service

public <T> T service(java.lang.String serviceId,
            java.lang.Class<T> serviceConnectorType)

Get the service connector object of the specified type and service ID This is equivalent to the <cloud:service service-id="serviceId" connector-type="T.class"/> element.

Specified by:

service in interface ServiceConnectionFactory

Type Parameters:

T - the type of the service connector to be returned

Parameters:

serviceId - the service ID of the service to be returned

serviceConnectorType - the class of the service connector to be returned

Returns:

service connector object

Throws:

org.springframework.cloud.CloudException - if the specified service doesn't exist

service

public <T> T service(java.lang.String serviceId,
            java.lang.Class<T> serviceConnectorType,
            org.springframework.cloud.service.ServiceConnectorConfig serviceConnectorConfig)

Specified by:

service in interface ServiceConnectionFactory