Overview

Home
License
ASF
Project Policies
Downloads
Documentation
News Archive

Search

Community

Events
Get Involved
Committers
Mailing Lists
Discussion Forums
IRC
FAQ
Wiki
Found a Bug?
Service and Support
ASF Sponsorship
ASF Thanks!

Development

Javadoc
XML Schemas
Source Code
Coding Standards
Issue Tracker
Related Projects
Sample Applications

Subprojects

Development Tools
GBuild
GShell
XBean

Documentation for geronimo-tomcat-2.0.1

Schema Document Properties
Global Declarations
- Element: web-app
Global Definitions

Legend

Glossary

top

Schema Document Properties

Target Namespace	http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1
Version	1.1
Element and Attribute Namespaces	Global element and attribute declarations belong to this schema's target namespace. By default, local element declarations belong to this schema's target namespace. By default, local attribute declarations have no namespace.
Schema Composition	This schema imports schema(s) from the following namespace(s): http://geronimo.apache.org/xml/ns/naming-1.2 (at geronimo-naming-1.2.xsd) http://geronimo.apache.org/xml/ns/j2ee/application-2.0 (at geronimo-application-2.0.xsd) http://geronimo.apache.org/xml/ns/deployment-1.2 (at geronimo-module-1.2.xsd) http://geronimo.apache.org/xml/ns/geronimo-jaspi (at geronimo-jaspi.xsd)
Documentation	This is an XML Schema Definition for Geronimo tomcat web application deployment plan. In case the web application deployment plan is provided internally in the web archive, it should be named META-INF/geronimo-web.xml. In case the web application deployment plan is provided externally, the deployment descriptor can be named anything and provided to the deploy tool. Alternatively, it can be included in the EAR and referenced by an alt-dd element of the EAR deployment plan. All the web application deployment plan must specify the top level element as web-app with namespace specified as xmlns="http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1". The default location for this document is http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1

Declared Namespaces

Prefix	Namespace
xml	http://www.w3.org/XML/1998/namespace
tomcat	http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1
xs	http://www.w3.org/2001/XMLSchema
naming	http://geronimo.apache.org/xml/ns/naming-1.2
app	http://geronimo.apache.org/xml/ns/j2ee/application-2.0
sys	http://geronimo.apache.org/xml/ns/deployment-1.2
jaspi	http://geronimo.apache.org/xml/ns/geronimo-jaspi

Schema Component Representation

<xs:schema targetNamespace="http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1" elementFormDefault="qualified" attributeFormDefault="unqualified" version="1.1">

<xs:import namespace="http://geronimo.apache.org/xml/ns/naming-1.2" schemaLocation="geronimo-naming-1.2.xsd"/>

<xs:import namespace="http://geronimo.apache.org/xml/ns/j2ee/application-2.0" schemaLocation="geronimo-application-2.0.xsd"/>

<xs:import namespace="http://geronimo.apache.org/xml/ns/deployment-1.2" schemaLocation="geronimo-module-1.2.xsd"/>

<xs:import namespace="http://geronimo.apache.org/xml/ns/geronimo-jaspi" schemaLocation="geronimo-jaspi.xsd"/>

...

</xs:schema>

top

Global Declarations

Element: web-app

Name	web-app
Type	tomcat:web-appType
Nillable	no
Abstract	no
Documentation	The web-app element is the root of the deployment descriptor for a Geronimo tomcat web application. Note that the sub-elements of this element should be as in the given order in a sequence.

XML Instance Representation

<tomcat:web-app>

<sys:environment> ... </sys:environment> [0..1]

'Reference to environment element defined in imported \"geronimo-module-1.2.xsd\"'

<tomcat:module> tomcat:moduleType </tomcat:module> [0..*]

'An optional module element which defines various modules included in the web application archive and adds an optional alt-dd element defining a Geronimo specific deployment descriptor.'

<tomcat:context-root> xs:string </tomcat:context-root> [0..1]

