com.ibm.websphere.servlet.cache
Class ConfigElement
java.lang.Object
|
+--com.ibm.websphere.servlet.cache.ConfigElement
- public abstract class ConfigElement
- extends java.lang.Object
This Class represents a variable specified in the servletcache.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 /properties/servletcache.xml file
(WAS 3.5.3 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)
For example, a request parameter defined so in servletcache.xml
<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.
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
type
public int type
RequestParameter
public static final int RequestParameter
RequestAttribute
public static final int RequestAttribute
SessionParameter
public static final int SessionParameter
Cookie
public static final int Cookie
id
public java.lang.String id
method
public java.lang.String method
dataId
public java.lang.String dataId
invalidate
public java.lang.String invalidate
exclude
public java.util.HashSet exclude
required
public boolean required
excludeAll
public boolean excludeAll
ignoreValue
public boolean ignoreValue
ConfigElement
public ConfigElement()
getId
public abstract java.lang.String getId()
getMethod
public abstract java.lang.String getMethod()
getDataId
public abstract java.lang.String getDataId()
getInvalidate
public abstract java.lang.String getInvalidate()
getExclude
public abstract java.util.HashSet getExclude()
getExcludeAll
public abstract boolean getExcludeAll()
getRequired
public abstract boolean getRequired()
getIgnoreValue
public abstract boolean getIgnoreValue()