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

Class AbstractAnnotationConfigSupport

java.lang.Object

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

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, EnvironmentAware

Direct Known Subclasses:

AbstractCacheConfiguration, AddCacheServerConfiguration, AddPoolConfiguration, ApacheShiroSecurityConfiguration, AutoRegionLookupConfiguration, CachingDefinedRegionsConfiguration, CachingDefinedRegionsConfiguration.AbstractCacheNameResolver, ClusterConfigurationConfiguration, ClusterDefinedRegionsConfiguration, CompressionConfiguration, ContinuousQueryConfiguration, DiskStoreConfiguration, EmbeddedServiceConfigurationSupport, EntityDefinedRegionsConfiguration, EvictionConfiguration, ExpirationConfiguration, GatewayReceiverConfiguration, GatewaySenderBeanFactoryPostProcessor, GatewaySenderConfiguration, GemfireCacheTransactionsConfiguration, LocatorApplicationConfiguration, OffHeapConfiguration.OffHeapBeanFactoryPostProcessor, PdxConfiguration

public abstract class AbstractAnnotationConfigSupport
extends Object
implements BeanClassLoaderAware, BeanFactoryAware, EnvironmentAware

An abstract base class encapsulating functionality common to all Spring Data for Apache Geode (SDG) annotations and configuration classes used to configure Apache Geode objects using Spring Data for Apache Geode.

Since:

1.9.0

Author:

John Blum, Udo Kohlmeyer

See Also:

• ClassLoader
• Annotation
• AnnotatedElement
• BeanClassLoaderAware
• BeanFactory
• BeanFactoryAware
• AnnotatedBeanDefinition
• ConfigurableBeanFactory
• AbstractBeanDefinition
• BeanDefinitionRegistry
• EnvironmentAware
• AnnotationAttributes
• Environment
• AnnotationMetadata
• MethodMetadata
• EvaluationContext

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	AbstractAnnotationConfigSupport.TypeResolver<T>	AbstractAnnotationConfigSupport.TypeResolver is a FunctionalInterface defining a contract to encapsulate logic used to resolve a particular type.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Supplier<ClassLoader>	CURRENT_THREAD_CONTEXT_CLASS_LOADER
protected static final Set<Integer>	INFRASTRUCTURE_ROLES
protected static final String	ORG_SPRINGFRAMEWORK_DATA_GEMFIRE_PACKAGE
protected static final String	ORG_SPRINGFRAMEWORK_PACKAGE
protected static final String	SPRING_DATA_GEMFIRE_PROPERTY_PREFIX

Constructor Summary

Constructors

Constructor	Description
AbstractAnnotationConfigSupport()	Constructs a new instance of AbstractAnnotationConfigSupport.
AbstractAnnotationConfigSupport(BeanFactory beanFactory)	Constructs a new instance of AbstractAnnotationConfigSupport initialized with the given, non-required BeanFactory.

Method Summary

