org.springframework.data.gemfire.support

Class SpringContextBootstrappingInitializer

java.lang.Object

org.springframework.data.gemfire.support.SpringContextBootstrappingInitializer

All Implemented Interfaces:

Declarable, EventListener, ApplicationListener<ApplicationContextEvent>

public class SpringContextBootstrappingInitializer
extends Object
implements Declarable, ApplicationListener<ApplicationContextEvent>

The SpringContextBootstrappingInitializer class is a GemFire configuration initializer used to bootstrap a Spring ApplicationContext inside a GemFire Server JVM-based process. This enables a GemFire Cache Server resources to be mostly configured with Spring Data GemFire's XML namespace. The Cache itself is the only resource that cannot be configured and initialized in a Spring context since the initializer is not invoked until after GemFire creates and initializes the Cache for use.

Since:

1.4.0

See Also:

ApplicationContext, ApplicationListener, ConfigurableApplicationContext, AnnotationConfigApplicationContext, ClassPathXmlApplicationContext, Declarable, Setting Cache Initializer, SGF-248

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_PACKAGES_PARAMETER
protected static String	CHARS_TO_DELETE
protected static String	COMMA_DELIMITER
static String	CONTEXT_CONFIG_LOCATIONS_PARAMETER

Constructor Summary

Constructors

Constructor and Description
SpringContextBootstrappingInitializer()

Method Summary

Modifier and Type	Method and Description
protected ConfigurableApplicationContext	createApplicationContext(String[] configLocations) Creates (constructs and configures) a ConfigurableApplicationContext instance based on the specified locations of the context configuration meta-data files.
protected ConfigurableApplicationContext	createApplicationContext(String[] basePackages, String[] configLocations) Creates (constructs and configures) an instance of the ConfigurableApplicationContext based on either the specified base packages containing @Configuration, @Component or JSR 330 annotated classes to scan, or the specified locations of context configuration meta-data files.
static ConfigurableApplicationContext	getApplicationContext() Gets a reference to the Spring ApplicationContext constructed, configured and initialized inside the GemFire Server-based JVM process.
void	init(Properties parameters) Initializes a Spring ApplicationContext with the given parameters specified with a GemFire <initializer> block in cache.xml.
protected ConfigurableApplicationContext	initApplicationContext(ConfigurableApplicationContext applicationContext) Initializes the given ApplicationContext by registering this SpringContextBootstrappingInitializer as an ApplicationListener and registering a Runtime shutdown hook.
protected static void	notifyOnExistingContextRefreshedEvent(ApplicationListener<ContextRefreshedEvent> listener) Notifies any Spring ApplicationListeners of a current and existing ContextRefreshedEvent if the ApplicationContext had been previously created, initialized and refreshed before any ApplicationListeners interested in ContextRefreshedEvents were registered so that application components (such as the GemFire CacheLoaders extending LazyWiringDeclarableSupport objects) registered late, requiring configuration (auto-wiring), also get notified and wired accordingly.
protected String	nullSafeGetApplicationContextId(ApplicationContext applicationContext) Gets the the ID of the Spring ApplicationContext in a null-safe manner.
void	onApplicationEvent(ApplicationContextEvent event) Gets notified when the Spring ApplicationContext gets created and refreshed by GemFire, once the <initializer> block is processed and the SpringContextBootstrappingInitializer Declarable component is initialized.
protected ConfigurableApplicationContext	refreshApplicationContext(ConfigurableApplicationContext applicationContext) Refreshes the given ApplicationContext making the context active.
static <T extends ApplicationListener<ContextRefreshedEvent>> T	register(T listener) Registers a Spring ApplicationListener to be notified when the Spring ApplicationContext is created by GemFire when instantiating and initializing Declarables declared inside the <initializer> block inside GemFire's cache.xml file.
static <T extends ApplicationListener<ContextRefreshedEvent>> T	unregister(T listener) Un-registers the Spring ApplicationListener from this SpringContextBootstrappingInitializer in order to stop receiving ApplicationEvents on Spring context refreshes.

Methods inherited from class java.lang.Object

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

Field Detail

BASE_PACKAGES_PARAMETER

public static final String BASE_PACKAGES_PARAMETER

See Also:

Constant Field Values

