org.springframework.data.gemfire.support

Class AnnotationBasedExpiration<K,V>

java.lang.Object

org.springframework.data.gemfire.support.AnnotationBasedExpiration<K,V>

All Implemented Interfaces:

com.gemstone.gemfire.cache.CacheCallback, com.gemstone.gemfire.cache.CustomExpiry<K,V>, Aware, BeanFactoryAware

public class AnnotationBasedExpiration<K,V>
extends Object
implements BeanFactoryAware, com.gemstone.gemfire.cache.CustomExpiry<K,V>

The AnnotationBasedExpiration class is an implementation of GemFire's CustomExpiry interface that determines the Time-To-Live (TTL) or Idle-Timeout (TTI) expiration policy of a Region entry by introspecting the Region entry's class type and reflecting on any Region entries annotated with Spring Data GemFire's Expiration-based Annotations.

Since:

1.7.0

See Also:

Annotation, BeanFactory, BeanFactoryAware, ExpirationActionType, Expiration, IdleTimeoutExpiration, TimeToLiveExpiration, CustomExpiry, ExpirationAction, ExpirationAttributes, Region

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AnnotationBasedExpiration.ExpirationMetaData The ExpirationMetaData class encapsulates the settings constituting the expiration policy including the expiration timeout and the action performed when expiration occurs.

Field Summary

Fields

Modifier and Type	Field and Description
protected static AtomicReference<BeanFactory>	BEAN_FACTORY_REFERENCE
protected static AtomicReference<StandardEvaluationContext>	EVALUATION_CONTEXT_REFERENCE

Constructor Summary

Constructors

Constructor and Description
AnnotationBasedExpiration() Constructs a new instance of the AnnotationBasedExpiration class with no default expiration policy.
AnnotationBasedExpiration(com.gemstone.gemfire.cache.ExpirationAttributes defaultExpirationAttributes) Constructs a new instance of the AnnotationBasedExpiration class initialized with a specific, default expiration policy.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Called when the Region containing this callback is closed or destroyed, when the Cache is closed, or when a callback is removed from a Region using an AttributesMutator.
static <K,V> AnnotationBasedExpiration<K,V>	forIdleTimeout() Constructs an AnnotationBasedExpiration instance with no default ExpirationAttributes to process Idle Timeout (TTI) Expiration annotated Region Entries.
static <K,V> AnnotationBasedExpiration<K,V>	forIdleTimeout(com.gemstone.gemfire.cache.ExpirationAttributes defaultExpirationAttributes) Constructs an AnnotationBasedExpiration instance with default ExpirationAttributes to process Idle Timeout (TTI) Expiration annotated Region Entries.
static <K,V> AnnotationBasedExpiration<K,V>	forTimeToLive() Constructs an AnnotationBasedExpiration instance with no default ExpirationAttributes to process Time-To-Live (TTL) Expiration annotated Region Entries.
static <K,V> AnnotationBasedExpiration<K,V>	forTimeToLive(com.gemstone.gemfire.cache.ExpirationAttributes defaultExpirationAttributes) Constructs an AnnotationBasedExpiration instance with default ExpirationAttributes to process Time-To-Live (TTL) Expiration annotated Region Entries.
protected BeanFactory	getBeanFactory() Gets a reference to the BeanFactory in which this AnnotationBasedExpiration Bean belongs.
protected com.gemstone.gemfire.cache.ExpirationAttributes	getDefaultExpirationAttributes() Gets the expiration policy used by default when no application domain object specific expiration meta-data has been specified.
protected Expiration	getExpiration(com.gemstone.gemfire.cache.Region.Entry<K,V> entry) Gets the Expiration Annotation meta-data from the Region Entry.
protected AnnotationBasedExpiration.ExpirationMetaData	getExpirationMetaData(com.gemstone.gemfire.cache.Region.Entry<K,V> entry) Gets custom expiration (Annotation-based) meta-data for the given Region entry.
com.gemstone.gemfire.cache.ExpirationAttributes	getExpiry(com.gemstone.gemfire.cache.Region.Entry<K,V> entry) Calculate the expiration for a given entry.
protected IdleTimeoutExpiration	getIdleTimeout(com.gemstone.gemfire.cache.Region.Entry<K,V> entry) Gets the IdleTimeoutExpiration Annotation meta-data from the Region Entry.
protected TimeToLiveExpiration	getTimeToLive(com.gemstone.gemfire.cache.Region.Entry<K,V> entry) Gets the TimeToLiveExpiration Annotation meta-data from the Region Entry.
protected void	initEvaluationContext()
protected boolean	isExpirationConfigured(com.gemstone.gemfire.cache.Region.Entry<K,V> entry) Determines whether the Region Entry has been annotated with the Expiration Annotation.
protected boolean	isIdleTimeoutConfigured(com.gemstone.gemfire.cache.Region.Entry<K,V> entry) Determines whether the Region Entry has been annotated with the IdleTimeoutExpiration Annotation.
protected boolean	isTimeToLiveConfigured(com.gemstone.gemfire.cache.Region.Entry<K,V> entry) Determines whether the Region Entry has been annotated with the TimeToLiveExpiration Annotation.
protected com.gemstone.gemfire.cache.ExpirationAttributes	newExpirationAttributes(AnnotationBasedExpiration.ExpirationMetaData expirationMetaData) Constructs a new instance of ExpirationAttributes configured with the application domain object specific expiration policy.
void	setBeanFactory(BeanFactory beanFactory) Sets the BeanFactory managing this AnnotationBasedExpiration bean in the Spring context.
void	setDefaultExpirationAttributes(com.gemstone.gemfire.cache.ExpirationAttributes defaultExpirationAttributes) Sets the expiration policy to use by default when no application domain object specific expiration meta-data has been specified.

