org.codehaus.cargo.module.webapp
Class WebXmlType

java.lang.Object
  extended by org.jdom.DefaultJDOMFactory
      extended by org.codehaus.cargo.module.AbstractDescriptorType
          extended by 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
static java.lang.String AUTH_CONSTRAINT
          Element name 'auth-constraint'.
static java.lang.String AUTH_METHOD
          Element name 'auth-method'.
static java.lang.String CONTEXT_PARAM
          Element name 'context-param'.
static java.lang.String DESCRIPTION
          Element name 'description'.
static java.lang.String DISPATCHER
          Element name 'dispatcher'.
static java.lang.String DISPLAY_NAME
          Element name 'display-name'.
static java.lang.String DISTRIBUTABLE
          Element name 'distributable'.
static java.lang.String EJB_LINK
          Element name 'local-home'.
static java.lang.String EJB_LOCAL_REF
          Element name 'ejb-local-ref'.
static java.lang.String EJB_REF
          Element name 'ejb-ref'.
static java.lang.String EJB_REF_NAME
          Element name 'ejb-ref-name'.
static java.lang.String EJB_REF_TYPE
          Element name 'ejb-ref-type'.
static java.lang.String ENV_ENTRY
          Element name 'env-entry'.
static java.lang.String ERROR_PAGE
          Element name 'error-page'.
static java.lang.String FILTER
          Element name 'filter'.
static java.lang.String FILTER_CLASS
          Element name 'filter-class'.
static java.lang.String FILTER_MAPPING
          Element name 'filter-mapping'.
static java.lang.String FILTER_NAME
          Element name 'filter-name'.
static java.lang.String HOME
          Element name 'home'.
static java.lang.String ICON
          Element name 'icon'.
static java.lang.String INIT_PARAM
          Element name 'init-param'.
static java.lang.String JSP_FILE
          Element name 'jsp-file'.
static java.lang.String LISTENER
          Element name 'listener'.
static java.lang.String LOAD_ON_STARTUP
          Element name 'load-on-startup'.
static java.lang.String LOCAL
          Element name 'local'.
static java.lang.String LOCAL_HOME
          Element name 'local-home'.
static java.lang.String LOGIN_CONFIG
          Element name 'login-config'.
static java.lang.String MIME_MAPPING
          Element name 'mime-mapping'.
static java.lang.String PARAM_NAME
          Element name 'param-name'.
static java.lang.String PARAM_VALUE
          Element name 'param-value'.
static java.lang.String REALM_NAME
          Element name 'realm-name'.
static java.lang.String REMOTE
          Element name 'remote'.
static java.lang.String RESOURCE_ENV_REF
          Element name 'resource-env-ref'.
static java.lang.String RESOURCE_REF
          Element name 'resource-ref'.
static java.lang.String ROLE_NAME
          Element name 'role-name'.
static java.lang.String RUN_AS
          Element name 'run-as'.
static java.lang.String SECURITY_CONSTRAINT
          Element name 'security-constraint'.
static java.lang.String SECURITY_ROLE
          Element name 'security-role'.
static java.lang.String SERVLET
          Element name 'servlet'.
static java.lang.String SERVLET_CLASS
          Element name 'servlet-class'.
static java.lang.String SERVLET_MAPPING
          Element name 'servlet-mapping'.
static java.lang.String SERVLET_NAME
          Element name 'servlet-name'.
static java.lang.String SESSION_CONFIG
          Element name 'session-config'.
static java.lang.String TAGLIB
          Element name 'taglib'.
static java.lang.String URL_PATTERN
          Element name 'url-pattern'.
static java.lang.String WEB_RESOURCE_COLLECTION
          Element name 'web-resource-collection'.
static java.lang.String WEB_RESOURCE_NAME
          Element name 'web-resource-name'.
static java.lang.String WELCOME_FILE_LIST
          Element name 'welcome-file-list'.
 
Constructor Summary
protected WebXmlType(AbstractDescriptorType parent, Dtd grammar)
          Protected constructor.
 
Method Summary
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
 

Field Detail

ICON

public static final java.lang.String ICON
Element name 'icon'.

See Also:
Constant Field Values

DISPLAY_NAME

public static final java.lang.String DISPLAY_NAME
Element name 'display-name'.

See Also:
Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION
Element name 'description'.

See Also:
Constant Field Values

DISTRIBUTABLE

public static final java.lang.String DISTRIBUTABLE
Element name 'distributable'.

See Also:
Constant Field Values

CONTEXT_PARAM

public static final java.lang.String CONTEXT_PARAM
Element name 'context-param'.

See Also:
Constant Field Values

PARAM_NAME

public static final java.lang.String PARAM_NAME
Element name 'param-name'.

See Also:
Constant Field Values

PARAM_VALUE

public static final java.lang.String PARAM_VALUE
Element name 'param-value'.

See Also:
Constant Field Values

FILTER

public static final java.lang.String FILTER
Element name 'filter'.

See Also:
Constant Field Values

FILTER_NAME

public static final java.lang.String FILTER_NAME
Element name 'filter-name'.

See Also:
Constant Field Values

FILTER_CLASS

public static final java.lang.String FILTER_CLASS
Element name 'filter-class'.

See Also:
Constant Field Values