Modifier and Type	Method	Description
protected List<String>	arrayOfPropertyNamesFor(String propertyNamePrefix)
protected List<String>	arrayOfPropertyNamesFor(String propertyNamePrefix, String propertyNameSuffix)
protected String	asArrayProperty(String propertyNamePrefix, int index, String propertyNameSuffix)
protected String	cacheClientProperty(String propertyNameSuffix)
protected String	cacheCompressionProperty(String propertyNameSuffix)
protected String	cacheOffHeapProperty(String propertyNameSuffix)
protected String	cachePeerProperty(String propertyNameSuffix)
protected String	cacheProperty(String propertyNameSuffix)
protected String	cacheServerProperty(String propertyNameSuffix)
protected String	clusterProperty(String propertyNameSuffix)
protected String	diskStoreProperty(String propertyNameSuffix)
protected String	entitiesProperty(String propertyNameSuffix)
protected String	gatewayReceiverProperty(String propertyNameSuffix)
protected String	gatewaySenderProperty(String propertyNameSuffix)
protected AnnotationAttributes	getAnnotationAttributes(Annotation annotation)	Returns the AnnotationAttributes for the given Annotation.
protected AnnotationAttributes	getAnnotationAttributes(AnnotationMetadata importingClassMetadata)	Returns AnnotationAttributes for the declared getAnnotationTypeName().
protected AnnotationAttributes	getAnnotationAttributes(AnnotationMetadata importingClassMetadata, String annotationName)	Returns AnnotationAttributes for the given named Annotation from the given type meta-data.
protected abstract Class<? extends Annotation>	getAnnotationType()	Returns the cache application Annotation type pertaining to this configuration.
protected String	getAnnotationTypeName()	Returns the fully-qualified class name of the cache application Annotation type.
protected String	getAnnotationTypeSimpleName()	Returns the simple class name of the cache application Annotation type.
protected ClassLoader	getBeanClassLoader()	Returns a reference to the ClassLoader use by the Spring BeanFactory to load classes for bean definitions.
protected BeanFactory	getBeanFactory()	Returns a reference to the Spring BeanFactory in the current application context.
protected Environment	getEnvironment()	Returns a reference to the Spring Environment.
protected EvaluationContext	getEvaluationContext()	Returns a reference to the EvaluationContext used to evaluate SpEL expressions.
protected org.slf4j.Logger	getLogger()	Returns a reference to the Logger used by this class to log messages.
static boolean	hasValue(Number value)	Determines whether the given Number has value.
static boolean	hasValue(Object value)	Determines whether the given Object has value.
static boolean	hasValue(String value)	Determines whether the given String has value.
protected String	httpServiceProperty(String propertyNameSuffix)
protected boolean	isAnnotationPresent(AnnotationMetadata importingClassMetadata)	Determines whether the given type meta-data for a particular Class is annotated with the declared getAnnotationTypeName().
protected boolean	isAnnotationPresent(AnnotationMetadata importingClassMetadata, String annotationName)	Determines whether the given type meta-data for a particular Class is annotated with the given Annotation defined by name.
protected boolean	isNotInfrastructureBean(Object bean)	Null-safe method used to determine whether the given bean is a Spring container provided infrastructure bean.
protected boolean	isNotInfrastructureBean(BeanDefinition beanDefinition)	Null-safe method used to determine whether the bean defined by the given BeanDefinition is a Spring container provided infrastructure bean.
protected boolean	isNotInfrastructureClass(BeanDefinition beanDefinition)	Null-safe method used to determine whether the bean defined by the given BeanDefinition is a Spring container infrastructure bean based on the bean's class name.
protected boolean	isNotInfrastructureRole(BeanDefinition beanDefinition)	Null-safe method to determines whether the bean defined by the given BeanDefinition is a Spring container infrastructure bean based on the bean's role.
protected boolean	isUserLevelMethod(Method method)	Determines whether the given Method was declared and defined by the user.
protected String	locatorProperty(String propertyNameSuffix)
protected void	logDebug(String message, Object... args)	Logs the message formatted with the array of arguments at debug level.
protected void	logDebug(Supplier<String> message)	Logs the message supplied by the given Supplier at debug level.
protected void	logError(String message, Object... args)	Logs the message formatted with the array of arguments at error level.
protected void	logError(Supplier<String> message)	Logs the message supplied by the given Supplier at error level.
protected String	loggingProperty(String propertyNameSuffix)
protected void	logInfo(String message, Object... args)	Logs the message formatted with the array of arguments at info level.
protected void	logInfo(Supplier<String> message)	Logs the message supplied by the given Supplier at info level.
protected void	logWarning(String message, Object... args)	Logs the message formatted with the array of arguments at warn level.
protected void	logWarning(Supplier<String> message)	Logs the message supplied by the given Supplier at warning level.
protected String	managementProperty(String propertyNameSuffix)
protected String	managerProperty(String propertyNameSuffix)
protected String	memcachedServiceProperty(String propertyNameSuffix)
protected String	namedCacheServerProperty(String name, String propertyNameSuffix)
protected String	namedDiskStoreProperty(String name, String propertyNameSuffix)
protected String	namedGatewaySenderProperty(String name, String propertyNameSuffix)
protected String	namedPoolProperty(String name, String propertyNameSuffix)
protected EvaluationContext	newEvaluationContext(BeanFactory beanFactory)	Constructs, configures and initializes a new instance of an EvaluationContext.
protected org.slf4j.Logger	newLogger()	Constructs a new instance of Logger to log statements printed by Spring Data for Apache Geode.
protected String	pdxProperty(String propertyNameSuffix)
protected String	poolProperty(String propertyNameSuffix)
protected String	propertyName(String propertyNameSuffix)	Returns the fully-qualified property name.
protected AbstractBeanDefinition	register(AbstractBeanDefinition beanDefinition)	Registers the AbstractBeanDefinition with the BeanDefinitionRegistry using a generated bean name.
protected AbstractBeanDefinition	register(AbstractBeanDefinition beanDefinition, BeanDefinitionRegistry registry)	Registers the AbstractBeanDefinition with the given BeanDefinitionRegistry using a generated bean name.
protected <T> T	requireProperty(String propertyName, Class<T> type)	Resolves the value for the given property identified by name from the Spring Environment as an instance of the specified type.
protected <A extends Annotation> A	resolveAnnotation(AnnotatedElement annotatedElement, Class<A> annotationType)	Resolves the Annotation with the given type from the AnnotatedElement.
protected Optional<Class<?>>	resolveBeanClass(BeanDefinition beanDefinition, ClassLoader classLoader)	Resolves the type of the bean defined by the given BeanDefinition.
protected Optional<Class<?>>	resolveBeanClass(BeanDefinition beanDefinition, ConfigurableBeanFactory beanFactory)	Resolves the type of the bean defined by the given BeanDefinition.
protected Optional<Class<?>>	resolveBeanClass(BeanDefinition beanDefinition, BeanDefinitionRegistry registry)	Resolves the type of the bean defined by the given BeanDefinition.
protected ClassLoader	resolveBeanClassLoader()	Resolves the bean ClassLoader to the configured ClassLoader or the Thread Context ClassLoader.
protected ClassLoader	resolveBeanClassLoader(ConfigurableBeanFactory beanFactory)	Attempts to resolve the ClassLoader used by the ConfigurableBeanFactory to load Class definitions of the beans created by the factory.
protected ClassLoader	resolveBeanClassLoader(BeanDefinitionRegistry registry)	Attempts to resolve the ClassLoader used by the BeanDefinitionRegistry to load Class definitions of the beans defined in the registry.
protected Optional<String>	resolveBeanClassName(BeanDefinition beanDefinition)	Resolves the class type name of the bean defined by the given BeanDefinition.
protected Boolean	resolveProperty(String propertyName, Boolean defaultValue)	Attempts to resolve the property with the given name from the Spring Environment as a Boolean.
protected <T> T	resolveProperty(String propertyName, Class<T> targetType)	Attempts to resolve the property with the given name from the Spring Environment.
protected <T> T	resolveProperty(String propertyName, Class<T> targetType, T defaultValue)	Attempts to resolve the property with the given name from the Spring Environment.
protected Double	resolveProperty(String propertyName, Double defaultValue)	Attempts to resolve the property with the given name from the Spring Environment as an Double.
protected Float	resolveProperty(String propertyName, Float defaultValue)	Attempts to resolve the property with the given name from the Spring Environment as an Float.
protected Integer	resolveProperty(String propertyName, Integer defaultValue)	Attempts to resolve the property with the given name from the Spring Environment as an Integer.
protected Long	resolveProperty(String propertyName, Long defaultValue)	Attempts to resolve the property with the given name from the Spring Environment as a Long.
protected String	resolveProperty(String propertyName, String defaultValue)	Attempts to resolve the property with the given name from the Spring Environment as a String.
protected <T> Class<T>	safeResolveType(AbstractAnnotationConfigSupport.TypeResolver<T> typeResolver)	Safely resolves a type returned by the given AbstractAnnotationConfigSupport.TypeResolver where the type resolution might result in a ClassNotFoundException or NoClassDefFoundError.
protected String	securityProperty(String propertyNameSuffix)
protected String	serviceProperty(String propertyNameSuffix)
void	setBeanClassLoader(ClassLoader beanClassLoader)
void	setBeanFactory(BeanFactory beanFactory)
void	setEnvironment(Environment environment)	Sets a reference to the Spring Environment.
protected String	sslProperty(String propertyNameSuffix)
protected String	statsProperty(String propertyNameSuffix)

