org.springframework.data.gemfire.support

Class AbstractFactoryBeanSupport<T>

java.lang.Object

org.springframework.data.gemfire.support.AbstractFactoryBeanSupport<T>

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, FactoryBean<T>

Direct Known Subclasses:

AbstractBasicCacheFactoryBean, AbstractWANComponentFactoryBean, CacheServerFactoryBean, DiskStoreFactoryBean, GemfireFunctionProxyFactoryBean, IndexFactoryBean, LocatorFactoryBean, LuceneIndexFactoryBean, LuceneServiceFactoryBean, PartitionAttributesFactoryBean, PoolFactoryBean, ResolvableRegionFactoryBean, SmartCacheResolverFactoryBean, SnapshotServiceFactoryBean

public abstract class AbstractFactoryBeanSupport<T>
extends Object
implements FactoryBean<T>, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware

An abstract Spring FactoryBean base class implementation encapsulating operations common to all Spring Data for Apache Geode (SDG) FactoryBean implementations.

Since:

1.0.0

Author:

John Blum

See Also:

Logger, LoggerFactory, BeanClassLoaderAware, BeanFactory, BeanFactoryAware, BeanNameAware, FactoryBean

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	DEFAULT_SINGLETON

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFactoryBeanSupport() Constructs a new instance of AbstractFactoryBeanSupport initializing a Logger to log operations performed by this FactoryBean.

Method Summary

Modifier and Type	Method and Description
ClassLoader	getBeanClassLoader() Returns a reference to the ClassLoader used by the Spring container to load bean classes.
BeanFactory	getBeanFactory() Returns a reference to the Spring BeanFactory in which this FactoryBean was declared.
String	getBeanName() Returns the bean name assigned to this FactoryBean as declared in the Spring container.
protected org.slf4j.Logger	getLogger() Returns a reference to the Logger used by this FactoryBean to log messages.
protected Optional<org.slf4j.Logger>	getOptionalLogger() Returns an Optional reference to the Logger used by this FactoryBean to log messages.
boolean	isDebugLoggingEnabled() Determines whether DEBUG logging is enabled.
boolean	isErrorLoggingEnabled() Determines whether ERROR logging is enabled.
boolean	isInfoLoggingEnabled() Determines whether INFO logging is enabled.
boolean	isSingleton() Indicates that this FactoryBean produces a single bean instance.
boolean	isWarnLoggingEnabled() Determines whether WARN logging is enabled.
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 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 warn level.
protected org.slf4j.Logger	newLogger() Constructs a new instance of Logger to log statements printed by Spring Data for Apache Geode.
void	setBeanClassLoader(ClassLoader classLoader) Sets a reference to the ClassLoader used by the Spring container to load bean classes.
void	setBeanFactory(BeanFactory beanFactory) Sets a reference to the Spring BeanFactory in which this FactoryBean was declared.
void	setBeanName(String name) Sets the bean name assigned to this FactoryBean as declared in the Spring container.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.beans.factory.FactoryBean

getObject, getObjectType

Field Detail

DEFAULT_SINGLETON

protected static final boolean DEFAULT_SINGLETON

See Also:

Constant Field Values

Constructor Detail

AbstractFactoryBeanSupport

protected AbstractFactoryBeanSupport()

Constructs a new instance of AbstractFactoryBeanSupport initializing a Logger to log operations performed by this FactoryBean.

See Also:

newLogger()

Method Detail

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 SLF4J Logger.

See Also:

LogFactory, Log

setBeanClassLoader

public void setBeanClassLoader(@Nullable
                               ClassLoader classLoader)

Sets a reference to the ClassLoader used by the Spring container to load bean classes.

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

Parameters:

classLoader - ClassLoader used by the Spring container to load bean classes.

See Also:

BeanClassLoaderAware.setBeanClassLoader(ClassLoader), ClassLoader, Class

getBeanClassLoader

@Nullable
public ClassLoader getBeanClassLoader()

Returns a reference to the ClassLoader used by the Spring container to load bean classes.

Returns:

the ClassLoader used by the Spring container to load bean classes.

See Also:

BeanClassLoaderAware.setBeanClassLoader(ClassLoader), ClassLoader, Class

setBeanFactory

public void setBeanFactory(@Nullable
                           BeanFactory beanFactory)
                    throws BeansException

Sets a reference to the Spring BeanFactory in which this FactoryBean was declared.

Specified by:

setBeanFactory in interface BeanFactoryAware

Parameters:

beanFactory - reference to the declaring Spring BeanFactory.

Throws:

BeansException

See Also:

BeanFactoryAware.setBeanFactory(BeanFactory), BeanFactory

getBeanFactory

@Nullable
public BeanFactory getBeanFactory()

Returns a reference to the Spring BeanFactory in which this FactoryBean was declared.

Returns:

a reference to the declaring Spring BeanFactory.

See Also:

BeanFactoryAware.setBeanFactory(BeanFactory), BeanFactory

setBeanName

public void setBeanName(@Nullable
                        String name)

Sets the bean name assigned to this FactoryBean as declared in the Spring container.

Specified by:

setBeanName in interface BeanNameAware

Parameters:

name - bean name assigned to this FactoryBean as declared in the Spring container.

See Also:

BeanNameAware.setBeanName(String), String

getBeanName

@Nullable
public String getBeanName()

Returns the bean name assigned to this FactoryBean as declared in the Spring container.

Returns:

the bean name assigned to this FactoryBean as declared in the Spring container.

See Also:

BeanNameAware.setBeanName(String), String

getLogger

@NonNull
protected org.slf4j.Logger getLogger()

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

Returns:

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

See Also:

Log

getOptionalLogger

protected Optional<org.slf4j.Logger> getOptionalLogger()

Returns an Optional reference to the Logger used by this FactoryBean to log messages.

Returns:

an Optional reference to the Logger used by this FactoryBean to log messages.

See Also:

Optional, Logger, getLogger()

isDebugLoggingEnabled

public boolean isDebugLoggingEnabled()

Determines whether DEBUG logging is enabled.

Returns:

a boolean value indicating whether DEBUG logging is enabled.

See Also:

Logger.isDebugEnabled(), getOptionalLogger()

isInfoLoggingEnabled

public boolean isInfoLoggingEnabled()

Determines whether INFO logging is enabled.

Returns:

a boolean value indicating whether INFO logging is enabled.

See Also:

Logger.isInfoEnabled(), getOptionalLogger()

isWarnLoggingEnabled

public boolean isWarnLoggingEnabled()

Determines whether WARN logging is enabled.

Returns:

a boolean value indicating whether WARN logging is enabled.

See Also:

Logger.isWarnEnabled(), getOptionalLogger()

isErrorLoggingEnabled

public boolean isErrorLoggingEnabled()

Determines whether ERROR logging is enabled.

Returns:

a boolean value indicating whether ERROR logging is enabled.

See Also:

Logger.isErrorEnabled(), getOptionalLogger()

isSingleton

public boolean isSingleton()

Indicates that this FactoryBean produces a single bean instance.

Specified by:

isSingleton in interface FactoryBean<T>

Returns:

true by default.

See Also:

FactoryBean.isSingleton()

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 warn 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()