ConfigElement (IBM WebSphere Application Server, Release 8.5)

java.lang.Object
- com.ibm.websphere.servlet.cache.ConfigElement

Deprecated.
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)
For example, a request parameter defined so in cachespec.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.
```
public abstract class ConfigElement
extends java.lang.Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`Cookie` Deprecated. This specifies that the type of component is a cookie object.
`java.lang.String`	`dataId` Deprecated. This is the data id that makes this entry invalid when it becomes invalid.
`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.
`boolean`	`excludeAll` Deprecated. This flag indicates that, if this variable is present on the request, the servlet/JSP should not be cached.
`java.lang.String`	`id` Deprecated. This is the identifier of the cache entry.
`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.
`java.lang.String`	`invalidate` Deprecated. This is the invalidation ID for this entry.
`java.lang.String`	`method` Deprecated. This is the method to be called on the command or object.
`static int`	`RequestAttribute` Deprecated. This specifies that the type of component is an attribute of the request object.
`static int`	`RequestParameter` Deprecated. This specifies that the type of component is a parameter from the request object.
`boolean`	`required` Deprecated. This flag indicates whether or not this variable is required to generate the cache ID for this entry.
`static int`	`SessionParameter` Deprecated. This specifies that the type of component is an parameter from the HTTPSession object.
`int`	`type` Deprecated. This specifies the component type of the variable.

Constructor Summary

Constructors
Constructor and Description

ConfigElement()
Deprecated.

Constructors
Constructor and Description
`ConfigElement()` Deprecated.

Method Summary

Methods
Modifier and Type	Method and Description
`abstract java.lang.String`	`getDataId()` Deprecated. This gets the data id variable.
`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.
`abstract boolean`	`getExcludeAll()` Deprecated. This gets the value of the excludeAll flag.
`abstract java.lang.String`	`getId()` Deprecated. This gets the id variable.
`abstract boolean`	`getIgnoreValue()` Deprecated. This gets the value of the ignoreValue flag.
`abstract java.lang.String`	`getInvalidate()` Deprecated. This gets value of the inavalidate variable.
`abstract java.lang.String`	`getMethod()` Deprecated. This gets the value of the method variable.
`abstract boolean`	`getRequired()` Deprecated. This gets the value of the required flag.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - type
```
public 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
  - RequestParameter
```
public static final int RequestParameter
```
    Deprecated.
    
    This specifies that the type of component is a parameter from the request object.
    
    See Also:
    Constant Field Values
  - RequestAttribute
```
public static final int RequestAttribute
```
    Deprecated.
    
    This specifies that the type of component is an attribute of the request object.
    
    See Also:
    Constant Field Values
  - SessionParameter
```
public static final int SessionParameter
```
    Deprecated.
    
    This specifies that the type of component is an parameter from the HTTPSession object.
    
    See Also:
    Constant Field Values
  - Cookie
```
public static final int Cookie
```
    Deprecated.
    
    This specifies that the type of component is a cookie object.
    
    See Also:
    Constant Field Values
  - id
```
public 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.
  - method
```
public java.lang.String method
```
    Deprecated.
    
    This is the method to be called on the command or object.
  - dataId
```
public 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.
  - invalidate
```
public java.lang.String invalidate
```
    Deprecated.
    
    This is the invalidation ID for this entry.
  - exclude
```
public 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.
  - required
```
public boolean required
```
    Deprecated.
    
    This flag indicates whether or not this variable is required to generate the cache ID for this entry.
  - excludeAll
```
public boolean excludeAll
```
    Deprecated.
    
    This flag indicates that, if this variable is present on the request, the servlet/JSP should not be cached.
  - ignoreValue
```
public 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.
- Constructor Detail
  - ConfigElement
```
public ConfigElement()
```
    Deprecated.
- Method Detail
  - getId
```
public abstract java.lang.String getId()
```
    Deprecated.
    
    This gets the id variable.
    
    Returns:
    The cache id.
  - getMethod
```
public abstract java.lang.String getMethod()
```
    Deprecated.
    
    This gets the value of the method variable.
    
    Returns:
    The method name.
  - getDataId
```
public abstract java.lang.String getDataId()
```
    Deprecated.
    
    This gets the data id variable.
    
    Returns:
    The data id.
  - getInvalidate
```
public abstract java.lang.String getInvalidate()
```
    Deprecated.
    
    This gets value of the inavalidate variable.
    
    Returns:
    The invalidation id.
  - getExclude
```
public 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.
  - 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.

Methods inherited from class java.lang.Object

type

RequestParameter

RequestAttribute

SessionParameter

Cookie

id

method

dataId

invalidate

exclude

required

excludeAll

ignoreValue

ConfigElement

getId

getMethod

getDataId

getInvalidate

getExclude

getExcludeAll

getRequired

getIgnoreValue