|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EntryInfo
EntryInfo and FragmentInfo objects contain metadata for caching and are attached to each cache entry. IdGenerators and MetaDataGenerators use these interfaces to define the caching metadata for an entry.
Typically a Id/MetaDataGenerator will get an entry's FragmentInfo object from the ServletCacheRequest, and use the object's set methods to configure that entry.
The following is a summary of the caching metadata for a CacheEntry:
Field Summary | |
---|---|
static int |
NOT_SHARED
The entry is kept local to the JVM that executed the entry's JSP or command instead of shared across all JVMs. |
static int |
SHARED_PULL
Deprecated. Share type PULL should not be used in new code development. Use share type PUSH_PULL instead. Share type PULL, if used in existing code, will function like share type PUSH_PULL. |
static int |
SHARED_PUSH
The entry is shared across multiple JVMs; the entry is pushed to all JVMs after its JSP or command is executed instead of waiting for the JVMs to pull it. |
static int |
SHARED_PUSH_PULL
The entry is shared across multiple JVMs; the ID of the entry is pushed on initial creation (execution of JSP/Servlet or command) and stored in the other JVMs. |
Method Summary | |
---|---|
void |
addAlias(java.lang.Object alias)
Adds a new alias ID. |
void |
addDataId(java.lang.String dataId)
Adds a new data ID. |
void |
addTemplate(java.lang.String template)
Adds a template. |
java.util.Enumeration |
getAliasList()
Returns the alias IDs set on this entry info. |
int |
getCacheType()
Returns cache type (CACHE_TYPE_DEFAULT or CACHE_TYPE_JAXRPC) |
java.util.Enumeration |
getDataIds()
Returns the data IDs set on this entry info. |
long |
getExpirationTime()
Returns the expiration time. |
java.lang.String |
getId()
Returns the string representation of cache ID. |
java.lang.Object |
getIdObject()
Returns the object representation of cache ID. |
int |
getInactivity()
Returns the inactiviy timer. |
boolean |
getPersistToDisk()
Determine whether persist-to-disk is true. |
int |
getPriority()
Returns the priority. |
int |
getSharingPolicy()
Returns the sharing policy in the sharingPolicy variable. |
java.lang.String |
getTemplate()
Returns one of the templates set on this entry info. |
java.util.Enumeration |
getTemplates()
Returns the templates set on this entry info. |
int |
getTimeLimit()
Returns the time limit. |
java.lang.Object |
getUserMetaData()
Returns the userMetaData. |
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. |
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 |
isNotShared()
Determines whether the sharingPolicy is EntryInfo.NOT_SHARED. |
boolean |
isSharedPull()
Determines whether the sharingPolicy is EntryInfo.SHARED_PULL. |
boolean |
isSharedPush()
Determines whether the sharingPolicy is EntryInfo.SHARED_PUSH. |
void |
setBatchEnabled(boolean flag)
Deprecated. The updates for Push or Push-Pull sharing policies are always done in an asynchronous batch mode. Calling setBatchEnabled(false) has no effect on cache replication. |
void |
setExpirationTime(long expirationTime)
Assigns new expiration time. |
void |
setId(java.lang.String id)
Sets the cache ID. |
void |
setInactivity(int inactivity)
Assigns the inactivity timer. |
void |
setPersistToDisk(boolean persistToDisk)
Sets the persist-to-disk. |
void |
setPriority(int priority)
Assigns the new priority. |
void |
setSharingPolicy(int policy)
Sets the sharing policy. |
void |
setTimeLimit(int timeLimit)
Assigns the time limit. |
void |
setUserMetaData(java.lang.Object userMetaData)
Assigns the new userMetaData. |
Field Detail |
---|
static final int NOT_SHARED
static final int SHARED_PUSH
static final int SHARED_PULL
static final int SHARED_PUSH_PULL
Method Detail |
---|
java.lang.String getId()
java.lang.Object getIdObject()
void setId(java.lang.String id)
id
- The cache ID.boolean isBatchEnabled()
void setBatchEnabled(boolean flag)
flag
- true to enable batch updates, false otherwise.int getSharingPolicy()
EntryInfo
boolean getPersistToDisk()
void setSharingPolicy(int policy)
policy
- The sharing policy.EntryInfo
void setPersistToDisk(boolean persistToDisk)
persistToDisk
- The persist-to-disk.boolean isNotShared()
boolean isSharedPush()
boolean isSharedPull()
int getTimeLimit()
void setTimeLimit(int timeLimit)
timeLimit
- The time limit.int getInactivity()
void setInactivity(int inactivity)
inactivity
- This inactivity timer.long getExpirationTime()
void setExpirationTime(long expirationTime)
expirationTime
- The new expiration time.int getPriority()
void setPriority(int priority)
priority
- The new priority.java.util.Enumeration getTemplates()
java.lang.String getTemplate()
void addTemplate(java.lang.String template)
template
- The new Template name.java.util.Enumeration getDataIds()
void addDataId(java.lang.String dataId)
dataId
- The new data ID.java.util.Enumeration getAliasList()
void addAlias(java.lang.Object alias)
alias
- The new alias ID.java.lang.Object getUserMetaData()
void setUserMetaData(java.lang.Object userMetaData)
userMetaData
- The new userMetaData.long getValidatorExpirationTime()
int getCacheType()
|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |