org.springframework.cloud.service

Class AbstractCloudServiceConnectorFactory<S>

java.lang.Object

org.springframework.beans.factory.config.AbstractFactoryBean<S>

org.springframework.cloud.service.AbstractCloudServiceConnectorFactory<S>

Type Parameters:

S - The service type

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, DisposableBean, FactoryBean<S>, InitializingBean, CloudServiceConnectorFactory<S>

Direct Known Subclasses:

CloudDataSourceFactory, GenericCloudServiceConnectorFactory, MailSenderFactory, MongoDbFactoryFactory, RabbitConnectionFactoryFactory, RedisConnectionFactoryFactory

public abstract class AbstractCloudServiceConnectorFactory<S>
extends AbstractFactoryBean<S>
implements CloudServiceConnectorFactory<S>

Abstract base factory class.

This factory uses the service creator provided through the constructor to create services. If the service name is provided it creates a service object based on the service bound to that name. Otherwise, it creates a singleton service and fails if it doesn't find a unique service of the expected type.

Author:

Ramnivas Laddad

Field Summary

Fields

Modifier and Type	Field and Description
protected String	serviceId

Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

logger

Constructor Summary

Constructors

Constructor and Description
AbstractCloudServiceConnectorFactory(Class<S> serviceConnectorType, ServiceConnectorConfig serviceConnectorConfiguration)
AbstractCloudServiceConnectorFactory(String serviceId, Class<S> serviceConnectorType, ServiceConnectorConfig serviceConnectorConfiguration)

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected S	createInstance()
S	createService()
Class<?>	getObjectType()
String	getServiceId()
void	setCloud(Cloud cloud) Set the cloud, for internal testing purpose only.
void	setServiceConnectorType(Class<? extends S> serviceConnectorType)

Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

destroy, destroyInstance, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

Methods inherited from class java.lang.Object

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

Field Detail

serviceId

protected String serviceId

Constructor Detail

AbstractCloudServiceConnectorFactory

public AbstractCloudServiceConnectorFactory(String serviceId,
                                    Class<S> serviceConnectorType,
                                    ServiceConnectorConfig serviceConnectorConfiguration)

Parameters:

serviceId - Optional service name property. If this property is null, a unique service of the expected type (redis, for example) needs to be bound to the application.

serviceConnectorType - the class of the service connector that will be returned

serviceConnectorConfiguration - configuration to be applied to the service connector

AbstractCloudServiceConnectorFactory

public AbstractCloudServiceConnectorFactory(Class<S> serviceConnectorType,
                                    ServiceConnectorConfig serviceConnectorConfiguration)

Method Detail

setCloud

public void setCloud(Cloud cloud)

Set the cloud, for internal testing purpose only.

For normal usage, the InitializingBean approach will create (if needed) a CloudFactory and obtain a Cloud from it.

Parameters:

cloud - the Cloud instance describing the discovered runtime environment

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Overrides:

afterPropertiesSet in class AbstractFactoryBean<S>

Throws:

Exception

createInstance

protected S createInstance()
                    throws Exception

Specified by:

createInstance in class AbstractFactoryBean<S>

Throws:

Exception

createService

public S createService()

Specified by:

createService in interface CloudServiceConnectorFactory<S>

getObjectType

public Class<?> getObjectType()

Specified by:

getObjectType in interface FactoryBean<S>

Specified by:

getObjectType in class AbstractFactoryBean<S>

getServiceId

public String getServiceId()

Specified by:

getServiceId in interface CloudServiceConnectorFactory<S>

setServiceConnectorType

public void setServiceConnectorType(Class<? extends S> serviceConnectorType)