Methods inherited from class java.lang.Object

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

Field Detail

BEAN_FACTORY_REFERENCE

protected static final AtomicReference<BeanFactory> BEAN_FACTORY_REFERENCE

EVALUATION_CONTEXT_REFERENCE

protected static final AtomicReference<StandardEvaluationContext> EVALUATION_CONTEXT_REFERENCE

Constructor Detail

AnnotationBasedExpiration

public AnnotationBasedExpiration()

Constructs a new instance of the AnnotationBasedExpiration class with no default expiration policy.

AnnotationBasedExpiration

public AnnotationBasedExpiration(com.gemstone.gemfire.cache.ExpirationAttributes defaultExpirationAttributes)

Constructs a new instance of the AnnotationBasedExpiration class initialized with a specific, default expiration policy.

Parameters:

defaultExpirationAttributes - expiration settings used as the default expiration policy.

See Also:

ExpirationAttributes

Method Detail

forIdleTimeout

public static <K,V> AnnotationBasedExpiration<K,V> forIdleTimeout()

Constructs an AnnotationBasedExpiration instance with no default ExpirationAttributes to process Idle Timeout (TTI) Expiration annotated Region Entries.

Type Parameters:

K - the class type of the Region Entry Key.

V - the class type of the Region Entry Value.

Returns:

an AnnotationBasedExpiration instance to process Idle Timeout Expiration annotated Region Entries.

See Also:

AnnotationBasedExpiration, IdleTimeoutExpiration, forIdleTimeout(com.gemstone.gemfire.cache.ExpirationAttributes)

forIdleTimeout

public static <K,V> AnnotationBasedExpiration<K,V> forIdleTimeout(com.gemstone.gemfire.cache.ExpirationAttributes defaultExpirationAttributes)

Constructs an AnnotationBasedExpiration instance with default ExpirationAttributes to process Idle Timeout (TTI) Expiration annotated Region Entries.

Type Parameters:

K - the class type of the Region Entry Key.

V - the class type of the Region Entry Value.

Parameters:

defaultExpirationAttributes - ExpirationAttributes used by default if no Expiration policy was specified on the Region Entry.

Returns:

an AnnotationBasedExpiration instance to process Idle Timeout Expiration annotated Region Entries.

See Also:

AnnotationBasedExpiration, IdleTimeoutExpiration

forTimeToLive

public static <K,V> AnnotationBasedExpiration<K,V> forTimeToLive()

