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

Class EmbeddedServiceConfigurationSupport

java.lang.Object

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

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

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, ImportBeanDefinitionRegistrar, EnvironmentAware

Direct Known Subclasses:

AuthConfiguration, GemFirePropertiesConfiguration, GeodeIntegratedSecurityConfiguration, HttpServiceConfiguration, LocatorConfiguration, LoggingConfiguration, ManagerConfiguration, McastConfiguration, MemcachedServerConfiguration, OffHeapConfiguration, RedisServerConfiguration, SslConfiguration, StatisticsConfiguration

public abstract class EmbeddedServiceConfigurationSupport
extends AbstractAnnotationConfigSupport
implements ImportBeanDefinitionRegistrar

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:

• Map
• Properties
• BeanFactory
• AutowireCapableBeanFactory
• BeanDefinitionHolder
• BeanPostProcessor
• NamedBeanHolder
• BeanDefinitionBuilder
• BeanDefinitionRegistry
• ImportBeanDefinitionRegistrar
• AnnotationAttributes
• AnnotationMetadata
• AbstractCacheConfiguration
• AbstractAnnotationConfigSupport

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	EmbeddedServiceConfigurationSupport.AbstractGemFirePropertiesConfigurer
protected static class	EmbeddedServiceConfigurationSupport.ClientGemFirePropertiesConfigurer
protected static class	EmbeddedServiceConfigurationSupport.GemFirePropertiesBeanPostProcessor	Spring BeanPostProcessor used to process before initialization Pivotal GemFire or Apache Geode Properties defined as a bean in the Spring application context.
protected static class	EmbeddedServiceConfigurationSupport.LocatorGemFirePropertiesConfigurer
protected static class	EmbeddedServiceConfigurationSupport.PeerGemFirePropertiesConfigurer

Nested classes/interfaces inherited from class org.springframework.data.gemfire.config.annotation.support.AbstractAnnotationConfigSupport

AbstractAnnotationConfigSupport.TypeResolver<T>

Field Summary

Fields

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

Fields inherited from class org.springframework.data.gemfire.config.annotation.support.AbstractAnnotationConfigSupport

INFRASTRUCTURE_ROLES, ORG_SPRINGFRAMEWORK_DATA_GEMFIRE_PACKAGE, ORG_SPRINGFRAMEWORK_PACKAGE, SPRING_DATA_GEMFIRE_PROPERTY_PREFIX

Constructor Summary

Constructors

Constructor	Description
EmbeddedServiceConfigurationSupport()

Method Summary

Modifier and Type	Method	Description
protected String	generateBeanName()
protected String	generateBeanName(Class<?> typeQualifier)
protected String	generateBeanName(String nameQualifier)
protected <T extends AbstractCacheConfiguration> T	getCacheConfiguration()	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 boolean	hasProperties(Properties properties)
protected BeanDefinitionHolder	newBeanDefinitionHolder(BeanDefinitionBuilder builder)
protected void	registerBeanDefinitions(AnnotationMetadata importingClassMetadata, Map<String,Object> annotationAttributes, BeanDefinitionRegistry registry)
final void	registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry)
protected void	registerBeanDefinitions(AnnotationMetadata importingClassMetadata, AnnotationAttributes annotationAttributes, BeanDefinitionRegistry registry)
protected void	registerClientGemFirePropertiesConfigurer(BeanDefinitionRegistry registry, Properties gemfireProperties)
protected void	registerGemFirePropertiesBeanPostProcessor(BeanDefinitionRegistry registry, Properties gemFireProperties)
protected void	registerGemFirePropertiesConfigurer(BeanDefinitionRegistry registry, Properties gemfireProperties)
protected void	registerLocatorGemFirePropertiesConfigurer(BeanDefinitionRegistry registry, Properties gemfireProperties)
protected void	registerPeerGemFirePropertiesConfigurer(BeanDefinitionRegistry registry, Properties gemfireProperties)
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)
protected void	setGemFireProperties(AnnotationMetadata importingClassMetadata, AnnotationAttributes annotationAttributes, BeanDefinitionRegistry registry)
protected abstract Properties	toGemFireProperties(Map<String,Object> annotationAttributes)

Methods inherited from class org.springframework.data.gemfire.config.annotation.support.AbstractAnnotationConfigSupport