'This is the first part of the URL used to access the web application. For example context-root of \"Sample-App\" will have URL of http://host:port/Sample-App\" and a context-root of \"/\" would make this the default web application to the server. If the web application is packaged as an EAR that can use application context in the \"application.xml\". This element is necessary unless you want context root to default to the WAR name.'

<tomcat:work-dir> xs:string </tomcat:work-dir> [0..1]

'This is the work directory that will be used by this application. The directory location will be relative to \"catalina.home\".'

<app:clustering> ... </app:clustering> [0..1]

'Reference to abstract clustering element defined in imported \"geronimo-application-2.0.xsd\"'

<naming:web-container> ... </naming:web-container> [0..1]

'Reference to web-container element defined in imported \"geronimo-naming-1.2.xsd\"'

<tomcat:host> xs:string </tomcat:host> [0..1]

'The host element maps the web application to this particular host name.'

<tomcat:cross-context> tomcat:emptyType </tomcat:cross-context> [0..1]

'The cross-context is an indicative element to specify that the web application will use dispatch request to other applications and this cross context should be enabled.'

<tomcat:disable-cookies> tomcat:emptyType </tomcat:disable-cookies> [0..1]

'The presence of disable-cookies element indicates the cookies will not be used by tomcat web application and should be disabled.'

<tomcat:context> tomcat:contextType </tomcat:context> [0..1]

'The context element provides the same function as used in Tomcat, it supports context level attributes and context parameters.'

<tomcat:valve-chain> xs:string </tomcat:valve-chain> [0..1]

'The valve-chain provides the list of first element tomcat valves chain for this web application.'

<tomcat:listener-chain> xs:string </tomcat:listener-chain> [0..1]

'The listener-chain provides the list of first element tomcat lifecycle listener chain for this web application.'

<tomcat:tomcat-realm> xs:string </tomcat:tomcat-realm> [0..1]

'The tomcat-realm provides the tomcat security realm used by this web application.'

<tomcat:manager> xs:string </tomcat:manager> [0..1]

'The manager provides the clustering implementation used by this web application.'

<tomcat:cluster> xs:string </tomcat:cluster> [0..1]

'The cluster provides the name of cluster this web application belongs to.'

Model group reference (not shown): naming:jndiEnvironmentRefsGroup [1]

'Reference to jndiEnvironmentRefsGroup group defined in imported \"geronimo-naming-1.2.xsd\"'

<naming:message-destination> ... </naming:message-destination> [0..*]

'Reference to message-destination element defined in imported \"geronimo-naming-1.2.xsd\"'

Start Sequence [0..1]

<tomcat:security-realm-name> xs:string </tomcat:security-realm-name> [1]

'The security-realm-name element provides the name of security realm that will be used by JAAS authentication. The name should match the your security realm GBean.'

<tomcat:authentication> tomcat:authenticationType </tomcat:authentication> [0..1]

'The authentication element provides configuration for a specific jaspi AuthConfigProvider, ServerAuthConfig, ServerAuthContext, or ServerAuthModule to be used for authentication rather than a standard authentication method configured in web.xml.'

<app:security> ... </app:security> [0..1]

'Reference to security element defined in imported \"geronimo-security-2.0.xsd\"'

End Sequence
Start Choice [0..*]

<sys:service> ... </sys:service> [1]

'Reference to abstract service element defined in imported \"geronimo-module-1.2.xsd\"'

Allow any elements from the following namespace(s): http://java.sun.com/xml/ns/persistence (strict validation). [1]

End Choice
</tomcat:web-app>

Diagram

Schema Component Representation

<xs:element name="web-app" type=" tomcat:web-appType "/>

top

Global Definitions

Complex Type: authenticationType

Super-types:	None
Sub-types:	None

Name	authenticationType
Used by (from the same schema document)	Complex Type web-appType
Abstract	no

XML Instance Representation