Constructs an AnnotationBasedExpiration instance with no default ExpirationAttributes to process Time-To-Live (TTL) Expiration annotated Region Entries.

Type Parameters:

K - the class type of the Region Entry Key.

V - the class type of the Region Entry Value.

Returns:

an AnnotationBasedExpiration instance to process Time-To-Live Expiration annotated Region Entries.

See Also:

AnnotationBasedExpiration, TimeToLiveExpiration, forTimeToLive(com.gemstone.gemfire.cache.ExpirationAttributes)

forTimeToLive

public static <K,V> AnnotationBasedExpiration<K,V> forTimeToLive(com.gemstone.gemfire.cache.ExpirationAttributes defaultExpirationAttributes)

Constructs an AnnotationBasedExpiration instance with default ExpirationAttributes to process Time-To-Live (TTL) Expiration annotated Region Entries.

Type Parameters:

K - the class type of the Region Entry Key.

V - the class type of the Region Entry Value.

Parameters:

defaultExpirationAttributes - ExpirationAttributes used by default if no Expiration policy was specified on the Region Entry.

Returns:

an AnnotationBasedExpiration instance to process Time-To-Live Expiration annotated Region Entries.

See Also:

AnnotationBasedExpiration, TimeToLiveExpiration

initEvaluationContext

protected void initEvaluationContext()

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException

Sets the BeanFactory managing this AnnotationBasedExpiration bean in the Spring context.

Specified by:

setBeanFactory in interface BeanFactoryAware

Parameters:

beanFactory - the Spring BeanFactory to which this bean belongs.

Throws:

BeansException - if the BeanFactory reference cannot be initialized.

See Also:

BeanFactory, initEvaluationContext()

getBeanFactory

protected BeanFactory getBeanFactory()

Gets a reference to the BeanFactory in which this AnnotationBasedExpiration Bean belongs.

Returns:

a reference to the Spring BeanFactory.

Throws:

IllegalStateException - if the BeanFactory reference was not properly initialized.

See Also:

BeanFactory

setDefaultExpirationAttributes

public void setDefaultExpirationAttributes(com.gemstone.gemfire.cache.ExpirationAttributes defaultExpirationAttributes)

Sets the expiration policy to use by default when no application domain object specific expiration meta-data has been specified.

Parameters:

defaultExpirationAttributes - expiration settings used as the default expiration policy.

See Also:

getDefaultExpirationAttributes(), ExpirationAttributes

getDefaultExpirationAttributes

protected com.gemstone.gemfire.cache.ExpirationAttributes getDefaultExpirationAttributes()

Gets the expiration policy used by default when no application domain object specific expiration meta-data has been specified.

Returns:

an instance of ExpirationAttributes with expiration settings defining the default expiration policy.

See Also:

setDefaultExpirationAttributes(com.gemstone.gemfire.cache.ExpirationAttributes), ExpirationAttributes

getExpiry

public com.gemstone.gemfire.cache.ExpirationAttributes getExpiry(com.gemstone.gemfire.cache.Region.Entry<K,V> entry)

Calculate the expiration for a given entry. Returning null indicates that the default for the Region should be used. The entry parameter should not be used after this method invocation completes.

Specified by:

getExpiry in interface com.gemstone.gemfire.cache.CustomExpiry<K,V>

Parameters:

entry - the entry to calculate the expiration for.

Returns:

the expiration to be used, null if the Region's defaults should be used.

See Also:

ExpirationAttributes

getExpirationMetaData

protected AnnotationBasedExpiration.ExpirationMetaData getExpirationMetaData(com.gemstone.gemfire.cache.Region.Entry<K,V> entry)

Gets custom expiration (Annotation-based) meta-data for the given Region entry.

Parameters:

entry - the Region entry used as the source of the expiration meta-data.

Returns:

ExpirationMetaData extracted from the Region entry.

Throws:

NullPointerException - if the Region.Entry, Region or the Region's attributes are null.

See Also:

AnnotationBasedExpiration.ExpirationMetaData

newExpirationAttributes