FILTER_MAPPING

public static final java.lang.String FILTER_MAPPING
Element name 'filter-mapping'.

See Also:
Constant Field Values

INIT_PARAM

public static final java.lang.String INIT_PARAM
Element name 'init-param'.

See Also:
Constant Field Values

LISTENER

public static final java.lang.String LISTENER
Element name 'listener'.

See Also:
Constant Field Values

SERVLET

public static final java.lang.String SERVLET
Element name 'servlet'.

See Also:
Constant Field Values

SERVLET_NAME

public static final java.lang.String SERVLET_NAME
Element name 'servlet-name'.

See Also:
Constant Field Values

JSP_FILE

public static final java.lang.String JSP_FILE
Element name 'jsp-file'.

See Also:
Constant Field Values

SERVLET_CLASS

public static final java.lang.String SERVLET_CLASS
Element name 'servlet-class'.

See Also:
Constant Field Values

LOAD_ON_STARTUP

public static final java.lang.String LOAD_ON_STARTUP
Element name 'load-on-startup'.

See Also:
Constant Field Values

RUN_AS

public static final java.lang.String RUN_AS
Element name 'run-as'.

See Also:
Constant Field Values

SERVLET_MAPPING

public static final java.lang.String SERVLET_MAPPING
Element name 'servlet-mapping'.

See Also:
Constant Field Values

URL_PATTERN

public static final java.lang.String URL_PATTERN
Element name 'url-pattern'.

See Also:
Constant Field Values

SESSION_CONFIG

public static final java.lang.String SESSION_CONFIG
Element name 'session-config'.

See Also:
Constant Field Values

MIME_MAPPING

public static final java.lang.String MIME_MAPPING
Element name 'mime-mapping'.

See Also:
Constant Field Values

WELCOME_FILE_LIST

public static final java.lang.String WELCOME_FILE_LIST
Element name 'welcome-file-list'.

See Also:
Constant Field Values

ERROR_PAGE

public static final java.lang.String ERROR_PAGE
Element name 'error-page'.

See Also:
Constant Field Values

TAGLIB

public static final java.lang.String TAGLIB
Element name 'taglib'.

See Also:
Constant Field Values

RESOURCE_ENV_REF

public static final java.lang.String RESOURCE_ENV_REF
Element name 'resource-env-ref'.

See Also:
Constant Field Values

RESOURCE_REF

public static final java.lang.String RESOURCE_REF
Element name 'resource-ref'.

See Also:
Constant Field Values

SECURITY_CONSTRAINT

public static final java.lang.String SECURITY_CONSTRAINT
Element name 'security-constraint'.

See Also:
Constant Field Values

WEB_RESOURCE_COLLECTION

public static final java.lang.String WEB_RESOURCE_COLLECTION
Element name 'web-resource-collection'.

See Also:
Constant Field Values

WEB_RESOURCE_NAME

public static final java.lang.String WEB_RESOURCE_NAME
Element name 'web-resource-name'.

See Also:
Constant Field Values

AUTH_CONSTRAINT

public static final java.lang.String AUTH_CONSTRAINT
Element name 'auth-constraint'.

See Also:
Constant Field Values

LOGIN_CONFIG

public static final java.lang.String LOGIN_CONFIG
Element name 'login-config'.

See Also:
Constant Field Values

AUTH_METHOD

public static final java.lang.String AUTH_METHOD
Element name 'auth-method'.

See Also:
Constant Field Values

REALM_NAME

public static final java.lang.String REALM_NAME
Element name 'realm-name'.

See Also:
Constant Field Values

SECURITY_ROLE

public static final java.lang.String SECURITY_ROLE
Element name 'security-role'.

See Also:
Constant Field Values

ROLE_NAME

public static final java.lang.String ROLE_NAME
Element name 'role-name'.

See Also:
Constant Field Values

ENV_ENTRY

public static final java.lang.String ENV_ENTRY
Element name 'env-entry'.

See Also:
Constant Field Values

EJB_REF

public static final java.lang.String EJB_REF
Element name 'ejb-ref'.

See Also:
Constant Field Values

EJB_LOCAL_REF

public static final java.lang.String EJB_LOCAL_REF
Element name 'ejb-local-ref'.

See Also:
Constant Field Values

EJB_REF_NAME

public static final java.lang.String EJB_REF_NAME
Element name 'ejb-ref-name'.

See Also:
Constant Field Values

EJB_REF_TYPE

public static final java.lang.String EJB_REF_TYPE
Element name 'ejb-ref-type'.

See Also:
Constant Field Values

LOCAL

public static final java.lang.String LOCAL
Element name 'local'.

See Also:
Constant Field Values

LOCAL_HOME

public static final java.lang.String LOCAL_HOME
Element name 'local-home'.

See Also:
Constant Field Values

REMOTE

public static final java.lang.String REMOTE
Element name 'remote'.

See Also:
Constant Field Values

HOME

public static final java.lang.String HOME
Element name 'home'.

See Also:
Constant Field Values

EJB_LINK

public static final java.lang.String EJB_LINK
Element name 'local-home'.

See Also:
Constant Field Values

DISPATCHER

public static final java.lang.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


Copyright © 2004-2011 Codehaus. All Rights Reserved.