org.springframework.data.gemfire.config.annotation

Class ExpirationConfiguration.ExpirationPolicyMetaData

java.lang.Object

org.springframework.data.gemfire.config.annotation.ExpirationConfiguration.ExpirationPolicyMetaData

All Implemented Interfaces:

ExpirationConfiguration.ExpirationPolicyConfigurer

Enclosing class:

ExpirationConfiguration

protected static class ExpirationConfiguration.ExpirationPolicyMetaData
extends Object
implements ExpirationConfiguration.ExpirationPolicyConfigurer

ExpirationConfiguration.ExpirationPolicyMetaData is a ExpirationConfiguration.ExpirationPolicyConfigurer implementation that encapsulates the expiration configuration meta-data (e.g. expiration timeout and action) necessary to configure a Regions's expiration policy and behavior. This class is meant to capture the expiration configuration meta-data specified in the EnableExpiration.ExpirationPolicy nested annotation in the application-level EnableExpiration annotation.

See Also:

ExpirationConfiguration.ExpirationPolicyConfigurer

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExpirationPolicyMetaData(org.apache.geode.cache.ExpirationAttributes expirationAttributes, Set<String> regionNames, Set<EnableExpiration.ExpirationType> types) Constructs an instance of ExpirationConfiguration.ExpirationPolicyMetaData initialized with the given expiration policy configuraiton meta-data and Region expiration settings.
protected	ExpirationPolicyMetaData(int timeout, ExpirationActionType action, Set<String> regionNames, Set<EnableExpiration.ExpirationType> types) Constructs an instance of ExpirationConfiguration.ExpirationPolicyMetaData initialized with the given expiration policy configuraiton meta-data and Region expiration settings.

Method Summary

