Package org.springframework.data.gemfire.config.annotation

Annotation Interface EnableExpiration.ExpirationPolicy

Enclosing class:

EnableExpiration

public static @interface EnableExpiration.ExpirationPolicy

Definition for a specific Expiration policy that can be applied to 1 or more Regions. An Expiration policy defines the expiration timeout and expiration action to take when an Region entry times out. Additionally, the Expiration policy defines the algorithm to use (e.g. Idle Timeout (TTI) or Time-To-Live (TTL), or both) to determine if and when an Region entry has timed out.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
ExpirationActionType	action	Specifies the action taken when a Region entry expires.
int	timeout	Specifies the timeout used to determine when a Region entry expires.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	regionNames	Names of specific Regions on which this Expiration policy is applied.
EnableExpiration.ExpirationType[]	types	Types of Expiration algorithms (Idle Timeout (TTI) or Time to Live (TTL)) configured and used by Region(s) to expire entries.

Element Details

timeout

int timeout

Specifies the timeout used to determine when a Region entry expires. This value of this attribute determines the "default" timeout used if no specific timeout was specified. A specific timeout is determined by Expiration.timeout(), IdleTimeoutExpiration.timeout() or TimeToLiveExpiration.timeout() attribute on the application domain object. See the SDG Reference Guide for more details...

See Also:

• Annotation-based Data Expiration

action

ExpirationActionType action

Specifies the action taken when a Region entry expires. This value of this attribute determines the "default" action taken if no specific action was specified. The specific action is determined by Expiration.action(), IdleTimeoutExpiration.action() or TimeToLiveExpiration.action() attribute on the application domain object. See the SDG Reference Guide for more details...

See Also:

• Annotation-based Data Expiration

regionNames

String[] regionNames

Names of specific Regions on which this Expiration policy is applied. If no Region names are specified then this Expiration policy will apply to all Regions declared in the Spring context. Defaults to all Regions.

Default:

{}

types

EnableExpiration.ExpirationType[] types

Types of Expiration algorithms (Idle Timeout (TTI) or Time to Live (TTL)) configured and used by Region(s) to expire entries. Defaults to Idle Timeout (TTI).

See Also:

• EnableExpiration.ExpirationType

Default:

{IDLE_TIMEOUT}