protected com.gemstone.gemfire.cache.ExpirationAttributes newExpirationAttributes(AnnotationBasedExpiration.ExpirationMetaData expirationMetaData)

Constructs a new instance of ExpirationAttributes configured with the application domain object specific expiration policy. If the application domain object type has not been annotated with custom expiration meta-data, then the default expiration settings are used.

Parameters:

expirationMetaData - application domain object specific expiration policy meta-data used to construct the ExpirationAttributes.

Returns:

a custom ExpirationAttributes configured with the application domain object specific expiration policy or the default expiration settings if the application domain object has not been annotated with custom expiration meta-data.

See Also:

AnnotationBasedExpiration.ExpirationMetaData, ExpirationAttributes, getDefaultExpirationAttributes()

isExpirationConfigured

protected boolean isExpirationConfigured(com.gemstone.gemfire.cache.Region.Entry<K,V> entry)

Determines whether the Region Entry has been annotated with the Expiration Annotation.

Parameters:

entry - the Region.Entry to evaluate for the presence of the Expiration Annotation.

Returns:

a boolean value indicating whether the Region Entry has been annotated with @Expiration.

See Also:

Expiration, isAnnotationPresent(Object, Class)

getExpiration

protected Expiration getExpiration(com.gemstone.gemfire.cache.Region.Entry<K,V> entry)

Gets the Expiration Annotation meta-data from the Region Entry.

Parameters:

entry - the Region.Entry from which to extract the Expiration Annotation meta-data.

Returns:

the Expiration Annotation meta-data for the given Region Entry or null if the Region Entry has not been annotated with @Expiration.

See Also:

Expiration, getAnnotation(Object, Class)

isIdleTimeoutConfigured

protected boolean isIdleTimeoutConfigured(com.gemstone.gemfire.cache.Region.Entry<K,V> entry)

Determines whether the Region Entry has been annotated with the IdleTimeoutExpiration Annotation.

Parameters:

entry - the Region.Entry to evaluate for the presence of the IdleTimeoutExpiration Annotation.

Returns:

a boolean value indicating whether the Region Entry has been annotated with @IdleTimeoutExpiration.

See Also:

IdleTimeoutExpiration, isAnnotationPresent(Object, Class)

getIdleTimeout

protected IdleTimeoutExpiration getIdleTimeout(com.gemstone.gemfire.cache.Region.Entry<K,V> entry)

Gets the IdleTimeoutExpiration Annotation meta-data from the Region Entry.

Parameters:

entry - the Region.Entry from which to extract the IdleTimeoutExpiration Annotation meta-data.

Returns:

the IdleTimeoutExpiration Annotation meta-data for the given Region Entry or null if the Region Entry has not been annotated with @IdleTimeoutExpiration.

See Also:

IdleTimeoutExpiration, getAnnotation(Object, Class)

isTimeToLiveConfigured

protected boolean isTimeToLiveConfigured(com.gemstone.gemfire.cache.Region.Entry<K,V> entry)

Determines whether the Region Entry has been annotated with the TimeToLiveExpiration Annotation.

Parameters:

entry - the Region.Entry to evaluate for the presence of the TimeToLiveExpiration Annotation.

Returns:

a boolean value indicating whether the Region Entry has been annotated with @TimeToLiveExpiration.

See Also:

TimeToLiveExpiration, isAnnotationPresent(Object, Class)

getTimeToLive

protected TimeToLiveExpiration getTimeToLive(com.gemstone.gemfire.cache.Region.Entry<K,V> entry)

Gets the TimeToLiveExpiration Annotation meta-data from the Region Entry.

Parameters:

entry - the Region.Entry from which to extract the TimeToLiveExpiration Annotation meta-data.

Returns:

the TimeToLiveExpiration Annotation meta-data for the given Region Entry or null if the Region Entry has not been annotated with @TimeToLiveExpiration.

See Also:

TimeToLiveExpiration, getAnnotation(Object, Class)

close

public void close()

Called when the Region containing this callback is closed or destroyed, when the Cache is closed, or when a callback is removed from a Region using an AttributesMutator.

Specified by:

close in interface com.gemstone.gemfire.cache.CacheCallback