public interface CacheEntry
Modifier and Type | Field and Description |
---|---|
static int |
CACHE_TYPE_DEFAULT
Default type of a cache entry.
|
static int |
CACHE_TYPE_JAXRPC
This type of cache entry is is used internally by Dynamic Cache for
when caching webservices.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object object) |
void |
finish()
Call the finish() method when you no longer need this
CacheEntry.
|
java.util.Enumeration |
getAliasList()
Returns the alias list.
|
int |
getCacheType()
Returns the type of CacheEntry (CACHE_TYPE_DEFAULT or CACHE_TYPE_JAXRPC)
ALL implementors of this method other than Dynacache should return CACHE_TYPE_DEFAULT
for this method.
|
long |
getCacheValueSize()
Returns the best-effort size of the cache entry's value.
|
long |
getCreationTime()
Returns the time of the entry was first created.
|
java.util.Enumeration |
getDataIds()
Returns all IDs (cache IDs and data IDs) that this entry
depends on for invalidation.
|
byte[] |
getDisplayValue()
Returns the entry's value in a displayable format.
|
long |
getExpirationTime()
Returns the absolute time when the entry should expire.
|
java.lang.String |
getExternalCacheGroupId()
Returns the
ExternalCacheGroup name this the cache entry belongs too. |
java.lang.String |
getId()
Returns the unique identifier of this cached entry.
|
java.lang.Object |
getIdObject()
This method gets the unique identifier of this cached entry.
|
int |
getPriority()
Returns the priority of this cache entry, which
determines how long the entry will stay in cache
when it is not being used.
|
int |
getSharingPolicy()
Returns the sharing policy of this entry.
|
java.util.Enumeration |
getTemplates()
Returns all templates that this entry depends on for invalidation.
|
int |
getTimeLimit()
Returns the maximum interval of time in seconds
that the entry is allowed to stay in the cache.
|
long |
getTimeStamp()
Returns the creation time of this entry.
|
java.lang.Object |
getUserMetaData()
Returns the user metadata.
|
long |
getValidatorExpirationTime()
Returns the validator expiration time of the entry in the cache
The validator expiration time along with the expiration time
control the state of the entry in the cache.
|
java.lang.Object |
getValue()
Returns the entry's value.
|
int |
hashCode() |
boolean |
isBatchEnabled()
Deprecated.
The updates for Push or Push-Pull sharing policies are
always done in an asynchronous batch mode. It always
returns true.
|
boolean |
isInvalid()
Is this entry an invalid entry?
An invalid entry is like a zombie i.e.
|
boolean |
prepareForSerialization()
This method will be called before serialization of the CacheEntry.
|
void |
refreshEntry()
This mimics a cache Hit, refreshing an entries spot in the replacement algorithm.
|
java.lang.String |
toString() |
static final int CACHE_TYPE_DEFAULT
static final int CACHE_TYPE_JAXRPC
java.util.Enumeration getTemplates()
java.util.Enumeration getDataIds()
long getTimeStamp()
boolean equals(java.lang.Object object)
equals
in class java.lang.Object
int hashCode()
hashCode
in class java.lang.Object
int getTimeLimit()
long getExpirationTime()
int getPriority()
int getSharingPolicy()
boolean isBatchEnabled()
java.lang.String getId()
java.lang.Object getValue()
byte[] getDisplayValue()
void refreshEntry()
java.util.Enumeration getAliasList()
java.lang.Object getUserMetaData()
void finish()
long getCacheValueSize()
boolean isInvalid()
long getCreationTime()
java.lang.Object getIdObject()
int getCacheType()
long getValidatorExpirationTime()
boolean prepareForSerialization()
java.lang.String toString()
toString
in class java.lang.Object
java.lang.String getExternalCacheGroupId()
ExternalCacheGroup
name this the cache entry belongs too.