Methods inherited from class java.lang.Object

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

Field Details

INFRASTRUCTURE_ROLES

protected static final Set<Integer> INFRASTRUCTURE_ROLES

ORG_SPRINGFRAMEWORK_DATA_GEMFIRE_PACKAGE

protected static final String ORG_SPRINGFRAMEWORK_DATA_GEMFIRE_PACKAGE

See Also:

• Constant Field Values

ORG_SPRINGFRAMEWORK_PACKAGE

protected static final String ORG_SPRINGFRAMEWORK_PACKAGE

See Also:

• Constant Field Values

SPRING_DATA_GEMFIRE_PROPERTY_PREFIX

protected static final String SPRING_DATA_GEMFIRE_PROPERTY_PREFIX

See Also:

• Constant Field Values

CURRENT_THREAD_CONTEXT_CLASS_LOADER

protected static final Supplier<ClassLoader> CURRENT_THREAD_CONTEXT_CLASS_LOADER

Constructor Details

AbstractAnnotationConfigSupport

public AbstractAnnotationConfigSupport()

Constructs a new instance of AbstractAnnotationConfigSupport.

See Also:

• AbstractAnnotationConfigSupport(BeanFactory)

AbstractAnnotationConfigSupport

public AbstractAnnotationConfigSupport(@Nullable
 BeanFactory beanFactory)

Constructs a new instance of AbstractAnnotationConfigSupport initialized with the given, non-required BeanFactory.

Parameters:

beanFactory - reference to the Spring BeanFactory.

See Also:

• BeanFactory
• newEvaluationContext(BeanFactory)
• newLogger()

Method Details

hasValue

public static boolean hasValue(@Nullable
 Number value)

Determines whether the given Number has value. The Number is considered valuable if it is not null and is not equal to 0.0d.

Parameters:

value - Number to evaluate.

Returns:

a boolean value indicating whether the given Number has value.

See Also:

• Number

hasValue

public static boolean hasValue(@Nullable
 Object value)

