Package org.springframework.data.gemfire.support

Class WiringDeclarableSupport

java.lang.Object

org.springframework.data.gemfire.support.DeclarableSupport

org.springframework.data.gemfire.support.WiringDeclarableSupport

All Implemented Interfaces:

CacheCallback, Declarable

Direct Known Subclasses:

AbstractAuthInitialize, LazyWiringDeclarableSupport

public abstract class WiringDeclarableSupport
extends DeclarableSupport

Declarable support class used to wire declaring, implementing instances through the Spring container. This implementation first looks for a 'bean-name' property, which will be used to locate a Spring bean definition used as the 'template' for auto-wiring purposes. Auto-wiring will be performed based on the settings defined in the Spring container.

Author:

Costin Leau, John Blum

See Also:

• BeanFactory
• BeanConfigurerSupport
• BeanWiringInfo
• DeclarableSupport
• LazyWiringDeclarableSupport
• Declarable

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	TEMPLATE_BEAN_NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
WiringDeclarableSupport()

Method Summary

Modifier and Type	Method	Description
protected boolean	configureThis(String templateBeanName)	Configures this Declarable object using a Spring bean defined and identified in the Spring BeanFactory with the given name used as a template for the auto-wiring function.
protected boolean	configureThis(BeanFactory beanFactory, String templateBeanName)	Configures this Declarable object using a Spring bean defined and identified in the given Spring BeanFactory with the given name used as a template for the auto-wiring function.
void	initialize(Cache cache, Properties parameters)
protected BeanConfigurerSupport	newBeanConfigurer(BeanFactory beanFactory)	Constructs a new instance of BeanConfigurerSupport configured with the given Spring BeanFactory.
protected BeanConfigurerSupport	newBeanConfigurer(BeanFactory beanFactory, String templateBeanName)	Constructs a new instance of BeanConfigurerSupport configured with the given Spring BeanFactory and name of a Spring bean defined in the Spring BeanFactory used as a template to auto-wire this Declarable object.

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

init

Field Details

TEMPLATE_BEAN_NAME_PROPERTY

protected static final String TEMPLATE_BEAN_NAME_PROPERTY

See Also:

• Constant Field Values

Constructor Details

WiringDeclarableSupport

public WiringDeclarableSupport()

Method Details

initialize

public void initialize(@Nullable
 Cache cache,
 @NonNull
 Properties parameters)

configureThis

protected boolean configureThis(@Nullable
 String templateBeanName)

Configures this Declarable object using a Spring bean defined and identified in the Spring BeanFactory with the given name used as a template for the auto-wiring function.

Parameters:

templateBeanName - String containing the name of the Spring bean used as a template for the auto-wiring function.

Returns:

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

See Also:

• BeanConfigurerSupport
• configureThis(BeanFactory, String)
• DeclarableSupport.locateBeanFactory()

configureThis

protected boolean configureThis(@NonNull
 BeanFactory beanFactory,
 @Nullable
 String templateBeanName)

Configures this Declarable object using a Spring bean defined and identified in the given Spring BeanFactory with the given name used as a template for the auto-wiring function.

Parameters:

beanFactory - Spring BeanFactory used to auto-wire, configure and initialize this Declarable object; must not be null

templateBeanName - String containing the name of the Spring bean used as a template for the auto-wiring function.

Returns:

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

See Also:

• BeanConfigurerSupport
• newBeanConfigurer(BeanFactory, String)

newBeanConfigurer

@NonNull
protected BeanConfigurerSupport newBeanConfigurer(@NonNull
 BeanFactory beanFactory)

Constructs a new instance of BeanConfigurerSupport configured with the given Spring BeanFactory.

Parameters:

beanFactory - reference to the Spring BeanFactory; must not be null.

Returns:

a new BeanConfigurerSupport configured with the given Spring BeanFactory.

See Also:

• BeanConfigurerSupport
• BeanFactory
• newBeanConfigurer(BeanFactory, String)

newBeanConfigurer

@NonNull
protected BeanConfigurerSupport newBeanConfigurer(@NonNull
 BeanFactory beanFactory,
 @Nullable
 String templateBeanName)

Constructs a new instance of BeanConfigurerSupport configured with the given Spring BeanFactory and name of a Spring bean defined in the Spring BeanFactory used as a template to auto-wire this Declarable object.

Parameters:

beanFactory - reference to the Spring BeanFactory; must not be null.

templateBeanName - String containing the name of a Spring bean declared in the Spring BeanFactory used as a template to auto-wire this Declarable object.

Returns:

a new BeanConfigurerSupport configured with the given Spring BeanFactory.

See Also:

• BeanConfigurerSupport
• BeanFactory