org.opensaml.util.storage

Interface ExpiringObject

All Known Subinterfaces:

SAMLArtifactMap.SAMLArtifactMapEntry

All Known Implementing Classes:

AbstractExpiringObject, BasicSAMLArtifactMapEntry, ReplayCacheEntry

public interface ExpiringObject

A simple interface for objects that may expire at a given time.

Method Summary

Methods

Modifier and Type	Method and Description
org.joda.time.DateTime	getExpirationTime() Gets the time the object expires.
boolean	isExpired() Gets whether this object has expired.
void	onExpire() A callback method invoked when this object is expiring.

Method Detail

getExpirationTime

org.joda.time.DateTime getExpirationTime()

Gets the time the object expires.

Returns:

time the object expires

isExpired

boolean isExpired()

Gets whether this object has expired.

Returns:

true if the expiration time has passed, false if not

onExpire

void onExpire()

A callback method invoked when this object is expiring. Note, this method may not be invoked at the exact instant of expiration but may, instead, be invoked the next time the object is read and noticed to have expired.