NamedCacheObjectExpiredEventArgs

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.scaleoutsoftware.soss.client
Class NamedCacheObjectExpiredEventArgs

java.lang.Object
  com.scaleoutsoftware.soss.client.NamedCacheObjectExpiredEventArgs

public class NamedCacheObjectExpiredEventArgs
extends Object
extends Object

This is a helper class, objects of which are passed as an argument to the event handler's NamedCacheObjectExpirationListener. Methods of this class allow location and manipulation of the expired object by providing references to the relevant NamedCache and object's CachedObjectId.

Nested Class Summary
`static class`	`NamedCacheObjectExpiredEventArgs.NamedCacheEventCode` Enumeration containing the event codes, which can be used to determine the reason why the object was expired and the event was fired.
`static class`	`NamedCacheObjectExpiredEventArgs.NamedCacheObjectDisposition` Enumeration used to indicate to StateServer the disposition of an expired object upon return from a StateServer event handler.

Method Summary
`CachedObjectId`	`getCachedObjectId()` Returns the `CachedObjectId` of the expiring object.
`NamedCache`	`getNamedCache()` Returns the `NamedCache` instance that can be used to manipulate the expiring cached object.
`NamedCacheObjectExpiredEventArgs.NamedCacheEventCode`	`getNamedCacheEventCode()` Returns the reason why the event was fired in the form of event code `NamedCacheObjectExpiredEventArgs.NamedCacheEventCode`.
`void`	`setObjectDisposition(NamedCacheObjectExpiredEventArgs.NamedCacheObjectDisposition disp)` Sets the object disposition( `NamedCacheObjectExpiredEventArgs.NamedCacheObjectDisposition`), determining the action to be performed.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

getNamedCache

public NamedCache getNamedCache()
                         throws NamedCacheException

Returns the NamedCache instance that can be used to manipulate the expiring cached object.

Returns:: NamedCache instance
Throws:: NamedCacheException

getCachedObjectId

public CachedObjectId getCachedObjectId()

Returns the CachedObjectId of the expiring object.

Returns:: object ID

getNamedCacheEventCode

public NamedCacheObjectExpiredEventArgs.NamedCacheEventCode getNamedCacheEventCode()

Returns the reason why the event was fired in the form of event code NamedCacheObjectExpiredEventArgs.NamedCacheEventCode.

Returns:: event code

setObjectDisposition

public void setObjectDisposition(NamedCacheObjectExpiredEventArgs.NamedCacheObjectDisposition disp)

Sets the object disposition( NamedCacheObjectExpiredEventArgs.NamedCacheObjectDisposition), determining the action to be performed.

Parameters:: disp - new object disposition