org.springframework.data.gemfire.config.annotation

Class EvictionConfiguration.EvictionPolicyMetaData

java.lang.Object

org.springframework.data.gemfire.config.annotation.EvictionConfiguration.EvictionPolicyMetaData

All Implemented Interfaces:

EvictionConfiguration.EvictionPolicyConfigurer

Enclosing class:

EvictionConfiguration

protected static class EvictionConfiguration.EvictionPolicyMetaData
extends Object
implements EvictionConfiguration.EvictionPolicyConfigurer

Field Summary

Fields

Modifier and Type	Field and Description
protected static String[]	ALL_REGIONS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EvictionPolicyMetaData(org.apache.geode.cache.EvictionAttributes evictionAttributes) Constructs an instance of EvictionConfiguration.EvictionPolicyMetaData initialized with the given EvictionAttributes applying to all Regions.
protected	EvictionPolicyMetaData(org.apache.geode.cache.EvictionAttributes evictionAttributes, String[] regionNames) Constructs an instance of EvictionConfiguration.EvictionPolicyMetaData initialized with the given EvictionAttributes to apply to the specific Regions.

Method Summary

Modifier and Type	Method and Description
protected boolean	accepts(Object regionFactoryBean) Determines whether the given Object (e.g.
protected boolean	accepts(Supplier<String> regionName) Determine whether the Region identified by name is accepted for Eviction policy configuration.
Object	configure(Object regionFactoryBean) Configure the Eviction policy on the given SDG PeerRegionFactoryBean or ClientRegionFactoryBean used to create a GemFire Region.
protected static EvictionConfiguration.EvictionPolicyMetaData	from(AnnotationAttributes evictionPolicyAttributes, ApplicationContext applicationContext)
protected static EvictionConfiguration.EvictionPolicyMetaData	from(EnableEviction.EvictionPolicy evictionPolicy, ApplicationContext applicationContext)
protected static EvictionConfiguration.EvictionPolicyMetaData	from(EvictionPolicyType type, int maximum, EvictionActionType action, org.apache.geode.cache.util.ObjectSizer objectSizer, String... regionNames)
protected static EvictionConfiguration.EvictionPolicyMetaData	fromDefaults()
protected org.apache.geode.cache.EvictionAttributes	getEvictionAttributes() Returns an instance of the EvictionAttributes specifying the Eviction policy configuration captured in this Eviction policy meta-data.
protected static org.apache.geode.cache.util.ObjectSizer	resolveObjectSizer(String objectSizerName, ApplicationContext applicationContext)
protected String	resolveRegionName(Object regionFactoryBean) Resolves the name of a given Region from the corresponding ResolvableRegionFactoryBean object.
protected static Integer	resolveThreshold(int maximum, EvictionPolicyType type) Resolves the Eviction policy threshold (a.k.a. maximum) based on the EvictionPolicyType.
protected EvictingRegionFactoryBean	setEvictionAttributes(EvictingRegionFactoryBean regionFactoryBean) Sets the EvictionAttributes on the PeerRegionFactoryBean or ClientRegionFactoryBean used to create the targeted Region.

Methods inherited from class java.lang.Object

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

Field Detail

ALL_REGIONS

protected static final String[] ALL_REGIONS

Constructor Detail

EvictionPolicyMetaData

protected EvictionPolicyMetaData(org.apache.geode.cache.EvictionAttributes evictionAttributes)

Constructs an instance of EvictionConfiguration.EvictionPolicyMetaData initialized with the given EvictionAttributes applying to all Regions.

Parameters:

evictionAttributes - EvictionAttributes specifying the Eviction policy configuration for a Region.

See Also:

EvictionAttributes, EvictionPolicyMetaData(EvictionAttributes, String[])

EvictionPolicyMetaData

protected EvictionPolicyMetaData(org.apache.geode.cache.EvictionAttributes evictionAttributes,
                                 String[] regionNames)

Constructs an instance of EvictionConfiguration.EvictionPolicyMetaData initialized with the given EvictionAttributes to apply to the specific Regions.

Parameters:

evictionAttributes - EvictionAttributes specifying the Eviction policy configuration for a Region.

regionNames - names of Regions on which the Eviction policy is applied.

See Also:

EvictionAttributes

Method Detail

from

protected static EvictionConfiguration.EvictionPolicyMetaData from(@NonNull
                                                                   AnnotationAttributes evictionPolicyAttributes,
                                                                   @NonNull
                                                                   ApplicationContext applicationContext)

from

protected static EvictionConfiguration.EvictionPolicyMetaData from(EnableEviction.EvictionPolicy evictionPolicy,
                                                                   ApplicationContext applicationContext)

from

protected static EvictionConfiguration.EvictionPolicyMetaData from(EvictionPolicyType type,
                                                                   int maximum,
                                                                   EvictionActionType action,
                                                                   org.apache.geode.cache.util.ObjectSizer objectSizer,
                                                                   String... regionNames)

fromDefaults

protected static EvictionConfiguration.EvictionPolicyMetaData fromDefaults()

resolveObjectSizer

protected static org.apache.geode.cache.util.ObjectSizer resolveObjectSizer(String objectSizerName,
                                                                            ApplicationContext applicationContext)

resolveThreshold

protected static Integer resolveThreshold(int maximum,
                                          EvictionPolicyType type)

Resolves the Eviction policy threshold (a.k.a. maximum) based on the EvictionPolicyType. For instance EvictionPolicyType.HEAP_PERCENTAGE does not support maximum/threshold since the settings are determined by the Pivotal GemFire/Apache Geode cache critical heap percentage and eviction heap percentage System property settings.

Parameters:

maximum - integer value specifying the configured Eviction threshold.

type - EvictionPolicyType specifying the type of Eviction algorithm.

Returns:

a resolved value for the Eviction maximum/threshold.

See Also:

EvictionPolicyType

getEvictionAttributes

protected org.apache.geode.cache.EvictionAttributes getEvictionAttributes()

Returns an instance of the EvictionAttributes specifying the Eviction policy configuration captured in this Eviction policy meta-data.

Returns:

an instance of the EvictionAttributes specifying the Region Eviction policy configuration.

Throws:

IllegalStateException - if the EvictionAttributes were not properly initialized.

See Also:

EvictionAttributes

accepts

protected boolean accepts(Object regionFactoryBean)

Determines whether the given Object (e.g. Spring bean) is accepted for Eviction policy configuration.

Parameters:

regionFactoryBean - Object being evaluated as an Eviction policy configuration candidate.

Returns:

a boolean value indicating whether the Object is accepted for Eviction policy configuration.

See Also:

EvictionConfiguration.isRegionFactoryBean(Object), resolveRegionName(Object), accepts(Supplier)

accepts

protected boolean accepts(Supplier<String> regionName)

Determine whether the Region identified by name is accepted for Eviction policy configuration.

Parameters:

regionName - name of the Region targeted for Eviction policy configuration.

Returns:

a boolean value if the named Region is accepted for Eviction policy configuration.

resolveRegionName

protected String resolveRegionName(Object regionFactoryBean)

Resolves the name of a given Region from the corresponding ResolvableRegionFactoryBean object.

Parameters:

regionFactoryBean - ResolvableRegionFactoryBean from which to resolve the Region name.

Returns:

the resolved name of the Region created from the given ResolvableRegionFactoryBean.

See Also:

ResolvableRegionFactoryBean.resolveRegionName()

setEvictionAttributes

protected EvictingRegionFactoryBean setEvictionAttributes(EvictingRegionFactoryBean regionFactoryBean)

Sets the EvictionAttributes on the PeerRegionFactoryBean or ClientRegionFactoryBean used to create the targeted Region.

Parameters:

regionFactoryBean - PeerRegionFactoryBean or ClientRegionFactoryBean on which to set the EvictionAttributes encapsulating the Eviction policy for the targeted Region.

Returns:

the regionFactoryBean.

See Also:

EvictingRegionFactoryBean.setEvictionAttributes(EvictionAttributes), EvictionAttributes, getEvictionAttributes()

configure

public Object configure(Object regionFactoryBean)

Description copied from interface: EvictionConfiguration.EvictionPolicyConfigurer

Configure the Eviction policy on the given SDG PeerRegionFactoryBean or ClientRegionFactoryBean used to create a GemFire Region.

Specified by:

configure in interface EvictionConfiguration.EvictionPolicyConfigurer

Parameters:

regionFactoryBean - PeerRegionFactoryBean or ClientRegionFactoryBean used to create a GemFire Region.

Returns:

the given regionFactoryBean.

See Also:

PeerRegionFactoryBean, ClientRegionFactoryBean