org.springframework.data.gemfire

Class LazyWiringDeclarableSupport

java.lang.Object

org.springframework.data.gemfire.LazyWiringDeclarableSupport

All Implemented Interfaces:

com.gemstone.gemfire.cache.Declarable, EventListener, DisposableBean, ApplicationListener<ContextRefreshedEvent>

public abstract class LazyWiringDeclarableSupport
extends Object
implements ApplicationListener<ContextRefreshedEvent>, com.gemstone.gemfire.cache.Declarable, DisposableBean

The LazyWiringDeclarableSupport class is an implementation of the GemFire Declarable interface that enables support for wiring GemFire components with Spring bean dependencies defined in the Spring context.

Since:

1.3.4

See Also:

Properties, DisposableBean, BeanConfigurerSupport, BeanWiringInfo, BeanWiringInfoResolver, ApplicationListener, ConfigurableApplicationContext, ContextRefreshedEvent, DeclarableSupport, WiringDeclarableSupport, SpringContextBootstrappingInitializer, Declarable

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	BEAN_NAME_PARAMETER

Constructor Summary

Constructors

Constructor and Description
LazyWiringDeclarableSupport() Constructs an instance of the LazyWiringDeclarableSupport class registered with the SpringContextBootstrappingInitializer.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	assertInitialized() Asserts that this Declarable object has been properly configured and initialized by the Spring container after GemFire has constructed this Declarable object during startup.
protected void	assertUninitialized() Asserts that this Declarable object has not yet been used, or activated prior to being fully configured and initialized.
void	destroy() When this bean gets destroyed by the Spring container, make sure this component gets unregistered from the SpringContextBootstrappingInitializer.
protected void	doPostInit(Properties parameters) Default no operation method performed post initialization of this Declarable GemFire component to be overridden by subclasses for application specific extension and behavior.
protected String	getFactoryKey() Gets the key used to locate (lookup) the Spring BeanFactory.
void	init(Properties parameters) Initialization method called by GemFire with configured parameters once this Declarable object has been constructed during GemFire startup using an <initalizer> element in GemFire's configuration meta-data.
protected boolean	isInitialized() Determines whether this Declarable object has been configured and initialized (i.e. the doInit method has been called) by the Spring container.
protected boolean	isNotInitialized() Determines whether this Declarable object has been configured and initialized (i.e. the doInit method has been called) by the Spring container.
protected BeanFactory	locateBeanFactory(String factoryKey) Locates an existing Spring BeanFactory.
protected Properties	nullSafeGetParameters() Null-safe operation to return the parameters passed to this Declarable object when created by GemFire from it's configuration meta-data.
void	onApplicationEvent(ContextRefreshedEvent event) Event handler method called when GemFire has created and initialized (refreshed) the Spring ApplicationContext using the SpringContextBootstrappingInitializer Declarable class.
void	setFactoryKey(String factoryKey) Set the key used to locate (lookup) the Spring BeanFactory.

Methods inherited from class java.lang.Object

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

Field Detail

BEAN_NAME_PARAMETER

protected static final String BEAN_NAME_PARAMETER

See Also:

Constant Field Values

Constructor Detail

LazyWiringDeclarableSupport

public LazyWiringDeclarableSupport()

Constructs an instance of the LazyWiringDeclarableSupport class registered with the SpringContextBootstrappingInitializer. This Declarable will receive notifications from the SpringContextBootstrappingInitializer when the Spring context is created and initialized (refreshed). The notification is necessary in order for this Declarable component to be configured and properly initialized with any required Spring bean dependencies.

See Also:

#register(org.springframework.context.ApplicationListener)

Method Detail

setFactoryKey

public final void setFactoryKey(String factoryKey)

Set the key used to locate (lookup) the Spring BeanFactory.

Parameters:

factoryKey - the key used to locate the Spring BeanFactory.

See Also:

BeanFactory, GemfireBeanFactoryLocator, getFactoryKey()

getFactoryKey

protected String getFactoryKey()

Gets the key used to locate (lookup) the Spring BeanFactory.

Returns:

the key used to locate the Spring BeanFactory.

See Also:

BeanFactory, GemfireBeanFactoryLocator, setFactoryKey(String)

assertInitialized

protected void assertInitialized()