<...>
Start Choice [0..1]

<jaspi:configProvider> ... </jaspi:configProvider> [1]

<jaspi:serverAuthConfig> ... </jaspi:serverAuthConfig> [1]

<jaspi:serverAuthContext> ... </jaspi:serverAuthContext> [1]

<jaspi:serverAuthModule> ... </jaspi:serverAuthModule> [1]

End Choice
</...>

Diagram

Schema Component Representation

<xs:complexType name="authenticationType">

<xs:choice minOccurs="0">

<xs:element ref=" jaspi:configProvider "/>

<xs:element ref=" jaspi:serverAuthConfig "/>

<xs:element ref=" jaspi:serverAuthContext "/>

<xs:element ref=" jaspi:serverAuthModule "/>

</xs:choice>

</xs:complexType>

top

Complex Type: contextType

Super-types:	None
Sub-types:	None

Name	contextType
Used by (from the same schema document)	Complex Type web-appType
Abstract	no

XML Instance Representation

<...

Allow any attributes from any namespace (skip validation).

<tomcat:parameter> tomcat:parameterType </tomcat:parameter> [0..*]

</...>

Diagram

Schema Component Representation

<xs:complexType name="contextType">

<xs:sequence>

<xs:element name="parameter" type=" tomcat:parameterType " minOccurs="0" maxOccurs="unbounded"/>

</xs:sequence>

<xs:anyAttribute processContents="skip"/>

</xs:complexType>

top

Complex Type: emptyType

Super-types:	None
Sub-types:	None

Name	emptyType
Used by (from the same schema document)	Complex Type web-appType , Complex Type web-appType
Abstract	no

XML Instance Representation

<.../>

Diagram

Schema Component Representation

<xs:complexType name="emptyType"/>

top

Complex Type: moduleType

Super-types:	None
Sub-types:	None

Name	moduleType
Used by (from the same schema document)	Complex Type web-appType
Abstract	no
Documentation	add an optional alt-dd element defining a Geronimo specific deployment descriptor for war ejb module.

XML Instance Representation

<...>
Start Choice [1]

<tomcat:ejb> tomcat:pathType </tomcat:ejb> [1]

'The presence of this element is indicative of J2EE module type to be EJB module'

End Choice
Start Choice [1]

<tomcat:alt-dd> tomcat:pathType </tomcat:alt-dd> [1]

'Specifies an optional URI to the post-assembly version of the Geronimo specific deployment descriptor file for a particular J2EE module relative to the enterprise application package main directory.'

Allow any elements from a namespace other than this schema's namespace (lax validation). [1]

End Choice
</...>

Diagram

Schema Component Representation

<xs:complexType name="moduleType">

<xs:sequence>

<xs:choice>

<xs:element name="ejb" type=" tomcat:pathType "/>

</xs:choice>

<xs:choice>

<xs:element name="alt-dd" type=" tomcat:pathType "/>

<xs:any namespace="##other" processContents="lax"/>

</xs:choice>

</xs:sequence>

</xs:complexType>

top

Complex Type: parameterType

Super-types:	None
Sub-types:	None

Name	parameterType
Used by (from the same schema document)	Complex Type contextType
Abstract	no

XML Instance Representation

<...
name=" xs:string [0..1]"
value=" xs:string [0..1]"
override=" xs:boolean [0..1]"/>

Diagram

Schema Component Representation

<xs:complexType name="parameterType">

<xs:attribute name="name" type=" xs:string "/>

<xs:attribute name="value" type=" xs:string "/>

<xs:attribute name="override" type=" xs:boolean " default="false"/>

</xs:complexType>

top

Complex Type: pathType

Super-types:	xs:token < string (by extension) < pathType (by restriction)
Sub-types:	None

Name	pathType
Used by (from the same schema document)	Complex Type moduleType , Complex Type moduleType
Abstract	no
Documentation	Mirrors j2ee:pathType.