Determines whether the given Object has value. The Object is considered valuable if it is not null.

Parameters:

value - Object to evaluate.

Returns:

a boolean value indicating whether the given Object has value.

See Also:

• Object

hasValue

public static boolean hasValue(@Nullable
 String value)

Determines whether the given String has value. The String is considered valuable if it is not null and not empty.

Parameters:

value - String to evaluate.

Returns:

a boolean value indicating whether the given String is valuable.

See Also:

• String

newEvaluationContext

protected EvaluationContext newEvaluationContext(@Nullable
 BeanFactory beanFactory)

Constructs, configures and initializes a new instance of an EvaluationContext.

Parameters:

beanFactory - reference to the Spring BeanFactory.

Returns:

a new EvaluationContext.

See Also:

• BeanFactory
• EvaluationContext
• getBeanFactory()

newLogger

@NonNull
protected org.slf4j.Logger newLogger()

Constructs a new instance of Logger to log statements printed by Spring Data for Apache Geode.

Returns:

a new instance of Logger.

See Also:

• LoggerFactory.getLogger(Class)
• Logger

isAnnotationPresent

protected boolean isAnnotationPresent(@NonNull
 AnnotationMetadata importingClassMetadata)

Determines whether the given type meta-data for a particular Class is annotated with the declared getAnnotationTypeName().

Parameters:

importingClassMetadata - type meta-data for a particular Class.

Returns:

a boolean indicating whether the particular Class is annotated with the declared getAnnotationTypeName().

See Also:

• isAnnotationPresent(AnnotationMetadata, String)
• getAnnotationTypeName()
• AnnotationMetadata

isAnnotationPresent

protected boolean isAnnotationPresent(@NonNull
 AnnotationMetadata importingClassMetadata,
 @NonNull
 String annotationName)

Determines whether the given type meta-data for a particular Class is annotated with the given Annotation defined by name.

Parameters:

importingClassMetadata - type meta-data for a particular Class.

annotationName - name of the Annotation of interests.

Returns:

a boolean indicating whether the particular Class is annotated with the given Annotation defined by name.

See Also:

• AnnotationMetadata

getAnnotationAttributes

@NonNull
protected AnnotationAttributes getAnnotationAttributes(@NonNull
 Annotation annotation)

Returns the AnnotationAttributes for the given Annotation.

Parameters:

annotation - Annotation to get the AnnotationAttributes for.

Returns:

the AnnotationAttributes for the given Annotation.

See Also:

• AnnotationAttributes
• Annotation

getAnnotationAttributes

@NonNull
protected AnnotationAttributes getAnnotationAttributes(@NonNull
 AnnotationMetadata importingClassMetadata)

Returns AnnotationAttributes for the declared getAnnotationTypeName().

Parameters:

importingClassMetadata - type meta-data for a particular Class.

Returns:

AnnotationAttributes for the declared getAnnotationTypeName().

See Also:

• AnnotationAttributes
• AnnotationMetadata
• getAnnotationAttributes(AnnotationMetadata, String)
• getAnnotationTypeName()

getAnnotationAttributes

@NonNull
protected AnnotationAttributes getAnnotationAttributes(@NonNull
 AnnotationMetadata importingClassMetadata,
 @NonNull
 String annotationName)

Returns AnnotationAttributes for the given named Annotation from the given type meta-data.

Parameters:

importingClassMetadata - type meta-data for a particular Class.

annotationName - name of the Annotation of interests.

Returns:

AnnotationAttributes for the given named Annotation.

See Also:

• AnnotationAttributes
• AnnotationMetadata

getAnnotationType

@NonNull
protected abstract Class<? extends Annotation> getAnnotationType()

Returns the cache application Annotation type pertaining to this configuration.

Returns:

the cache application Annotation type used by this application.

getAnnotationTypeName

@NonNull
protected String getAnnotationTypeName()

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

Returns:

the fully-qualified class name of the cache application Annotation type.

See Also:

• Class.getName()
• getAnnotationType()

getAnnotationTypeSimpleName

@NonNull
protected String getAnnotationTypeSimpleName()

Returns the simple class name of the cache application Annotation type.

Returns:

the simple class name of the cache application Annotation type.

See Also:

• Class.getSimpleName()
• getAnnotationType()

isNotInfrastructureBean

protected boolean isNotInfrastructureBean(@Nullable
 Object bean)

Null-safe method used to determine whether the given bean is a Spring container provided infrastructure bean.

Parameters:

bean - Object to evaluate.

Returns:

true iff the bean is not a Spring container provided infrastructure bean.

See Also:

• isNotInfrastructureClass(String)
• Object.getClass()
• Class.getName()

isNotInfrastructureBean

protected boolean isNotInfrastructureBean(@Nullable
 BeanDefinition beanDefinition)

