Package com.ibm.websphere.servlet.cache
Class ConfigElement
java.lang.Object
com.ibm.websphere.servlet.cache.ConfigElement
Deprecated.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Deprecated.This specifies that the type of component is a cookie object.Deprecated.This is the data id that makes this entry invalid when it becomes invalid.Deprecated.This is a hashset of strings whose keys, if equal to the value of this variable on the request, will exclude this entry from being cached.boolean
Deprecated.This flag indicates that, if this variable is present on the request, the servlet/JSP should not be cached.Deprecated.This is the identifier of the cache entry.boolean
Deprecated.This flag indicates that, if this variable is present on the request, its value will not be used to generate the cache id.Deprecated.This is the invalidation ID for this entry.Deprecated.This is the method to be called on the command or object.static final int
Deprecated.This specifies that the type of component is an attribute of the request object.static final int
Deprecated.This specifies that the type of component is a parameter from the request object.boolean
Deprecated.This flag indicates whether or not this variable is required to generate the cache ID for this entry.static final int
Deprecated.This specifies that the type of component is an parameter from the HTTPSession object.int
Deprecated.This specifies the component type of the variable. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract String
Deprecated.This gets the data id variable.abstract HashSet
Deprecated.This gets the set of strings that, if equal to the value of this variable on the request, will exclude this entry from being cached.abstract boolean
Deprecated.This gets the value of the excludeAll flag.abstract String
getId()
Deprecated.This gets the id variable.abstract boolean
Deprecated.This gets the value of the ignoreValue flag.abstract String
Deprecated.This gets value of the inavalidate variable.abstract String
Deprecated.This gets the value of the method variable.abstract boolean
Deprecated.This gets the value of the required flag.
-
Field Details
-
type
public int typeDeprecated.This specifies the component type of the variable. For Servlets/ JSPs it may be set to ConfigElement.RequestParameter, ConfigElement.RequestAttribute, ConfigElement.SessionParameter or ConfigElement.Cookie -
RequestParameter
public static final int RequestParameterDeprecated.This specifies that the type of component is a parameter from the request object.- See Also:
-
RequestAttribute
public static final int RequestAttributeDeprecated.This specifies that the type of component is an attribute of the request object.- See Also:
-
SessionParameter
public static final int SessionParameterDeprecated.This specifies that the type of component is an parameter from the HTTPSession object.- See Also:
-
Cookie
public static final int CookieDeprecated.This specifies that the type of component is a cookie object.- See Also:
-
id
Deprecated.This is the identifier of the cache entry. It must be unique within the scope of the cache. which is the WebSphere server group for the application. -
method
Deprecated.This is the method to be called on the command or object. -
dataId
Deprecated.This is the data id that makes this entry invalid when it becomes invalid. It must be unique within the same scope as the CacheEntry id. These data ids identify the underlying dynamic content (i.e., the raw data). When a piece of data is used in only one CacheEntry, the data id of the data can be the same as the CacheEntry id. When a piece of data is used in multiple fragments, its data id would be different from any of the CacheEntry ids. -
invalidate
Deprecated.This is the invalidation ID for this entry. -
exclude
Deprecated.This is a hashset of strings whose keys, if equal to the value of this variable on the request, will exclude this entry from being cached. -
required
public boolean requiredDeprecated.This flag indicates whether or not this variable is required to generate the cache ID for this entry. -
excludeAll
public boolean excludeAllDeprecated.This flag indicates that, if this variable is present on the request, the servlet/JSP should not be cached. -
ignoreValue
public boolean ignoreValueDeprecated.This flag indicates that, if this variable is present on the request, its value will not be used to generate the cache id.
-
-
Constructor Details
-
ConfigElement
public ConfigElement()Deprecated.
-
-
Method Details
-
getId
Deprecated.This gets the id variable.- Returns:
- The cache id.
-
getMethod
Deprecated.This gets the value of the method variable.- Returns:
- The method name.
-
getDataId
Deprecated.This gets the data id variable.- Returns:
- The data id.
-
getInvalidate
Deprecated.This gets value of the inavalidate variable.- Returns:
- The invalidation id.
-
getExclude
Deprecated.This gets the set of strings that, if equal to the value of this variable on the request, will exclude this entry from being cached.- Returns:
- Set of variables values.
-
getExcludeAll
public abstract boolean getExcludeAll()Deprecated.This gets the value of the excludeAll flag.- Returns:
- True, if a servlet/ JSP should not be cached.
-
getRequired
public abstract boolean getRequired()Deprecated.This gets the value of the required flag.- Returns:
- True, if the variable is required to create the cache id.
-
getIgnoreValue
public abstract boolean getIgnoreValue()Deprecated.This gets the value of the ignoreValue flag.- Returns:
- True if the value of this variable can be ignored while building the cache id.
-
<request>
<parameter id="cityname" data_id="city" required="true" />
</request>
would generate a ConfigElement object where