arrayOfPropertyNamesFor, arrayOfPropertyNamesFor, asArrayProperty, cacheClientProperty, cacheCompressionProperty, cacheOffHeapProperty, cachePeerProperty, cacheProperty, cacheServerProperty, clusterProperty, diskStoreProperty, entitiesProperty, gatewayReceiverProperty, gatewaySenderProperty, getAnnotationAttributes, getAnnotationAttributes, getAnnotationAttributes, getAnnotationType, getAnnotationTypeName, getAnnotationTypeSimpleName, getBeanClassLoader, getBeanFactory, getEnvironment, getEvaluationContext, getLog, hasValue, hasValue, hasValue, httpServiceProperty, isAnnotationPresent, isAnnotationPresent, isNotInfrastructureBean, isNotInfrastructureBean, isNotInfrastructureClass, isNotInfrastructureClass, isNotInfrastructureRole, isUserLevelMethod, locatorProperty, logDebug, logDebug, logError, logError, loggingProperty, logInfo, logInfo, logWarning, logWarning, managementProperty, managerProperty, memcachedServiceProperty, namedCacheServerProperty, namedDiskStoreProperty, namedGatewaySenderProperty, namedPoolProperty, newEvaluationContext, newLog, pdxProperty, poolProperty, propertyName, redisServiceProperty, register, register, requireProperty, resolveAnnotation, resolveBeanClass, resolveBeanClass, resolveBeanClass, resolveBeanClassLoader, resolveBeanClassLoader, resolveBeanClassName, resolveProperty, resolveProperty, resolveProperty, resolveProperty, resolveProperty, resolveProperty, resolveProperty, resolveProperty, safeResolveType, securityProperty, serviceProperty, setBeanClassLoader, setBeanFactory, setEnvironment, sslProperty, statsProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.annotation.ImportBeanDefinitionRegistrar

registerBeanDefinitions

Field Details

DEFAULT_PORT

public static final Integer DEFAULT_PORT

DEFAULT_HOST

public static final String DEFAULT_HOST

See Also:

• Constant Field Values

Constructor Details

EmbeddedServiceConfigurationSupport

public EmbeddedServiceConfigurationSupport()

Method Details

getCacheConfiguration

@NonNull
protected <T extends AbstractCacheConfiguration> T getCacheConfiguration()

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

registerBeanDefinitions

public final void registerBeanDefinitions(@NonNull
 AnnotationMetadata importingClassMetadata,
 @NonNull
 BeanDefinitionRegistry registry)

Specified by:

registerBeanDefinitions in interface ImportBeanDefinitionRegistrar

registerBeanDefinitions

protected void registerBeanDefinitions(@NonNull
 AnnotationMetadata importingClassMetadata,
 @NonNull
 AnnotationAttributes annotationAttributes,
 @NonNull
 BeanDefinitionRegistry registry)

registerBeanDefinitions

protected void registerBeanDefinitions(@NonNull
 AnnotationMetadata importingClassMetadata,
 @NonNull
 Map<String,Object> annotationAttributes,
 @NonNull
 BeanDefinitionRegistry registry)

setGemFireProperties

protected void setGemFireProperties(@NonNull
 AnnotationMetadata importingClassMetadata,
 @NonNull
 AnnotationAttributes annotationAttributes,
 @NonNull
 BeanDefinitionRegistry registry)

toGemFireProperties

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

hasProperties

protected boolean hasProperties(@Nullable
 Properties properties)

registerGemFirePropertiesBeanPostProcessor

protected void registerGemFirePropertiesBeanPostProcessor(@NonNull
 BeanDefinitionRegistry registry,
 Properties gemFireProperties)

registerGemFirePropertiesConfigurer

protected void registerGemFirePropertiesConfigurer(@NonNull
 BeanDefinitionRegistry registry,
 Properties gemfireProperties)

registerClientGemFirePropertiesConfigurer

protected void registerClientGemFirePropertiesConfigurer(BeanDefinitionRegistry registry,
 Properties gemfireProperties)

registerLocatorGemFirePropertiesConfigurer

protected void registerLocatorGemFirePropertiesConfigurer(BeanDefinitionRegistry registry,
 Properties gemfireProperties)

registerPeerGemFirePropertiesConfigurer

protected void registerPeerGemFirePropertiesConfigurer(BeanDefinitionRegistry registry,
 Properties gemfireProperties)

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:

• AbstractAnnotationConfigSupport.getBeanFactory()

resolveHost

@Nullable
protected String resolveHost(@Nullable
 String hostname)

resolveHost

@Nullable
protected String resolveHost(@Nullable
 String hostname,
 @Nullable
 String defaultHostname)

resolvePort

@Nullable
protected Integer resolvePort(@Nullable
 Integer port)

resolvePort

@Nullable
protected Integer resolvePort(@Nullable
 Integer port,
 @Nullable
 Integer defaultPort)