WebXmlType (Cargo Core Module API 1.0 API)

java.lang.Object
- org.jdom.DefaultJDOMFactory
- - org.codehaus.cargo.module.AbstractDescriptorType
  - - org.codehaus.cargo.module.webapp.WebXmlType

All Implemented Interfaces:

DescriptorType, org.jdom.JDOMFactory

Direct Known Subclasses:

WebXml22Type, WebXml23Type, WebXml24Type, WebXml25Type
```
public abstract class WebXmlType
extends AbstractDescriptorType
```
A document type for web.xml web deployment descriptors.

Version:

$Id: WebXmlType.java 1705 2008-09-02 13:14:55Z adriana $

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AUTH_CONSTRAINT` Element name 'auth-constraint'.
`static String`	`AUTH_METHOD` Element name 'auth-method'.
`static String`	`CONTEXT_PARAM` Element name 'context-param'.
`static String`	`DESCRIPTION` Element name 'description'.
`static String`	`DISPATCHER` Element name 'dispatcher'.
`static String`	`DISPLAY_NAME` Element name 'display-name'.
`static String`	`DISTRIBUTABLE` Element name 'distributable'.
`static String`	`EJB_LINK` Element name 'local-home'.
`static String`	`EJB_LOCAL_REF` Element name 'ejb-local-ref'.
`static String`	`EJB_REF` Element name 'ejb-ref'.
`static String`	`EJB_REF_NAME` Element name 'ejb-ref-name'.
`static String`	`EJB_REF_TYPE` Element name 'ejb-ref-type'.
`static String`	`ENV_ENTRY` Element name 'env-entry'.
`static String`	`ERROR_PAGE` Element name 'error-page'.
`static String`	`FILTER` Element name 'filter'.
`static String`	`FILTER_CLASS` Element name 'filter-class'.
`static String`	`FILTER_MAPPING` Element name 'filter-mapping'.
`static String`	`FILTER_NAME` Element name 'filter-name'.
`static String`	`HOME` Element name 'home'.
`static String`	`ICON` Element name 'icon'.
`static String`	`INIT_PARAM` Element name 'init-param'.
`static String`	`JSP_FILE` Element name 'jsp-file'.
`static String`	`LISTENER` Element name 'listener'.
`static String`	`LOAD_ON_STARTUP` Element name 'load-on-startup'.
`static String`	`LOCAL` Element name 'local'.
`static String`	`LOCAL_HOME` Element name 'local-home'.
`static String`	`LOGIN_CONFIG` Element name 'login-config'.
`static String`	`MIME_MAPPING` Element name 'mime-mapping'.
`static String`	`PARAM_NAME` Element name 'param-name'.
`static String`	`PARAM_VALUE` Element name 'param-value'.
`static String`	`REALM_NAME` Element name 'realm-name'.
`static String`	`REMOTE` Element name 'remote'.
`static String`	`RESOURCE_ENV_REF` Element name 'resource-env-ref'.
`static String`	`RESOURCE_REF` Element name 'resource-ref'.
`static String`	`ROLE_NAME` Element name 'role-name'.
`static String`	`RUN_AS` Element name 'run-as'.
`static String`	`SECURITY_CONSTRAINT` Element name 'security-constraint'.
`static String`	`SECURITY_ROLE` Element name 'security-role'.
`static String`	`SERVLET` Element name 'servlet'.
`static String`	`SERVLET_CLASS` Element name 'servlet-class'.
`static String`	`SERVLET_MAPPING` Element name 'servlet-mapping'.
`static String`	`SERVLET_NAME` Element name 'servlet-name'.
`static String`	`SESSION_CONFIG` Element name 'session-config'.
`static String`	`TAGLIB` Element name 'taglib'.
`static String`	`URL_PATTERN` Element name 'url-pattern'.
`static String`	`WEB_RESOURCE_COLLECTION` Element name 'web-resource-collection'.
`static String`	`WEB_RESOURCE_NAME` Element name 'web-resource-name'.
`static String`	`WELCOME_FILE_LIST` Element name 'welcome-file-list'.

Constructor Summary

Constructors
Modifier Constructor and Description

protected WebXmlType(AbstractDescriptorType parent, Dtd grammar)
Protected constructor.

Constructors
Modifier	Constructor and Description
`protected`	`WebXmlType(AbstractDescriptorType parent, Dtd grammar)` Protected constructor.

Method Summary

Methods
Modifier and Type Method and Description

abstract WebXmlVersion getVersion()
Get the web xml version for his type.
- Methods inherited from class org.codehaus.cargo.module.AbstractDescriptorType
  addTag, document, element, element, getAllTags, getDescriptorIo, getGrammar, getJDOMFactory, getTagByName, setDescriptorIo
- Methods inherited from class org.jdom.DefaultJDOMFactory
  addContent, addNamespaceDeclaration, attribute, attribute, attribute, attribute, cdata, comment, docType, docType, docType, document, document, element, element, entityRef, entityRef, entityRef, processingInstruction, processingInstruction, setAttribute, text
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
- Methods inherited from interface org.jdom.JDOMFactory
  addContent, addNamespaceDeclaration, attribute, attribute, attribute, attribute, cdata, comment, docType, docType, docType, document, document, element, element, entityRef, entityRef, entityRef, processingInstruction, processingInstruction, setAttribute, text

Methods
Modifier and Type	Method and Description
`abstract WebXmlVersion`	`getVersion()` Get the web xml version for his type.

- Field Detail
  - ICON
```
public static final String ICON
```
    Element name 'icon'.
    
    See Also:
    Constant Field Values
  - DISPLAY_NAME
```
public static final String DISPLAY_NAME
```
    Element name 'display-name'.
    
    See Also:
    Constant Field Values
  - DESCRIPTION
```
public static final String DESCRIPTION
```
    Element name 'description'.
    
    See Also:
    Constant Field Values
  - DISTRIBUTABLE
```
public static final String DISTRIBUTABLE
```
    Element name 'distributable'.
    
    See Also:
    Constant Field Values
  - CONTEXT_PARAM
```
public static final String CONTEXT_PARAM
```
    Element name 'context-param'.
    
    See Also:
    Constant Field Values
  - PARAM_NAME
```
public static final String PARAM_NAME
```
    Element name 'param-name'.
    
    See Also:
    Constant Field Values
  - PARAM_VALUE
```
public static final String PARAM_VALUE
```
    Element name 'param-value'.
    
    See Also:
    Constant Field Values
  - FILTER
```
public static final String FILTER
```
    Element name 'filter'.
    
    See Also:
    Constant Field Values
  - FILTER_NAME
```
public static final String FILTER_NAME
```
    Element name 'filter-name'.
    
    See Also:
    Constant Field Values
  - FILTER_CLASS
```
public static final String FILTER_CLASS
```
    Element name 'filter-class'.
    
    See Also:
    Constant Field Values
  - FILTER_MAPPING
```
public static final String FILTER_MAPPING
```
    Element name 'filter-mapping'.
    
    See Also:
    Constant Field Values
  - INIT_PARAM
```
public static final String INIT_PARAM
```
    Element name 'init-param'.
    
    See Also:
    Constant Field Values
  - LISTENER
```
public static final String LISTENER
```
    Element name 'listener'.
    
    See Also:
    Constant Field Values
  - SERVLET
```
public static final String SERVLET
```
    Element name 'servlet'.
    
    See Also:
    Constant Field Values
  - SERVLET_NAME
```
public static final String SERVLET_NAME
```
    Element name 'servlet-name'.
    
    See Also:
    Constant Field Values
  - JSP_FILE
```
public static final String JSP_FILE
```
    Element name 'jsp-file'.
    
    See Also:
    Constant Field Values
  - SERVLET_CLASS
```
public static final String SERVLET_CLASS
```
    Element name 'servlet-class'.
    
    See Also:
    Constant Field Values
  - LOAD_ON_STARTUP
```
public static final String LOAD_ON_STARTUP
```
    Element name 'load-on-startup'.
    
    See Also:
    Constant Field Values
  - RUN_AS
```
public static final String RUN_AS
```
    Element name 'run-as'.
    
    See Also:
    Constant Field Values
  - SERVLET_MAPPING
```
public static final String SERVLET_MAPPING
```
    Element name 'servlet-mapping'.
    
    See Also:
    Constant Field Values
  - URL_PATTERN
```
public static final String URL_PATTERN
```
    Element name 'url-pattern'.
    
    See Also:
    Constant Field Values
  - SESSION_CONFIG
```
public static final String SESSION_CONFIG
```
    Element name 'session-config'.
    
    See Also:
    Constant Field Values
  - MIME_MAPPING
```
public static final String MIME_MAPPING
```
    Element name 'mime-mapping'.
    
    See Also:
    Constant Field Values
  - WELCOME_FILE_LIST
```
public static final String WELCOME_FILE_LIST
```
    Element name 'welcome-file-list'.
    
    See Also:
    Constant Field Values
  - ERROR_PAGE
```
public static final String ERROR_PAGE
```
    Element name 'error-page'.
    
    See Also:
    Constant Field Values
  - TAGLIB
```
public static final String TAGLIB
```
    Element name 'taglib'.
    
    See Also:
    Constant Field Values
  - RESOURCE_ENV_REF
```
public static final String RESOURCE_ENV_REF
```
    Element name 'resource-env-ref'.
    
    See Also:
    Constant Field Values
  - RESOURCE_REF
```
public static final String RESOURCE_REF
```
    Element name 'resource-ref'.
    
    See Also:
    Constant Field Values
  - SECURITY_CONSTRAINT
```
public static final String SECURITY_CONSTRAINT
```
    Element name 'security-constraint'.
    
    See Also:
    Constant Field Values
  - WEB_RESOURCE_COLLECTION
```
public static final String WEB_RESOURCE_COLLECTION
```
    Element name 'web-resource-collection'.
    
    See Also:
    Constant Field Values
  - WEB_RESOURCE_NAME
```
public static final String WEB_RESOURCE_NAME
```
    Element name 'web-resource-name'.
    
    See Also:
    Constant Field Values
  - AUTH_CONSTRAINT
```
public static final String AUTH_CONSTRAINT
```
    Element name 'auth-constraint'.
    
    See Also:
    Constant Field Values
  - LOGIN_CONFIG
```
public static final String LOGIN_CONFIG
```
    Element name 'login-config'.
    
    See Also:
    Constant Field Values
  - AUTH_METHOD
```
public static final String AUTH_METHOD
```
    Element name 'auth-method'.
    
    See Also:
    Constant Field Values
  - REALM_NAME
```
public static final String REALM_NAME
```
    Element name 'realm-name'.
    
    See Also:
    Constant Field Values
  - SECURITY_ROLE
```
public static final String SECURITY_ROLE
```
    Element name 'security-role'.
    
    See Also:
    Constant Field Values
  - ROLE_NAME
```
public static final String ROLE_NAME
```
    Element name 'role-name'.
    
    See Also:
    Constant Field Values
  - ENV_ENTRY
```
public static final String ENV_ENTRY
```
    Element name 'env-entry'.
    
    See Also:
    Constant Field Values
  - EJB_REF
```
public static final String EJB_REF
```
    Element name 'ejb-ref'.
    
    See Also:
    Constant Field Values
  - EJB_LOCAL_REF
```
public static final String EJB_LOCAL_REF
```
    Element name 'ejb-local-ref'.
    
    See Also:
    Constant Field Values
  - EJB_REF_NAME
```
public static final String EJB_REF_NAME
```
    Element name 'ejb-ref-name'.
    
    See Also:
    Constant Field Values
  - EJB_REF_TYPE
```
public static final String EJB_REF_TYPE
```
    Element name 'ejb-ref-type'.
    
    See Also:
    Constant Field Values
  - LOCAL
```
public static final String LOCAL
```
    Element name 'local'.
    
    See Also:
    Constant Field Values
  - LOCAL_HOME
```
public static final String LOCAL_HOME
```
    Element name 'local-home'.
    
    See Also:
    Constant Field Values
  - REMOTE
```
public static final String REMOTE
```
    Element name 'remote'.
    
    See Also:
    Constant Field Values
  - HOME
```
public static final String HOME
```
    Element name 'home'.
    
    See Also:
    Constant Field Values
  - EJB_LINK
```
public static final String EJB_LINK
```
    Element name 'local-home'.
    
    See Also:
    Constant Field Values
  - DISPATCHER
```
public static final String DISPATCHER
```
    Element name 'dispatcher'.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - WebXmlType
```
protected WebXmlType(AbstractDescriptorType parent,
          Dtd grammar)