XML Instance Representation

<...
id=" xs:ID [0..1]">
tomcat:string
</...>

Diagram

Schema Component Representation

<xs:complexType name="pathType">

<xs:simpleContent>

<xs:restriction base=" tomcat:string "/>

</xs:simpleContent>

</xs:complexType>

top

Complex Type: string

Super-types:	xs:token < string (by extension)
Sub-types:	None

Name	string
Abstract	no
Documentation	Mirrors j2ee:string.

XML Instance Representation

<...
id=" xs:ID [0..1]">
xs:token
</...>

Diagram

Schema Component Representation

<xs:complexType name="string">

<xs:simpleContent>

<xs:extension base=" xs:token ">

<xs:attribute name="id" type=" xs:ID "/>

</xs:extension>

</xs:simpleContent>

</xs:complexType>

top

Complex Type: web-appType

Super-types:	None
Sub-types:	None

Name	web-appType
Used by (from the same schema document)	Element web-app
Abstract	no

XML Instance Representation

<...>

<sys:environment> ... </sys:environment> [0..1]

'Reference to environment element defined in imported \"geronimo-module-1.2.xsd\"'

<tomcat:module> tomcat:moduleType </tomcat:module> [0..*]

'An optional module element which defines various modules included in the web application archive and adds an optional alt-dd element defining a Geronimo specific deployment descriptor.'

<tomcat:context-root> xs:string </tomcat:context-root> [0..1]

<tomcat:work-dir> xs:string </tomcat:work-dir> [0..1]

'This is the work directory that will be used by this application. The directory location will be relative to \"catalina.home\".'

<app:clustering> ... </app:clustering> [0..1]

'Reference to abstract clustering element defined in imported \"geronimo-application-2.0.xsd\"'

<naming:web-container> ... </naming:web-container> [0..1]

'Reference to web-container element defined in imported \"geronimo-naming-1.2.xsd\"'

<tomcat:host> xs:string </tomcat:host> [0..1]

'The host element maps the web application to this particular host name.'

<tomcat:cross-context> tomcat:emptyType </tomcat:cross-context> [0..1]

'The cross-context is an indicative element to specify that the web application will use dispatch request to other applications and this cross context should be enabled.'

<tomcat:disable-cookies> tomcat:emptyType </tomcat:disable-cookies> [0..1]

'The presence of disable-cookies element indicates the cookies will not be used by tomcat web application and should be disabled.'

<tomcat:context> tomcat:contextType </tomcat:context> [0..1]

'The context element provides the same function as used in Tomcat, it supports context level attributes and context parameters.'

<tomcat:valve-chain> xs:string </tomcat:valve-chain> [0..1]

'The valve-chain provides the list of first element tomcat valves chain for this web application.'

<tomcat:listener-chain> xs:string </tomcat:listener-chain> [0..1]

'The listener-chain provides the list of first element tomcat lifecycle listener chain for this web application.'

<tomcat:tomcat-realm> xs:string </tomcat:tomcat-realm> [0..1]

'The tomcat-realm provides the tomcat security realm used by this web application.'

<tomcat:manager> xs:string </tomcat:manager> [0..1]

'The manager provides the clustering implementation used by this web application.'

<tomcat:cluster> xs:string </tomcat:cluster> [0..1]

'The cluster provides the name of cluster this web application belongs to.'

Model group reference (not shown): naming:jndiEnvironmentRefsGroup [1]

'Reference to jndiEnvironmentRefsGroup group defined in imported \"geronimo-naming-1.2.xsd\"'

<naming:message-destination> ... </naming:message-destination> [0..*]

'Reference to message-destination element defined in imported \"geronimo-naming-1.2.xsd\"'

Start Sequence [0..1]

<tomcat:security-realm-name> xs:string </tomcat:security-realm-name> [1]

'The security-realm-name element provides the name of security realm that will be used by JAAS authentication. The name should match the your security realm GBean.'

