com.scaleoutsoftware.soss.client.da

Class ObjectExpiredEventArgs

java.lang.Object

com.scaleoutsoftware.soss.client.da.StateServerEventArgs

com.scaleoutsoftware.soss.client.da.ObjectExpiredEventArgs

public class ObjectExpiredEventArgs
extends StateServerEventArgs

The argument to a ObjectExpirationListener.objectExpired(ObjectExpiredEventArgs) callback that identifies an object in StateServer that has expired.

The callback can alter the disposition for the object via setObjectDisposition(com.scaleoutsoftware.soss.client.ObjectDisposition). The default disposition is ObjectDisposition.Remove.

Method Summary

Modifier and Type	Method and Description
ObjectDisposition	getObjectDisposition() Return the current disposition for this object.
void	setObjectDisposition(ObjectDisposition disposition) Set the object's disposition to disposition.

Methods inherited from class com.scaleoutsoftware.soss.client.da.StateServerEventArgs

getAppId, getDataAccessor, getEventCode, getExtendedProperties, getKey

Methods inherited from class java.lang.Object

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

Method Detail

getObjectDisposition

public ObjectDisposition getObjectDisposition()

Return the current disposition for this object.

Returns:

the current disposition for this object.

setObjectDisposition

public void setObjectDisposition(ObjectDisposition disposition)

Set the object's disposition to disposition.

If multiple ObjectExpirationListeners are registered, each listener will receive a callback with the same ObjectExpiredEventArgs instance. After all listeners have received callbacks, getObjectDisposition() is examined and determines the actual disposition for the object. If need be, multiple cooperating listeners can use StateServerEventArgs.getExtendedProperties() to communicate status between themselves.

Parameters:

disposition - an ObjectDisposition value indicating how StateServer should process the object expiration.