org.springframework.data.gemfire.support

Class DeclarableSupport

java.lang.Object

org.springframework.data.gemfire.support.DeclarableSupport

All Implemented Interfaces:

org.apache.geode.cache.CacheCallback, org.apache.geode.cache.Declarable

Direct Known Subclasses:

WiringDeclarableSupport

public abstract class DeclarableSupport
extends Object
implements org.apache.geode.cache.CacheCallback, org.apache.geode.cache.Declarable

Convenience class for Spring-aware GemFire Declarable components. Provides subclasses with a reference to the current Spring BeanFactory in orde to perform Spring bean lookups or resource loading. Note, in most cases, the developer should just declare the same components as Spring beans in the Spring container, through RegionFactoryBean, which gives access to the full Spring container capabilities and does not enforce the Declarable interface to be implemented.

Author:

Costin Leau, John Blum

See Also:

BeanFactory, GemfireBeanFactoryLocator, CacheCallback, Declarable

Constructor Summary

Constructors

Constructor and Description
DeclarableSupport()

Method Summary

Modifier and Type	Method and Description
void	close()
protected BeanFactory	getBeanFactory() Returns a reference to the Spring BeanFactory.
protected String	getBeanFactoryKey() Returns the key used to lookup the Spring BeanFactory.
protected BeanFactory	locateBeanFactory() Returns a reference to the Spring BeanFactory.
protected BeanFactory	locateBeanFactory(String beanFactoryKey) Returns a reference to the Spring BeanFactory for the given beanFactoryKey.
void	setBeanFactoryKey(String beanFactoryKey) Set the key used to lookup the Spring BeanFactory.

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

init

Constructor Detail

DeclarableSupport

public DeclarableSupport()

Method Detail

getBeanFactory

protected BeanFactory getBeanFactory()

Returns a reference to the Spring BeanFactory.

Returns:

a reference to the Spring BeanFactory.

See Also:

GemfireBeanFactoryLocator.useBeanFactory(String), BeanFactory, locateBeanFactory()

setBeanFactoryKey

public void setBeanFactoryKey(String beanFactoryKey)

Set the key used to lookup the Spring BeanFactory.

Parameters:

beanFactoryKey - String containing the key used to lookup the Spring BeanFactory.

getBeanFactoryKey

protected String getBeanFactoryKey()

Returns the key used to lookup the Spring BeanFactory.

Returns:

a String containing the key used to lookup the Spring BeanFactory.

locateBeanFactory

protected BeanFactory locateBeanFactory()

Returns a reference to the Spring BeanFactory.

Returns:

a reference to the Spring BeanFactory.

See Also:

BeanFactory, locateBeanFactory(String), getBeanFactoryKey()

locateBeanFactory

protected BeanFactory locateBeanFactory(String beanFactoryKey)

Returns a reference to the Spring BeanFactory for the given beanFactoryKey.

Parameters:

beanFactoryKey - String containing the key used to lookup the Spring BeanFactory.

Returns:

a reference to the Spring BeanFactory for the given beanFactoryKey.

See Also:

GemfireBeanFactoryLocator.useBeanFactory(String), BeanFactory

close

public void close()

Specified by:

close in interface org.apache.geode.cache.CacheCallback