Null-safe method used to determine whether the bean defined by the given BeanDefinition is a Spring container provided infrastructure bean.

Parameters:

beanDefinition - BeanDefinition to evaluate.

Returns:

true iff the bean defined by the given BeanDefinition is not a Spring container provided infrastructure bean.

See Also:

• BeanDefinition
• isNotInfrastructureClass(BeanDefinition)
• isNotInfrastructureRole(BeanDefinition)

isNotInfrastructureClass

protected boolean isNotInfrastructureClass(@Nullable
 BeanDefinition beanDefinition)

Null-safe method used to determine whether the bean defined by the given BeanDefinition is a Spring container infrastructure bean based on the bean's class name.

Parameters:

beanDefinition - BeanDefinition of the bean to evaluate.

Returns:

true iff the bean defined in the given BeanDefinition is not a Spring container infrastructure bean. Returns false if the bean class name cannot be resolved.

See Also:

• BeanDefinition
• resolveBeanClassName(BeanDefinition)
• isNotInfrastructureClass(String)

isNotInfrastructureRole

protected boolean isNotInfrastructureRole(@Nullable
 BeanDefinition beanDefinition)

Null-safe method to determines whether the bean defined by the given BeanDefinition is a Spring container infrastructure bean based on the bean's role.

Parameters:

beanDefinition - BeanDefinition of the bean to evaluate.

Returns:

true iff the bean defined in the given BeanDefinition is not a Spring container infrastructure bean.

See Also:

• BeanDefinition

isUserLevelMethod

protected boolean isUserLevelMethod(@Nullable
 Method method)

Determines whether the given Method was declared and defined by the user. A Method is considered a user-level Method if the Method is not an Object class method, is a Bridge Method or is not Method.isSynthetic() nor a Groovy method.

Parameters:

method - Method to evaluate.

Returns:

a boolean value indicating whether the Method was declared/defined by the user.

See Also:

• Method

setBeanClassLoader

