Package org.springframework.data.gemfire.support

Class LazyWiringDeclarableSupport

java.lang.Object

org.springframework.data.gemfire.support.DeclarableSupport

org.springframework.data.gemfire.support.WiringDeclarableSupport

org.springframework.data.gemfire.support.LazyWiringDeclarableSupport

All Implemented Interfaces:

EventListener, CacheCallback, Declarable, DisposableBean, ApplicationListener<ContextRefreshedEvent>

public abstract class LazyWiringDeclarableSupport
extends WiringDeclarableSupport
implements ApplicationListener<ContextRefreshedEvent>, DisposableBean

The LazyWiringDeclarableSupport class is an implementation of GemFire's Declarable interface that enables support for wiring GemFire components with Spring bean dependencies defined in a Spring ApplicationContext.

Since:

1.3.4

Author:

John Blum

See Also:

• Properties
• CacheCallback
• Declarable
• BeanFactory
• DisposableBean
• ConfigurableListableBeanFactory
• ApplicationContext
• ApplicationListener
• ContextRefreshedEvent
• SpringContextBootstrappingInitializer
• WiringDeclarableSupport

Field Summary

Fields inherited from class org.springframework.data.gemfire.support.WiringDeclarableSupport

TEMPLATE_BEAN_NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
LazyWiringDeclarableSupport()	Constructs a new instance of the LazyWiringDeclarableSupport class registered with the SpringContextBootstrappingInitializer as a Spring ApplicationListener.

Method Summary

Modifier and Type	Method	Description
protected void	assertInitialized()	Asserts that this Declarable object has been properly configured and initialized by the Spring container after has GemFire 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 constructed, configured and initialized by the Spring container.
void	destroy()	When this Declarable object/bean gets destroyed by the Spring container, destroy() will make sure this component gets unregistered from the SpringContextBootstrappingInitializer properly.
protected void	doPostInit(Properties parameters)	Performs any post configuration and initialization activities required by the application.
final void	init(Properties parameters)	Initialization method called by GemFire with the configured parameters once this Declarable object has been constructed by GemFire and the <initalizer> element is parsed in GemFire's configuration meta-data during startup.
protected boolean	isInitialized()	Determines whether this Declarable object has been properly configured and initialized by the Spring container.
protected boolean	isNotInitialized()	Determines whether this Declarable object has been properly configured and initialized by the Spring container.
protected Properties	nullSafeGetParameters()	Null-safe operation to return the parameters passed to this Declarable object when created by GemFire from it's own configuration meta-data (e.g.
final void	onApplicationEvent(ContextRefreshedEvent event)	Event handler method called when GemFire has created and initialized (refreshed) the Spring ApplicationContext using the SpringContextBootstrappingInitializer.
protected void	setParameters(Properties parameters)	Stores a reference to the parameters passed to the Declarable.init(Properties) method.

Methods inherited from class org.springframework.data.gemfire.support.WiringDeclarableSupport

configureThis, configureThis, newBeanConfigurer, newBeanConfigurer

Methods inherited from class org.springframework.data.gemfire.support.DeclarableSupport

close, getBeanFactory, getBeanFactoryKey, locateBeanFactory, locateBeanFactory, setBeanFactoryKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.geode.cache.Declarable

initialize

Constructor Details

LazyWiringDeclarableSupport

public LazyWiringDeclarableSupport()

Constructs a new instance of the LazyWiringDeclarableSupport class registered with the SpringContextBootstrappingInitializer as a Spring ApplicationListener. This Declarable object will receive notifications from the SpringContextBootstrappingInitializer when the Spring context is created and initialized (refreshed). The notification is necessary in order for this Declarable object to be properly configured and initialized with any required, Spring-defined dependencies.

See Also:

• #register(org.springframework.context.ApplicationListener)

Method Details

assertInitialized

protected void assertInitialized()

Asserts that this Declarable object has been properly configured and initialized by the Spring container after has GemFire constructed this Declarable object during startup. This method is recommended to be called before any of this Declarable object's CacheCallback methods (e.g. CacheLoader.load(LoaderHelper) are invoked in order to ensure that this Declarable object was properly constructed, configured and initialized by the Spring container before hand.

Throws:

IllegalStateException - if this Declarable object was not been properly constructed, configured and 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 constructed, configured and initialized by the Spring container. It is possible, though rare, that the init(Properties) method might be called multiple times by GemFire before the Spring container constructs, configures, initializes and generally 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)
• isNotInitialized()

isInitialized

protected boolean isInitialized()

Determines whether this Declarable object has been properly configured and initialized by the Spring container.

Returns:

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

See Also:

• doInit(BeanFactory, Properties)
• assertInitialized()

isNotInitialized

protected boolean isNotInitialized()

Determines whether this Declarable object has been properly configured and initialized by the Spring container.

Returns:

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

See Also:

• doInit(BeanFactory, Properties)
• isInitialized()

init

public final void init(Properties parameters)

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

Specified by:

init in interface Declarable

Overrides:

init in class WiringDeclarableSupport

Parameters:

parameters - Properties containing the configured parameters parsed from GemFire's configuration meta-data (e.g. cache.xml) and passed to this Declarable object.

See Also:

• doInit(BeanFactory, Properties)
• Properties

doPostInit

protected void doPostInit(Properties parameters)

Performs any post configuration and initialization activities required by the application. By default, this method does nothing.

Parameters:

parameters - Properties containing the configured parameters parsed from GemFire's configuration meta-data (e.g. cache.xml) and passed to this Declarable object.

See Also:

• doInit(BeanFactory, Properties)
• Properties

nullSafeGetParameters

protected Properties nullSafeGetParameters()

Null-safe operation to return the parameters passed to this Declarable object when created by GemFire from it's own configuration meta-data (e.g. cache.xml).

Returns:

a Properties containing the configured parameters parsed from GemFire's configuration meta-data (e.g. cache.xml) and passed to this Declarable object.

See Also:

• Properties

setParameters

protected void setParameters(Properties parameters)

Stores a reference to the parameters passed to the Declarable.init(Properties) method.

Parameters:

parameters - Properties containing the configured parameters parsed from GemFire's configuration meta-data (e.g. cache.xml) and passed to this Declarable object.

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.

Specified by:

onApplicationEvent in interface ApplicationListener<ContextRefreshedEvent>

Parameters:

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

See Also:

• ContextRefreshedEvent
• doInit(BeanFactory, Properties)
• nullSafeGetParameters()

destroy

public void destroy()
             throws Exception

When this Declarable object/bean gets destroyed by the Spring container, destroy() will make sure this component gets unregistered from the SpringContextBootstrappingInitializer properly.

Specified by:

destroy in interface DisposableBean

Throws:

Exception - if bean destruction is unsuccessful.

See Also:

• #unregister(org.springframework.context.ApplicationListener)
• setParameters(Properties)