org.springframework.data.gemfire.config.annotation.support

Class EmbeddedServiceConfigurationSupport

java.lang.Object

org.springframework.data.gemfire.config.annotation.support.EmbeddedServiceConfigurationSupport

All Implemented Interfaces:

Aware, BeanFactoryAware, ImportBeanDefinitionRegistrar

Direct Known Subclasses:

AuthConfiguration, GemFirePropertiesConfiguration, HttpServiceConfiguration, LocatorConfiguration, LoggingConfiguration, ManagerConfiguration, McastConfiguration, MemcachedServerConfiguration, SslConfiguration, StatisticsConfiguration

public abstract class EmbeddedServiceConfigurationSupport
extends Object
implements ImportBeanDefinitionRegistrar, BeanFactoryAware

The EmbeddedServiceConfigurationSupport class is an abstract base class supporting the configuration of Pivotal GemFire and Apache Geode embedded services.

Since:

1.9.0

Author:

John Blum

See Also:

BeanFactory, BeanFactoryAware, ImportBeanDefinitionRegistrar, AbstractCacheConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	EmbeddedServiceConfigurationSupport.GemFirePropertiesBeanPostProcessor Spring BeanPostProcessor used to process GemFire System properties defined as a Spring bean in the Spring application context before initialization.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_HOST
static Integer	DEFAULT_PORT

Constructor Summary

Constructors

Constructor and Description
EmbeddedServiceConfigurationSupport()

Method Summary

Modifier and Type	Method and Description
protected <T extends AbstractCacheConfiguration> T	cacheConfiguration() Returns a reference to an instance of the AbstractCacheConfiguration class used to configure a GemFire (Singleton, client or peer) cache instance along with it's associated, embedded services.
protected String	generateBeanName()
protected String	generateBeanName(Class<?> typeQualifier)
protected String	generateBeanName(String nameQualifier)
protected Map<String,Object>	getAnnotationAttributes(AnnotationMetadata importingClassMetadata)
protected abstract Class	getAnnotationType() Returns the configured GemFire cache application annotation type (e.g.
protected String	getAnnotationTypeName() Returns the fully-qualified class name of the GemFire cache application annotation type.
protected String	getAnnotationTypeSimpleName() Returns the simple class name of the GemFire cache application annotation type.
protected BeanFactory	getBeanFactory() Returns a reference to the Spring BeanFactory.
protected boolean	hasProperties(Properties properties)
protected boolean	isAnnotationPresent(AnnotationMetadata importingClassMetadata)
protected BeanDefinitionHolder	newBeanDefinitionHolder(BeanDefinitionBuilder builder)
void	registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry)
protected void	registerBeanDefinitions(AnnotationMetadata importingClassMetaData, Map<String,Object> annotationAttributes, BeanDefinitionRegistry registry)
protected void	registerGemFirePropertiesBeanPostProcessor(BeanDefinitionRegistry registry, Properties customGemFireProperties)
protected <T> T	resolveBean(Class<T> beanType) Resolves a Spring managed bean with the given Class type from the Spring BeanFactory.
protected String	resolveHost(String hostname)
protected String	resolveHost(String hostname, String defaultHostname)
protected Integer	resolvePort(Integer port)
protected Integer	resolvePort(Integer port, Integer defaultPort)
void	setBeanFactory(BeanFactory beanFactory)
protected void	setGemFireProperties(AnnotationMetadata importingClassMetadata, Map<String,Object> annotationAttributes, BeanDefinitionRegistry registry)
protected abstract Properties	toGemFireProperties(Map<String,Object> annotationAttributes)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PORT

public static final Integer DEFAULT_PORT

DEFAULT_HOST

public static final String DEFAULT_HOST

See Also:

Constant Field Values

Constructor Detail

EmbeddedServiceConfigurationSupport

public EmbeddedServiceConfigurationSupport()

Method Detail

cacheConfiguration

protected <T extends AbstractCacheConfiguration> T cacheConfiguration()

Returns a reference to an instance of the AbstractCacheConfiguration class used to configure a GemFire (Singleton, client or peer) cache instance along with it's associated, embedded services.