Asserts that this Declarable object has been properly configured and initialized by the Spring container after GemFire has constructed this Declarable object during startup. It is recommended to call this method in any GemFire CacheCallback/Declarable object operational method (e.g. CacheLoader.load(..)) before use in order to ensure that this Declarable was properly constructed, configured and initialized.

Throws:

IllegalStateException - if the Declarable object has not been properly configured or initialized by the Spring container.

See Also:

init(java.util.Properties), isInitialized()

assertUninitialized

protected void assertUninitialized()

Asserts that this Declarable object has not yet been used, or activated prior to being fully configured and initialized. It is possible, though rare, that the init(:Properties) might be called multiple times by GemFire before the Spring container configure, initializes and puts this component to use.

Throws:

IllegalStateException - if the Declarable object has already been configured and initialized by the Spring container.

See Also:

init(java.util.Properties), isInitialized()

doPostInit

protected void doPostInit(Properties parameters)

Default no operation method performed post initialization of this Declarable GemFire component to be overridden by subclasses for application specific extension and behavior.

Parameters:

parameters - Properties instance containing the parameters from GemFire's configuration file (e.g. cache.xml) to configure and initialize this Declarable object.

See Also:

doInit(BeanFactory, Properties)

init

public final void init(Properties parameters)

Initialization method called by GemFire with configured parameters once this Declarable object has been constructed during GemFire startup using an <initalizer> element in GemFire's configuration meta-data.

Specified by:

init in interface com.gemstone.gemfire.cache.Declarable

Parameters:

parameters - the configured parameters passed from the GemFire configuration (e.g. cache.xml) to this Declarable as a Properties instance.

Throws:

IllegalStateException - if this Declarable object has already been configured/initialized by the Spring container and is currently active.

See Also:

doInit(BeanFactory, Properties), Properties

isInitialized

protected boolean isInitialized()

Determines whether this Declarable object has been configured and initialized (i.e. the doInit method has been called) by the Spring container.

Returns:

a boolean value indicating whether this Declarable object has been configured and initialized by the Spring container.

See Also:

assertInitialized(), doInit(BeanFactory, Properties)

isNotInitialized

protected boolean isNotInitialized()

Determines whether this Declarable object has been configured and initialized (i.e. the doInit method has been called) by the Spring container.

Returns:

a boolean value indicating whether this Declarable object has been configured and initialized by the Spring container.

See Also:

doInit(BeanFactory, Properties), isInitialized()

locateBeanFactory

protected BeanFactory locateBeanFactory(String factoryKey)

Locates an existing Spring BeanFactory.

Parameters:

factoryKey - the key used to locate (lookup) the Spring BeanFactory.

Returns:

a reference to the Spring BeanFactory if it exists.

Throws:

IllegalStateException - if the BeanFactory has already been released or closed.

See Also:

GemfireBeanFactoryLocator, BeanFactory

nullSafeGetParameters

protected Properties nullSafeGetParameters()

Null-safe operation to return the parameters passed to this Declarable object when created by GemFire from it's configuration meta-data.

Returns:

a Properties object containing the a parameters specified for this Declarable, or an empty Properties object if no parameters were supplied.

See Also:

Properties

onApplicationEvent

public final void onApplicationEvent(ContextRefreshedEvent event)

Event handler method called when GemFire has created and initialized (refreshed) the Spring ApplicationContext using the SpringContextBootstrappingInitializer Declarable class.

Specified by:

onApplicationEvent in interface ApplicationListener<ContextRefreshedEvent>

Parameters:

event - the ContextRefreshedEvent published by the Spring ApplicationContext after it is successfully created and initialized by GemFire.

Throws:

IllegalArgumentException - if the ApplicationContext is not an instance of ConfigurableApplicationContext.

See Also:

doInit(BeanFactory, Properties), nullSafeGetParameters(), ApplicationListener.onApplicationEvent(org.springframework.context.ApplicationEvent), ContextRefreshedEvent

destroy

public void destroy()
             throws Exception

When this bean gets destroyed by the Spring container, make sure this component gets unregistered from the SpringContextBootstrappingInitializer.

Specified by:

destroy in interface DisposableBean

Throws:

Exception - if bean destruction is unsuccessful.

See Also:

#unregister(org.springframework.context.ApplicationListener)