public void setBeanClassLoader(@Nullable
 ClassLoader beanClassLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

getBeanClassLoader

@Nullable
protected ClassLoader getBeanClassLoader()

Returns a reference to the ClassLoader use by the Spring BeanFactory to load classes for bean definitions.

Returns:

the ClassLoader used by the Spring BeanFactory to load classes for bean definitions.

See Also:

• setBeanClassLoader(ClassLoader)

resolveBeanClassLoader

@NonNull
protected ClassLoader resolveBeanClassLoader()

Resolves the bean ClassLoader to the configured ClassLoader or the Thread Context ClassLoader.

Returns:

the configured ClassLoader or the Thread Context ClassLoader.

See Also:

• Thread.getContextClassLoader()
• getBeanClassLoader()

setBeanFactory

public void setBeanFactory(@Nullable
 BeanFactory beanFactory)
                    throws BeansException

Specified by:

setBeanFactory in interface BeanFactoryAware

Throws:

BeansException

getBeanFactory

@NonNull
protected BeanFactory getBeanFactory()

Returns a reference to the Spring BeanFactory in the current application context.

Returns:

a reference to the Spring BeanFactory.

Throws:

IllegalStateException - if the Spring BeanFactory was not properly configured.

See Also:

• BeanFactory

setEnvironment

public void setEnvironment(@Nullable
 Environment environment)

Sets a reference to the Spring Environment.

Specified by:

setEnvironment in interface EnvironmentAware

Parameters:

environment - Spring Environment.

See Also:

• EnvironmentAware.setEnvironment(Environment)
• Environment

getEnvironment

@Nullable
protected Environment getEnvironment()

Returns a reference to the Spring Environment.

Returns:

a reference to the Spring Environment.

See Also:

• Environment

getEvaluationContext

@NonNull
protected EvaluationContext getEvaluationContext()

Returns a reference to the EvaluationContext used to evaluate SpEL expressions.

Returns:

a reference to the EvaluationContext used to evaluate SpEL expressions.

See Also:

• EvaluationContext

getLogger

@NonNull
protected org.slf4j.Logger getLogger()

Returns a reference to the Logger used by this class to log messages.

Returns:

a reference to the Logger used by this class to log messages.

See Also:

• Log

logDebug

protected void logDebug(String message,
 Object... args)

Logs the message formatted with the array of arguments at debug level.

Parameters:

message - String containing the message to log.

args - array of arguments used to format the message.

See Also:

• logDebug(Supplier)

logDebug

protected void logDebug(Supplier<String> message)

Logs the message supplied by the given Supplier at debug level.

Parameters:

message - Supplier containing the message and arguments to log.

See Also:

• Log.isDebugEnabled()
• Log.debug(Object)
• getLogger()

logInfo

protected void logInfo(String message,
 Object... args)

Logs the message formatted with the array of arguments at info level.

Parameters:

message - String containing the message to log.

args - array of arguments used to format the message.

See Also:

• logInfo(Supplier)

logInfo

protected void logInfo(Supplier<String> message)

Logs the message supplied by the given Supplier at info level.

Parameters:

message - Supplier containing the message and arguments to log.

See Also:

• Log.isInfoEnabled()
• Log.info(Object)
• getLogger()

logWarning

protected void logWarning(String message,
 Object... args)

Logs the message formatted with the array of arguments at warn level.

Parameters:

message - String containing the message to log.

args - array of arguments used to format the message.

See Also:

• logWarning(Supplier)

logWarning

protected void logWarning(Supplier<String> message)

Logs the message supplied by the given Supplier at warning level.

Parameters:

message - Supplier containing the message and arguments to log.

See Also:

• Log.isWarnEnabled()
• Log.warn(Object)
• getLogger()

logError

protected void logError(String message,
 Object... args)

Logs the message formatted with the array of arguments at error level.

Parameters:

message - String containing the message to log.

args - array of arguments used to format the message.

See Also:

• logError(Supplier)

logError

protected void logError(Supplier<String> message)

Logs the message supplied by the given Supplier at error level.

Parameters:

message - Supplier containing the message and arguments to log.

See Also:

• Log.isErrorEnabled()
• Log.error(Object)
• getLogger()

register

@NonNull
protected AbstractBeanDefinition register(@NonNull
 AbstractBeanDefinition beanDefinition)

Registers the AbstractBeanDefinition with the BeanDefinitionRegistry using a generated bean name.

Parameters:

beanDefinition - AbstractBeanDefinition to register.

Returns:

the given AbstractBeanDefinition.

See Also:

• BeanFactory
• AbstractBeanDefinition
• BeanDefinitionRegistry
• BeanDefinitionReaderUtils.registerWithGeneratedName(AbstractBeanDefinition, BeanDefinitionRegistry)
• getBeanFactory()

register

@NonNull
protected AbstractBeanDefinition register(@NonNull
 AbstractBeanDefinition beanDefinition,
 @Nullable
 BeanDefinitionRegistry registry)

Registers the AbstractBeanDefinition with the given BeanDefinitionRegistry using a generated bean name.

Parameters:

beanDefinition - AbstractBeanDefinition to register.

registry - BeanDefinitionRegistry used to register the AbstractBeanDefinition.

Returns:

the given AbstractBeanDefinition.

See Also:

• AbstractBeanDefinition
• BeanDefinitionRegistry
• BeanDefinitionReaderUtils.registerWithGeneratedName(AbstractBeanDefinition, BeanDefinitionRegistry)

arrayOfPropertyNamesFor

protected List<String> arrayOfPropertyNamesFor(String propertyNamePrefix)

arrayOfPropertyNamesFor

protected List<String> arrayOfPropertyNamesFor(String propertyNamePrefix,
 String propertyNameSuffix)

asArrayProperty

protected String asArrayProperty(String propertyNamePrefix,
 int index,
 String propertyNameSuffix)

cacheProperty

protected String cacheProperty(String propertyNameSuffix)

cacheClientProperty

protected String cacheClientProperty(String propertyNameSuffix)

cacheCompressionProperty

protected String cacheCompressionProperty(String propertyNameSuffix)

cacheOffHeapProperty

protected String cacheOffHeapProperty(String propertyNameSuffix)

cachePeerProperty

protected String cachePeerProperty(String propertyNameSuffix)

cacheServerProperty

protected String cacheServerProperty(String propertyNameSuffix)

namedCacheServerProperty

protected String namedCacheServerProperty(String name,
 String propertyNameSuffix)

clusterProperty

protected String clusterProperty(String propertyNameSuffix)

diskStoreProperty

protected String diskStoreProperty(String propertyNameSuffix)

namedDiskStoreProperty

protected String namedDiskStoreProperty(String name,
 String propertyNameSuffix)

entitiesProperty

protected String entitiesProperty(String propertyNameSuffix)

locatorProperty

protected String locatorProperty(String propertyNameSuffix)

loggingProperty

protected String loggingProperty(String propertyNameSuffix)

managementProperty

protected String managementProperty(String propertyNameSuffix)

managerProperty

protected String managerProperty(String propertyNameSuffix)

pdxProperty

protected String pdxProperty(String propertyNameSuffix)

poolProperty

protected String poolProperty(String propertyNameSuffix)

namedPoolProperty

protected String namedPoolProperty(String name,
 String propertyNameSuffix)

securityProperty

protected String securityProperty(String propertyNameSuffix)

sslProperty

protected String sslProperty(String propertyNameSuffix)

statsProperty

protected String statsProperty(String propertyNameSuffix)

serviceProperty

protected String serviceProperty(String propertyNameSuffix)

memcachedServiceProperty

protected String memcachedServiceProperty(String propertyNameSuffix)

httpServiceProperty

protected String httpServiceProperty(String propertyNameSuffix)

gatewayReceiverProperty

protected String gatewayReceiverProperty(String propertyNameSuffix)

gatewaySenderProperty

protected String gatewaySenderProperty(String propertyNameSuffix)

namedGatewaySenderProperty

protected String namedGatewaySenderProperty(String name,
 String propertyNameSuffix)

propertyName

protected String propertyName(String propertyNameSuffix)

Returns the fully-qualified property name. The fully qualified property name consists of the property name concatenated with the propertyNameSuffix.

Parameters:

propertyNameSuffix - String containing the property name suffix concatenated with the base property name.

Returns:

the fully-qualified property name.

See Also:

• String

requireProperty

protected <T> T requireProperty(String propertyName,
 Class<T> type)

Resolves the value for the given property identified by name from the Spring Environment as an instance of the specified type.

Type Parameters:

T - Class type of the propertyName property's assigned value.

Parameters:

propertyName - String containing the name of the required property to resolve.

type - Class type of the property's assigned value.

Returns:

the assigned value of the named property.

Throws:

IllegalArgumentException - if the property has not been assigned a value. For String values, this also means the value cannot be empty. For non-String values, this means the value must not be null.

See Also:

• resolveProperty(String, Class, Object)

resolveAnnotation

protected <A extends Annotation> A resolveAnnotation(AnnotatedElement annotatedElement,
 Class<A> annotationType)

Resolves the Annotation with the given type from the AnnotatedElement.

Type Parameters:

A - Subclass type of the resolved Annotation.

Parameters:

annotatedElement - AnnotatedElement from which to resolve the Annotation.

annotationType - type of the Annotation to resolve from the AnnotatedElement.

Returns:

the resolved Annotation.

See Also:

• Annotation
• AnnotatedElement
• Class

resolveBeanClass

protected Optional<Class<?>> resolveBeanClass(@Nullable
 BeanDefinition beanDefinition,
 @Nullable
 BeanDefinitionRegistry registry)

Resolves the type of the bean defined by the given BeanDefinition.

Parameters:

beanDefinition - BeanDefinition defining the bean from which the type is resolved.

registry - BeanDefinitionRegistry used to resolve the ClassLoader used to resolve the bean's type.

Returns:

an Optional Class specifying the resolved type of the bean.

See Also:

• BeanDefinition
• BeanDefinitionRegistry
• resolveBeanClassLoader(BeanDefinitionRegistry)
• resolveBeanClass(BeanDefinition, ClassLoader)

resolveBeanClass

protected Optional<Class<?>> resolveBeanClass(@Nullable
 BeanDefinition beanDefinition,
 @NonNull
 ConfigurableBeanFactory beanFactory)

Resolves the type of the bean defined by the given BeanDefinition.

Parameters:

beanDefinition - BeanDefinition defining the bean from which the type is resolved.

beanFactory - ConfigurableBeanFactory used to resolve the ClassLoader used to resolve the bean's type.

Returns:

an Optional Class specifying the resolved type of the bean.

See Also:

• BeanDefinition
• ConfigurableBeanFactory
• resolveBeanClassLoader(ConfigurableBeanFactory)
• resolveBeanClass(BeanDefinition, ClassLoader)

resolveBeanClass

protected Optional<Class<?>> resolveBeanClass(@Nullable
 BeanDefinition beanDefinition,
 @Nullable
 ClassLoader classLoader)

Resolves the type of the bean defined by the given BeanDefinition.

Parameters:

beanDefinition - BeanDefinition defining the bean from which the type is resolved.

classLoader - ClassLoader used to resolve the bean's type.

Returns:

an Optional resolved type of the bean.

See Also:

• ClassLoader
• BeanDefinition
• AbstractBeanDefinition.resolveBeanClass(ClassLoader)
• ClassUtils.forName(String, ClassLoader)
• resolveBeanClassName(BeanDefinition)

resolveBeanClassLoader

@NonNull
protected ClassLoader resolveBeanClassLoader(@Nullable
 BeanDefinitionRegistry registry)

Attempts to resolve the ClassLoader used by the BeanDefinitionRegistry to load Class definitions of the beans defined in the registry.

Parameters:

registry - BeanDefinitionRegistry from which to resolve the ClassLoader.

Returns:

the resolved ClassLoader from the BeanDefinitionRegistry or the current Thread's context ClassLoader.

See Also:

• ConfigurableBeanFactory.getBeanClassLoader()
• BeanDefinitionRegistry
• Thread.getContextClassLoader()
• Thread.currentThread()

resolveBeanClassLoader

@NonNull
protected ClassLoader resolveBeanClassLoader(@Nullable
 ConfigurableBeanFactory beanFactory)

Attempts to resolve the ClassLoader used by the ConfigurableBeanFactory to load Class definitions of the beans created by the factory.

Parameters:

beanFactory - ConfigurableBeanFactory from which to resolve the ClassLoader.

Returns:

the resolved ClassLoader from the ConfigurableBeanFactory or the current Thread's context ClassLoader.

See Also:

• ConfigurableBeanFactory.getBeanClassLoader()
• ConfigurableBeanFactory
• Thread.getContextClassLoader()
• Thread.currentThread()

resolveBeanClassName

protected Optional<String> resolveBeanClassName(@Nullable
 BeanDefinition beanDefinition)

Resolves the class type name of the bean defined by the given BeanDefinition.

Parameters:

beanDefinition - BeanDefinition defining the bean from which to resolve the class type name.

Returns:

an Optional String containing the resolved class type name of the bean defined by the given BeanDefinition.

See Also:

• BeanDefinition.getBeanClassName()

resolveProperty

protected Boolean resolveProperty(String propertyName,
 Boolean defaultValue)

Attempts to resolve the property with the given name from the Spring Environment as a Boolean.

Parameters:

propertyName - name of the property to resolve.

defaultValue - default value to return if the property is not defined or not set.

Returns:

the value of the property identified by name or default value if the property is not defined or not set.

See Also:

• resolveProperty(String, Class, Object)

resolveProperty

protected Double resolveProperty(String propertyName,
 Double defaultValue)

Attempts to resolve the property with the given name from the Spring Environment as an Double.

Parameters:

propertyName - name of the property to resolve.

defaultValue - default value to return if the property is not defined or not set.

Returns:

the value of the property identified by name or default value if the property is not defined or not set.

See Also:

• resolveProperty(String, Class, Object)

resolveProperty

protected Float resolveProperty(String propertyName,
 Float defaultValue)

Attempts to resolve the property with the given name from the Spring Environment as an Float.

Parameters:

propertyName - name of the property to resolve.

defaultValue - default value to return if the property is not defined or not set.

Returns:

the value of the property identified by name or default value if the property is not defined or not set.

See Also:

• resolveProperty(String, Class, Object)

resolveProperty

protected Integer resolveProperty(String propertyName,
 Integer defaultValue)

Attempts to resolve the property with the given name from the Spring Environment as an Integer.

Parameters:

propertyName - name of the property to resolve.

defaultValue - default value to return if the property is not defined or not set.

Returns:

the value of the property identified by name or default value if the property is not defined or not set.

See Also:

• resolveProperty(String, Class, Object)

resolveProperty

protected Long resolveProperty(String propertyName,
 Long defaultValue)

Attempts to resolve the property with the given name from the Spring Environment as a Long.

Parameters:

propertyName - name of the property to resolve.

defaultValue - default value to return if the property is not defined or not set.

Returns:

the value of the property identified by name or default value if the property is not defined or not set.

See Also:

• resolveProperty(String, Class, Object)

resolveProperty

protected String resolveProperty(String propertyName,
 String defaultValue)

Attempts to resolve the property with the given name from the Spring Environment as a String.

Parameters:

propertyName - name of the property to resolve.

defaultValue - default value to return if the property is not defined or not set.

Returns:

the value of the property identified by name or default value if the property is not defined or not set.

See Also:

• resolveProperty(String, Class, Object)

resolveProperty

protected <T> T resolveProperty(String propertyName,
 Class<T> targetType)

Attempts to resolve the property with the given name from the Spring Environment.

Type Parameters:

T - Class type of the property value.

Parameters:

propertyName - name of the property to resolve.

targetType - Class type of the property's value.

Returns:

the value of the property identified by name or null if the property is not defined or not set.

See Also:

• resolveProperty(String, Class, Object)

resolveProperty

protected <T> T resolveProperty(String propertyName,
 Class<T> targetType,
 T defaultValue)

Attempts to resolve the property with the given name from the Spring Environment.

Type Parameters:

T - Class type of the property value.

Parameters:

propertyName - name of the property to resolve.

targetType - Class type of the property's value.

defaultValue - default value to return if the property is not defined or not set.

Returns:

the value of the property identified by name or default value if the property is not defined or not set.

See Also:

• getEnvironment()

safeResolveType

@Nullable
protected <T> Class<T> safeResolveType(@NonNull
 AbstractAnnotationConfigSupport.TypeResolver<T> typeResolver)

Safely resolves a type returned by the given AbstractAnnotationConfigSupport.TypeResolver where the type resolution might result in a ClassNotFoundException or NoClassDefFoundError.

Type Parameters:

T - Class of the type being resolved.

Parameters:

typeResolver - AbstractAnnotationConfigSupport.TypeResolver used to resolve a specific type.

Returns:

the resolved type or null if the type returned by the AbstractAnnotationConfigSupport.TypeResolver could not be resolved.

See Also:

• AbstractAnnotationConfigSupport.TypeResolver
• ClassNotFoundException
• NoClassDefFoundError
• Class