Type Parameters:

T - Class type extension of AbstractCacheConfiguration.

Returns:

a reference to a single AbstractCacheConfiguration instance.

Throws:

IllegalStateException - if the AbstractCacheConfiguration reference was not configured.

See Also:

AbstractCacheConfiguration

getAnnotationType

protected abstract Class getAnnotationType()

Returns the configured GemFire cache application annotation type (e.g. ClientCacheApplication or PeerCacheApplication.

Returns:

an annotation defining the GemFire cache application type.

getAnnotationTypeName

protected String getAnnotationTypeName()

Returns the fully-qualified class name of the GemFire cache application annotation type.

Returns:

a fully-qualified class name of the GemFire cache application annotation type.

See Also:

Class.getName(), getAnnotationType()

getAnnotationTypeSimpleName

protected String getAnnotationTypeSimpleName()

Returns the simple class name of the GemFire cache application annotation type.

Returns:

the simple class name of the GemFire cache application annotation type.

See Also:

Class.getSimpleName(), getAnnotationType()

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException

Specified by:

setBeanFactory in interface BeanFactoryAware

Throws:

BeansException

getBeanFactory

protected BeanFactory getBeanFactory()

Returns a reference to the Spring BeanFactory.

Returns:

a reference to the Spring BeanFactory.

Throws:

IllegalStateException - if the Spring BeanFactory was not properly initialized.

See Also:

BeanFactory

registerBeanDefinitions

public final void registerBeanDefinitions(AnnotationMetadata importingClassMetadata,
                                          BeanDefinitionRegistry registry)

Specified by:

registerBeanDefinitions in interface ImportBeanDefinitionRegistrar

registerBeanDefinitions

protected void registerBeanDefinitions(AnnotationMetadata importingClassMetaData,
                                       Map<String,Object> annotationAttributes,
                                       BeanDefinitionRegistry registry)

setGemFireProperties

protected void setGemFireProperties(AnnotationMetadata importingClassMetadata,
                                    Map<String,Object> annotationAttributes,
                                    BeanDefinitionRegistry registry)

toGemFireProperties

protected abstract Properties toGemFireProperties(Map<String,Object> annotationAttributes)

isAnnotationPresent

protected boolean isAnnotationPresent(AnnotationMetadata importingClassMetadata)

hasProperties

protected boolean hasProperties(Properties properties)

getAnnotationAttributes

protected Map<String,Object> getAnnotationAttributes(AnnotationMetadata importingClassMetadata)

registerGemFirePropertiesBeanPostProcessor

protected void registerGemFirePropertiesBeanPostProcessor(BeanDefinitionRegistry registry,
                                                          Properties customGemFireProperties)

newBeanDefinitionHolder

protected BeanDefinitionHolder newBeanDefinitionHolder(BeanDefinitionBuilder builder)

generateBeanName

protected String generateBeanName()

generateBeanName

protected String generateBeanName(Class<?> typeQualifier)

generateBeanName

protected String generateBeanName(String nameQualifier)

resolveBean

protected <T> T resolveBean(Class<T> beanType)

Resolves a Spring managed bean with the given Class type from the Spring BeanFactory. It is assumed that the given typed bean is the only bean of this Class type. If more than 1 bean of the given Class type is found, then the Spring BeanFactory will throw a NoUniqueBeanDefinitionException. If the BeanFactory is an instance of AutowireCapableBeanFactory, then the returned bean will also be configured.

Type Parameters:

T - Class type of the registered Spring managed bean.

Parameters:

beanType - required Class type of the registered Spring managed bean.

Returns:

a Spring managed bean instance for the given, required Class type, or null if no bean instance of the given, required Class type could be found.

Throws:

BeansException - if the Spring manage bean of the required Class type could not be resolved.

See Also:

getBeanFactory()

resolveHost

protected String resolveHost(String hostname)

resolveHost

protected String resolveHost(String hostname,
                             String defaultHostname)

resolvePort

protected Integer resolvePort(Integer port)

resolvePort

protected Integer resolvePort(Integer port,
                              Integer defaultPort)