CONTEXT_CONFIG_LOCATIONS_PARAMETER

public static final String CONTEXT_CONFIG_LOCATIONS_PARAMETER

See Also:

Constant Field Values

CHARS_TO_DELETE

protected static final String CHARS_TO_DELETE

See Also:

Constant Field Values

COMMA_DELIMITER

protected static final String COMMA_DELIMITER

See Also:

Constant Field Values

Constructor Detail

SpringContextBootstrappingInitializer

public SpringContextBootstrappingInitializer()

Method Detail

getApplicationContext

public static ConfigurableApplicationContext getApplicationContext()

Gets a reference to the Spring ApplicationContext constructed, configured and initialized inside the GemFire Server-based JVM process.

Returns:

a reference to the Spring ApplicationContext bootstrapped by GemFire.

See Also:

ConfigurableApplicationContext

notifyOnExistingContextRefreshedEvent

protected static void notifyOnExistingContextRefreshedEvent(ApplicationListener<ContextRefreshedEvent> listener)

Notifies any Spring ApplicationListeners of a current and existing ContextRefreshedEvent if the ApplicationContext had been previously created, initialized and refreshed before any ApplicationListeners interested in ContextRefreshedEvents were registered so that application components (such as the GemFire CacheLoaders extending LazyWiringDeclarableSupport objects) registered late, requiring configuration (auto-wiring), also get notified and wired accordingly.

Parameters:

listener - a Spring ApplicationListener requiring notification of any ContextRefreshedEvents after the ApplicationContext has already been created, initialized and/or refreshed.

See Also:

ApplicationListener.onApplicationEvent(org.springframework.context.ApplicationEvent), ContextRefreshedEvent

register

public static <T extends ApplicationListener<ContextRefreshedEvent>> T register(T listener)

Registers a Spring ApplicationListener to be notified when the Spring ApplicationContext is created by GemFire when instantiating and initializing Declarables declared inside the <initializer> block inside GemFire's cache.xml file.

Type Parameters:

T - the Class type of the Spring ApplicationListener.

Parameters:

listener - the ApplicationListener to register for ContextRefreshedEvents multi-casted by this SpringContextBootstrappingInitializer.

Returns:

the reference to the ApplicationListener for method call chaining purposes.

See Also:

notifyOnExistingContextRefreshedEvent(org.springframework.context.ApplicationListener), unregister(org.springframework.context.ApplicationListener), ApplicationListener, ContextRefreshedEvent, #addApplicationListener(org.springframework.context.ApplicationListener)

unregister

public static <T extends ApplicationListener<ContextRefreshedEvent>> T unregister(T listener)

Un-registers the Spring ApplicationListener from this SpringContextBootstrappingInitializer in order to stop receiving ApplicationEvents on Spring context refreshes.

Type Parameters:

T - the Class type of the Spring ApplicationListener.

Parameters:

listener - the ApplicationListener to unregister from receiving ContextRefreshedEvents by this SpringContextBootstrappingInitializer.

Returns:

the reference to the ApplicationListener for method call chaining purposes.

See Also:

register(org.springframework.context.ApplicationListener), ApplicationListener, ContextRefreshedEvent, #removeApplicationListener(org.springframework.context.ApplicationListener)

createApplicationContext

protected ConfigurableApplicationContext createApplicationContext(String[] configLocations)

Creates (constructs and configures) a ConfigurableApplicationContext instance based on the specified locations of the context configuration meta-data files. The created ConfigurableApplicationContext is not automatically "refreshed" and therefore must be "refreshed" by the caller manually.

Parameters:

configLocations - a String array indicating the locations of the context configuration meta-data files used to configure the ConfigurableApplicationContext instance.

Returns:

a newly constructed and configured instance of the ConfigurableApplicationContext class. Note, the "refresh" method must be called manually before using the context.

Throws:

IllegalArgumentException - if the configLocations parameter argument is null or empty.

See Also:

createApplicationContext(String[], String[]), ConfigurableApplicationContext

createApplicationContext

protected ConfigurableApplicationContext createApplicationContext(String[] basePackages,
                                                                  String[] configLocations)

