Package com.ibm.websphere.servlet.cache
Class ConfigElement
- java.lang.Object
- 
- com.ibm.websphere.servlet.cache.ConfigElement
 
- 
 public abstract class ConfigElement extends java.lang.ObjectDeprecated.This Class represents a variable specified in the cachespec.xml document. If an application uses its own Id or MetaDataGenerator, this class can be used to read the cache policies defined in the Application Assembly Tool (WAS 4.x and higher), or in the cachespec.xml file (WAS 5.0 and higher). It stores all the data specified in the xml file for this variable. The variable may be:- a request parameter, (a String defined externally by a client),
- a request attribute (java object, attached to a ServletRequest object previously in a servlet/JSP),
- a session parameter (java object attached an HttpSession object)
 
 <request>
 <parameter id="cityname" data_id="city" required="true" />
 </request>
 would generate a ConfigElement object where- id returns "cityname",
- method returns null,
- dataId returns "city",
- invalidate returns null,
- required returns TRUE,
- and type returns ConfigElement.RequestParameter.
 
- 
- 
Field SummaryFields Modifier and Type Field Description static intCookieDeprecated.This specifies that the type of component is a cookie object.java.lang.StringdataIdDeprecated.This is the data id that makes this entry invalid when it becomes invalid.java.util.HashSetexcludeDeprecated.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.booleanexcludeAllDeprecated.This flag indicates that, if this variable is present on the request, the servlet/JSP should not be cached.java.lang.StringidDeprecated.This is the identifier of the cache entry.booleanignoreValueDeprecated.This flag indicates that, if this variable is present on the request, its value will not be used to generate the cache id.java.lang.StringinvalidateDeprecated.This is the invalidation ID for this entry.java.lang.StringmethodDeprecated.This is the method to be called on the command or object.static intRequestAttributeDeprecated.This specifies that the type of component is an attribute of the request object.static intRequestParameterDeprecated.This specifies that the type of component is a parameter from the request object.booleanrequiredDeprecated.This flag indicates whether or not this variable is required to generate the cache ID for this entry.static intSessionParameterDeprecated.This specifies that the type of component is an parameter from the HTTPSession object.inttypeDeprecated.This specifies the component type of the variable.
 - 
Constructor SummaryConstructors Constructor Description ConfigElement()Deprecated.
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description abstract java.lang.StringgetDataId()Deprecated.This gets the data id variable.abstract java.util.HashSetgetExclude()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 booleangetExcludeAll()Deprecated.This gets the value of the excludeAll flag.abstract java.lang.StringgetId()Deprecated.This gets the id variable.abstract booleangetIgnoreValue()Deprecated.This gets the value of the ignoreValue flag.abstract java.lang.StringgetInvalidate()Deprecated.This gets value of the inavalidate variable.abstract java.lang.StringgetMethod()Deprecated.This gets the value of the method variable.abstract booleangetRequired()Deprecated.This gets the value of the required flag.
 
- 
- 
- 
Field Detail- 
typepublic int type Deprecated.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
 - 
RequestParameterpublic static final int RequestParameter Deprecated.This specifies that the type of component is a parameter from the request object.- See Also:
- Constant Field Values
 
 - 
RequestAttributepublic static final int RequestAttribute Deprecated.This specifies that the type of component is an attribute of the request object.- See Also:
- Constant Field Values
 
 - 
SessionParameterpublic static final int SessionParameter Deprecated.This specifies that the type of component is an parameter from the HTTPSession object.- See Also:
- Constant Field Values
 
 - 
Cookiepublic static final int Cookie Deprecated.This specifies that the type of component is a cookie object.- See Also:
- Constant Field Values
 
 - 
idpublic java.lang.String 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.
 - 
methodpublic java.lang.String method Deprecated.This is the method to be called on the command or object.
 - 
dataIdpublic java.lang.String 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.
 - 
invalidatepublic java.lang.String invalidate Deprecated.This is the invalidation ID for this entry.
 - 
excludepublic java.util.HashSet 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.
 - 
requiredpublic boolean required Deprecated.This flag indicates whether or not this variable is required to generate the cache ID for this entry.
 - 
excludeAllpublic boolean excludeAll Deprecated.This flag indicates that, if this variable is present on the request, the servlet/JSP should not be cached.
 - 
ignoreValuepublic boolean ignoreValue Deprecated.This flag indicates that, if this variable is present on the request, its value will not be used to generate the cache id.
 
- 
 - 
Method Detail- 
getIdpublic abstract java.lang.String getId() Deprecated.This gets the id variable.- Returns:
- The cache id.
 
 - 
getMethodpublic abstract java.lang.String getMethod() Deprecated.This gets the value of the method variable.- Returns:
- The method name.
 
 - 
getDataIdpublic abstract java.lang.String getDataId() Deprecated.This gets the data id variable.- Returns:
- The data id.
 
 - 
getInvalidatepublic abstract java.lang.String getInvalidate() Deprecated.This gets value of the inavalidate variable.- Returns:
- The invalidation id.
 
 - 
getExcludepublic abstract java.util.HashSet 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.
 
 - 
getExcludeAllpublic abstract boolean getExcludeAll() Deprecated.This gets the value of the excludeAll flag.- Returns:
- True, if a servlet/ JSP should not be cached.
 
 - 
getRequiredpublic abstract boolean getRequired() Deprecated.This gets the value of the required flag.- Returns:
- True, if the variable is required to create the cache id.
 
 - 
getIgnoreValuepublic 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.
 
 
- 
 
-