<tomcat:authentication> tomcat:authenticationType </tomcat:authentication> [0..1]

<app:security> ... </app:security> [0..1]

'Reference to security element defined in imported \"geronimo-security-2.0.xsd\"'

End Sequence
Start Choice [0..*]

<sys:service> ... </sys:service> [1]

'Reference to abstract service element defined in imported \"geronimo-module-1.2.xsd\"'

Allow any elements from the following namespace(s): http://java.sun.com/xml/ns/persistence (strict validation). [1]

End Choice
</...>

Diagram

Schema Component Representation

<xs:complexType name="web-appType">

<xs:sequence>

<xs:element ref=" sys:environment " minOccurs="0"/>

<xs:element name="module" type=" tomcat:moduleType " minOccurs="0" maxOccurs="unbounded"/>

<xs:element name="context-root" type=" xs:string " minOccurs="0"/>

<xs:element name="work-dir" type=" xs:string " minOccurs="0"/>

<xs:element ref=" app:clustering " minOccurs="0"/>

<--<xs:element name="context-priority-classloader" type="xs:boolean" minOccurs="0"/>-->

<xs:element ref=" naming:web-container " minOccurs="0"/>

<xs:element name="host" type=" xs:string " minOccurs="0"/>

<xs:element name="cross-context" type=" tomcat:emptyType " minOccurs="0"/>

<xs:element name="disable-cookies" type=" tomcat:emptyType " minOccurs="0"/>

<xs:element name="context" type=" tomcat:contextType " minOccurs="0"/>

<xs:element name="valve-chain" type=" xs:string " minOccurs="0"/>

<xs:element name="listener-chain" type=" xs:string " minOccurs="0"/>

<xs:element name="tomcat-realm" type=" xs:string " minOccurs="0"/>

<xs:element name="manager" type=" xs:string " minOccurs="0"/>

<xs:element name="cluster" type=" xs:string " minOccurs="0"/>

<xs:group ref=" naming:jndiEnvironmentRefsGroup "/>

<xs:element ref=" naming:message-destination " minOccurs="0" maxOccurs="unbounded"/>

<xs:sequence minOccurs="0">

<xs:element name="security-realm-name" type=" xs:string "/>

<xs:element name="authentication" type=" tomcat:authenticationType " minOccurs="0"/>

<xs:element ref=" app:security " minOccurs="0"/>

</xs:sequence>

<xs:choice minOccurs="0" maxOccurs="unbounded">

<xs:element ref=" sys:service "/>

<xs:any namespace="http://java.sun.com/xml/ns/persistence"/>

</xs:choice>

</xs:sequence>

</xs:complexType>

top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name

Super-types:	Address < AusAddress (by extension)
Sub-types:	QLDAddress (by restriction)

If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.

Name	AusAddress
Abstract	no

The table above displays the properties of this schema component.

XML Instance Representation

<... country="Australia" >
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1]
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. [0..1].
Model group information are shown in gray, e.g. Start Choice ... End Choice.
For type derivations, the elements and attributes that have been added to or changed from the base type's content are shown in bold.
If an element/attribute has a fixed value, the fixed value is shown in green, e.g. country="Australia".
Otherwise, the type of the element/attribute is displayed.
- If the element/attribute's type is in the schema, a link is provided to it.
- For local simple type definitions, the constraints are displayed in angle brackets, e.g. <<pattern = [1-9][0-9]{3}>>.

Schema Component Representation

The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)

top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top

Documentation for geronimo-tomcat-2.0.1

Table of Contents

Schema Document Properties

Declared Namespaces

Global Declarations

Element: web-app

Global Definitions

Complex Type: authenticationType

Complex Type: contextType

Complex Type: emptyType

Complex Type: moduleType

Complex Type: parameterType

Complex Type: pathType

Complex Type: string

Complex Type: web-appType

Legend

Complex Type:

AusAddress

Glossary