Creates (constructs and configures) an instance of the ConfigurableApplicationContext based on either the specified base packages containing @Configuration, @Component or JSR 330 annotated classes to scan, or the specified locations of context configuration meta-data files. The created ConfigurableApplicationContext is not automatically "refreshed" and therefore must be "refreshed" by the caller manually. When basePackages are specified, an instance of AnnotationConfigApplicationContext is constructed and a scan is performed; otherwise an instance of the ClassPathXmlApplicationContext is initialized with the configLocations. This method prefers the ClassPathXmlApplicationContext to the AnnotationConfigApplicationContext when both basePackages and configLocations are specified.

Parameters:

basePackages - the base packages to scan for application @Components and @Configuration classes.

configLocations - a String array indicating the locations of the context configuration meta-data files used to configure the ClassPathXmlApplicationContext instance.

Returns:

an instance of ConfigurableApplicationContext configured and initialized with either configLocations or the basePackages when configLocations is unspecified. Note, the "refresh" method must be called manually before using the context.

Throws:

IllegalArgumentException - if both the basePackages and configLocation parameter arguments are null or empty.

See Also:

createApplicationContext(String[]), AnnotationConfigApplicationContext, AnnotationConfigApplicationContext.scan(String...), ClassPathXmlApplicationContext

initApplicationContext

protected ConfigurableApplicationContext initApplicationContext(ConfigurableApplicationContext applicationContext)

Initializes the given ApplicationContext by registering this SpringContextBootstrappingInitializer as an ApplicationListener and registering a Runtime shutdown hook.

Parameters:

applicationContext - the ConfigurableApplicationContext to initialize.

Returns:

the initialized ApplicationContext.

Throws:

IllegalArgumentException - if the ApplicationContext reference is null!

See Also:

ConfigurableApplicationContext, ConfigurableApplicationContext.addApplicationListener(org.springframework.context.ApplicationListener), ConfigurableApplicationContext.registerShutdownHook()

refreshApplicationContext

protected ConfigurableApplicationContext refreshApplicationContext(ConfigurableApplicationContext applicationContext)

Refreshes the given ApplicationContext making the context active.

Parameters:

applicationContext - the ConfigurableApplicationContext to refresh.

Returns:

the refreshed ApplicationContext.

Throws:

IllegalArgumentException - if the ApplicationContext reference is null!

See Also:

ConfigurableApplicationContext, ConfigurableApplicationContext.refresh()

nullSafeGetApplicationContextId

protected String nullSafeGetApplicationContextId(ApplicationContext applicationContext)

Gets the the ID of the Spring ApplicationContext in a null-safe manner.

Parameters:

applicationContext - the Spring ApplicationContext to retrieve the ID for.

Returns:

the ID of the given Spring ApplicationContext or null if the ApplicationContext reference is null.

See Also:

ApplicationContext.getId()

init

public void init(Properties parameters)

Initializes a Spring ApplicationContext with the given parameters specified with a GemFire <initializer> block in cache.xml.

Specified by:

init in interface Declarable

Parameters:

parameters - a Properties object containing the configuration parameters and settings defined in the GemFire cache.xml <initializer> block for the declared SpringContextBootstrappingInitializer GemFire Declarable object.

See Also:

createApplicationContext(String[], String[]), initApplicationContext(org.springframework.context.ConfigurableApplicationContext), refreshApplicationContext(org.springframework.context.ConfigurableApplicationContext), Properties

onApplicationEvent

public void onApplicationEvent(ApplicationContextEvent event)

Gets notified when the Spring ApplicationContext gets created and refreshed by GemFire, once the <initializer> block is processed and the SpringContextBootstrappingInitializer Declarable component is initialized. This handler method proceeds in notifying any other GemFire components that need to be aware that the Spring ApplicationContext now exists and is ready for use, such as other Declarable GemFire objects requiring auto-wiring support, etc. In addition, this method handles the ContextClosedEvent by removing the ApplicationContext reference.

Specified by:

onApplicationEvent in interface ApplicationListener<ApplicationContextEvent>

Parameters:

event - the ApplicationContextEvent signaling that the Spring ApplicationContext has been created and refreshed by GemFire, or closed when the JVM process exits.

See Also:

ContextClosedEvent, ContextRefreshedEvent, #multicastEvent(org.springframework.context.ApplicationEvent)