```
    Protected constructor.
    
    Parameters:
    parent - Parent type if any
    grammar - grammar to use
- Method Detail
  - getVersion
```
public abstract WebXmlVersion getVersion()
```
    Get the web xml version for his type.
    
    Returns:
    the version for this type

Class WebXmlType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.codehaus.cargo.module.AbstractDescriptorType

Methods inherited from class org.jdom.DefaultJDOMFactory

Methods inherited from class java.lang.Object

Methods inherited from interface org.jdom.JDOMFactory

Field Detail

ICON

DISPLAY_NAME

DESCRIPTION

DISTRIBUTABLE

CONTEXT_PARAM

PARAM_NAME

PARAM_VALUE

FILTER

FILTER_NAME

FILTER_CLASS

FILTER_MAPPING

INIT_PARAM

LISTENER

SERVLET

SERVLET_NAME

JSP_FILE

SERVLET_CLASS

LOAD_ON_STARTUP

RUN_AS

SERVLET_MAPPING

URL_PATTERN

SESSION_CONFIG

MIME_MAPPING

WELCOME_FILE_LIST

ERROR_PAGE

TAGLIB

RESOURCE_ENV_REF

RESOURCE_REF

SECURITY_CONSTRAINT

WEB_RESOURCE_COLLECTION

WEB_RESOURCE_NAME

AUTH_CONSTRAINT

LOGIN_CONFIG

AUTH_METHOD

REALM_NAME

SECURITY_ROLE

ROLE_NAME

ENV_ENTRY

EJB_REF

EJB_LOCAL_REF

EJB_REF_NAME

EJB_REF_TYPE

LOCAL

LOCAL_HOME

REMOTE

HOME

EJB_LINK

DISPATCHER

Constructor Detail

WebXmlType

Method Detail

getVersion