Modifier and Type	Method and Description
protected boolean	accepts(Object regionBean) Determines whether the given Object (e.g.
protected boolean	accepts(org.apache.geode.cache.Region<?,?> region) Determines whether the given Region is accepted for Eviction policy configuration.
protected boolean	accepts(Supplier<String> regionName) Determines whether to apply this expiration policy to the given Region identified by name.
Object	configure(Object regionBean) Configures the expiration policy for the given Region.
org.apache.geode.cache.Region<?,?>	configure(org.apache.geode.cache.Region<?,?> region) Configures the expiration policy for the given Region.
protected org.apache.geode.cache.ExpirationAttributes	defaultExpirationAttributes() Returns the default ExpirationAttributes.
protected static ExpirationConfiguration.ExpirationPolicyMetaData	from(AnnotationAttributes expirationPolicyAttributes) Factory method to construct an instance of ExpirationConfiguration.ExpirationPolicyMetaData initialized with the given AnnotationAttributes from the nested EnableExpiration.ExpirationPolicy annotation specified in an application-level EnableExpiration annotation.
protected static ExpirationConfiguration.ExpirationPolicyMetaData	from(EnableExpiration.ExpirationPolicy expirationPolicy) Factory method to construct an instance of ExpirationConfiguration.ExpirationPolicyMetaData initialized with the given attribute values from the nested EnableExpiration.ExpirationPolicy annotation specified in an application-level EnableExpiration annotation.
protected static ExpirationConfiguration.ExpirationPolicyMetaData	fromDefaults() Factory method to construct an instance of ExpirationConfiguration.ExpirationPolicyMetaData using default expiration policy settings.
protected boolean	isIdleTimeout() Determines whether Idle Timeout Expiration (TTI) was configured for this expiration policy.
protected boolean	isTimeToLive() Determines whether Time-To-Live Expiration (TTL) was configured for this expiration policy.
protected static org.apache.geode.cache.ExpirationAttributes	newExpirationAttributes(int timeout, org.apache.geode.cache.ExpirationAction action) Factory method used to construct a new instance of the ExpirationAttributes initialized with the given expiration timeout and action that is taken when an Region entry times out.
protected static org.apache.geode.cache.ExpirationAttributes	newExpirationAttributes(int timeout, ExpirationActionType action) Factory method used to construct a new instance of the ExpirationAttributes initialized with the given expiration timeout and action that is taken when an Region entry times out.
protected static ExpirationConfiguration.ExpirationPolicyMetaData	newExpirationPolicyMetaData(int timeout, ExpirationActionType action, String[] regionNames, EnableExpiration.ExpirationType[] types) Factory method used to construct an instance of ExpirationConfiguration.ExpirationPolicyMetaData initialized with the given expiration policy meta-data.
protected static ExpirationActionType	resolveAction(ExpirationActionType action) Resolves the ExpirationAction used in the expiration policy.
protected String	resolveRegionName(Object regionFactoryBean) Resolves the name of a given Region from the corresponding ResolvableRegionFactoryBean object.
protected static int	resolveTimeout(int timeout) Resolves the expiration timeout used in the expiration policy.
protected ExpiringRegionFactoryBean<?,?>	setExpirationAttributes(ExpiringRegionFactoryBean<?,?> regionFactoryBean) Configures the Expiration policies on the targeted ExpiringRegionFactoryBean, which may be either a PeerRegionFactoryBean or ClientRegionFactoryBean.

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

ExpirationPolicyMetaData

protected ExpirationPolicyMetaData(int timeout,
                                   ExpirationActionType action,
                                   Set<String> regionNames,
                                   Set<EnableExpiration.ExpirationType> types)

Constructs an instance of ExpirationConfiguration.ExpirationPolicyMetaData initialized with the given expiration policy configuraiton meta-data and Region expiration settings.

Parameters:

timeout - int value indicating the expiration timeout in seconds.

action - expiration action taken when the Region entry expires.

regionNames - names of Regions configured with the expiration policy meta-data.

types - type of expiration algorithm/behavior (TTI/TTL) configured for the Region.

Throws:

IllegalArgumentException - if the EnableExpiration.ExpirationType Set is empty.

See Also:

EnableExpiration.ExpirationType, ExpirationActionType, ExpirationPolicyMetaData(ExpirationAttributes, Set, Set), newExpirationAttributes(int, ExpirationActionType), resolveAction(ExpirationActionType), resolveTimeout(int)

ExpirationPolicyMetaData

protected ExpirationPolicyMetaData(org.apache.geode.cache.ExpirationAttributes expirationAttributes,
                                   Set<String> regionNames,
                                   Set<EnableExpiration.ExpirationType> types)

Constructs an instance of ExpirationConfiguration.ExpirationPolicyMetaData initialized with the given expiration policy configuraiton meta-data and Region expiration settings.

Parameters:

expirationAttributes - ExpirationAttributes specifying the expiration timeout in seconds and expiration action taken when the Region entry expires.

regionNames - names of Regions configured with the expiration policy meta-data.

types - type of expiration algorithm/behaviors (TTI/TTL) configured for the Region.

Throws:

IllegalArgumentException - if the EnableExpiration.ExpirationType Set is empty.

See Also:

EnableExpiration.ExpirationType, ExpirationAttributes

Method Detail

from

protected static ExpirationConfiguration.ExpirationPolicyMetaData from(AnnotationAttributes expirationPolicyAttributes)

Factory method to construct an instance of ExpirationConfiguration.ExpirationPolicyMetaData initialized with the given AnnotationAttributes from the nested EnableExpiration.ExpirationPolicy annotation specified in an application-level EnableExpiration annotation.

Parameters:

expirationPolicyAttributes - AnnotationAttributes from a EnableExpiration.ExpirationPolicy annotation.

Returns:

an instance of the ExpirationConfiguration.ExpirationPolicyMetaData initialized from EnableExpiration.ExpirationPolicy AnnotationAttributes.

Throws:

IllegalArgumentException - if AnnotationAttributes.annotationType() is not assignable to EnableExpiration.ExpirationPolicy.

See Also:

#newExpirationPolicyMetaData(int, ExpirationActionType, String[], ExpirationType[]), AnnotationAttributes

from

protected static ExpirationConfiguration.ExpirationPolicyMetaData from(EnableExpiration.ExpirationPolicy expirationPolicy)

Factory method to construct an instance of ExpirationConfiguration.ExpirationPolicyMetaData initialized with the given attribute values from the nested EnableExpiration.ExpirationPolicy annotation specified in an application-level EnableExpiration annotation.

Parameters:

expirationPolicy - EnableExpiration.ExpirationPolicy annotation containing the attribute values used to initialize the ExpirationConfiguration.ExpirationPolicyMetaData instance.

Returns:

an instance of the ExpirationConfiguration.ExpirationPolicyMetaData initialized from EnableExpiration.ExpirationPolicy attributes values.

See Also:

EnableExpiration.ExpirationPolicy, #newExpirationPolicyMetaData(int, ExpirationActionType, String[], ExpirationType[])

fromDefaults

protected static ExpirationConfiguration.ExpirationPolicyMetaData fromDefaults()

Factory method to construct an instance of ExpirationConfiguration.ExpirationPolicyMetaData using default expiration policy settings.

See Also:

#newExpirationPolicyMetaData(int, ExpirationActionType, String[], ExpirationType[])

newExpirationAttributes

protected static org.apache.geode.cache.ExpirationAttributes newExpirationAttributes(int timeout,
                                                                                     ExpirationActionType action)

Factory method used to construct a new instance of the ExpirationAttributes initialized with the given expiration timeout and action that is taken when an Region entry times out.

Parameters:

timeout - int value indicating the expiration timeout in seconds.

action - expiration action to take when the Region entry times out.

Returns:

a new instance of ExpirationAttributes initialized with the given expiration timeout and action.

See Also:

ExpirationAttributes, newExpirationAttributes(int, ExpirationAction)

newExpirationAttributes

protected static org.apache.geode.cache.ExpirationAttributes newExpirationAttributes(int timeout,
                                                                                     org.apache.geode.cache.ExpirationAction action)

Factory method used to construct a new instance of the ExpirationAttributes initialized with the given expiration timeout and action that is taken when an Region entry times out.

Parameters:

timeout - int value indicating the expiration timeout in seconds.

action - expiration action to take when the Region entry times out.

Returns:

a new instance of ExpirationAttributes initialized with the given expiration timeout and action.

See Also:

ExpirationAttributes

newExpirationPolicyMetaData

protected static ExpirationConfiguration.ExpirationPolicyMetaData newExpirationPolicyMetaData(int timeout,
                                                                                              ExpirationActionType action,
                                                                                              String[] regionNames,
                                                                                              EnableExpiration.ExpirationType[] types)

Factory method used to construct an instance of ExpirationConfiguration.ExpirationPolicyMetaData initialized with the given expiration policy meta-data.

Parameters:

timeout - int value indicating the expiration timeout in seconds.

action - expiration action taken when the Region entry expires.

regionNames - names of Regions configured with the expiration policy meta-data.

types - type of expiration algorithm/behavior (TTI/TTL) configured for the Region.

Returns:

an instance of ExpirationConfiguration.ExpirationPolicyMetaData initialized with the given expiration policy meta-data.

Throws:

IllegalArgumentException - if the EnableExpiration.ExpirationType array is empty.

See Also:

EnableExpiration.ExpirationType, ExpirationActionType, ExpirationPolicyMetaData(ExpirationAttributes, Set, Set), newExpirationAttributes(int, ExpirationActionType)

resolveAction

protected static ExpirationActionType resolveAction(ExpirationActionType action)

Resolves the ExpirationAction used in the expiration policy. Defaults to ExpirationActionType.INVALIDATE if action is null.

Parameters:

action - given ExpirationActionType to evaluate.

Returns:

the resolved ExpirationActionType or the default if action is null.

See Also:

ExpirationActionType

resolveTimeout

protected static int resolveTimeout(int timeout)

Resolves the expiration timeout used in the expiration policy. Defaults to 0 if timeout is less than 0.

Parameters:

timeout - int value expressing the expiration timeout in seconds.

Returns:

the resolved expiration policy timeout.

accepts

protected boolean accepts(Object regionBean)

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

Parameters:

regionBean - 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:

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

accepts

protected boolean accepts(org.apache.geode.cache.Region<?,?> region)

Determines whether the given Region is accepted for Eviction policy configuration.

Parameters:

region - Region being evaluated as a Eviction policy configuration candidate.

Returns:

a boolean value indicated whether the given Region is accepted as an Expiration policy configuration candidate.

See Also:

Region, accepts(Supplier)

accepts

protected boolean accepts(Supplier<String> regionName)

Determines whether to apply this expiration policy to the given Region identified by name.

Parameters:

regionName - name of the Region to evaluate.

Returns:

a boolean value indicating whether the expiration policy applies to the given Region identified by name.

isIdleTimeout

protected boolean isIdleTimeout()

Determines whether Idle Timeout Expiration (TTI) was configured for this expiration policy.

Returns:

a boolean value indicating whether Idle Timeout Expiration (TTI) was configuration for this expiration policy.

isTimeToLive

protected boolean isTimeToLive()

Determines whether Time-To-Live Expiration (TTL) was configured for this expiration policy.

Returns:

a boolean value indicating whether Time-To-Live Expiration (TTL) was configuration for this expiration policy.

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()

setExpirationAttributes

protected ExpiringRegionFactoryBean<?,?> setExpirationAttributes(ExpiringRegionFactoryBean<?,?> regionFactoryBean)

Configures the Expiration policies on the targeted ExpiringRegionFactoryBean, which may be either a PeerRegionFactoryBean or ClientRegionFactoryBean.

Parameters:

regionFactoryBean - ExpiringRegionFactoryBean to configure.

Returns:

the given ExpiringRegionFactoryBean.

See Also:

AnnotationBasedExpiration.forIdleTimeout(ExpirationAttributes), AnnotationBasedExpiration.forTimeToLive(ExpirationAttributes), ExpiringRegionFactoryBean, defaultExpirationAttributes()

configure

public Object configure(Object regionBean)

Description copied from interface: ExpirationConfiguration.ExpirationPolicyConfigurer

Configures the expiration policy for the given Region.

Specified by:

configure in interface ExpirationConfiguration.ExpirationPolicyConfigurer

Parameters:

regionBean - Region object who's expiration policy will be configured.

Returns:

the given Region object.

See Also:

Region

configure

public org.apache.geode.cache.Region<?,?> configure(org.apache.geode.cache.Region<?,?> region)

Description copied from interface: ExpirationConfiguration.ExpirationPolicyConfigurer

Configures the expiration policy for the given Region.

Specified by:

configure in interface ExpirationConfiguration.ExpirationPolicyConfigurer

Parameters:

region - Region who's expiration policy will be configured.

Returns:

the given Region.

See Also:

Region

defaultExpirationAttributes

protected org.apache.geode.cache.ExpirationAttributes defaultExpirationAttributes()

Returns the default ExpirationAttributes.

Returns:

an ExpirationAttributes containing the defaults.

See Also:

ExpirationAttributes