Apache Geronimo >  Index >  Development >  XML Schemas >  Apache Geronimo v2.1 XML Schemas User List | Dev List | Wiki | Issue Tracker  
  Overview
Home
License
ASF
Project Policies
Downloads
Documentation
News Archive
  Search
Powered by Google 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
Apache Geronimo v2.1 XML Schemas   geronimo-tomcat-2.0.1.xsd 

Documentation for geronimo-web-2.0.1

Table of Contents

top

Schema Document Properties

Target Namespace http://geronimo.apache.org/xml/ns/j2ee/web-2.0.1
Version 1.0
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://java.sun.com/xml/ns/persistence (at http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd)
Documentation The web-app element is the root of the deployment descriptor for a Geronimo web application. Note that the sub-elements of this element should be as in the given order because it is defined as a sequence.

This group keeps the usage of the contained JNDI environment reference elements consistent across J2EE deployment descriptors.

Declared Namespaces

Prefix Namespace
xml http://www.w3.org/XML/1998/namespace
web http://geronimo.apache.org/xml/ns/j2ee/web-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
ee http://java.sun.com/xml/ns/persistence
Schema Component Representation
<xs:schema targetNamespace="http://geronimo.apache.org/xml/ns/j2ee/web-2.0.1" elementFormDefault="qualified" attributeFormDefault="unqualified" version="1.0">
<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://java.sun.com/xml/ns/persistence" schemaLocation="http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: web-app

Name web-app
Type web:web-appType
Nillable no
Abstract no
Logical Diagram
h1508775248 h-1890195131 h1355340165
XML Instance Representation
<web:web-app>
<sys:environment> ... </sys:environment> [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 be 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.'

<web:context-root> xs:string </web:context-root> [0..1]
<web:work-dir> xs:string </web:work-dir> [0..1]

'This is the work directory that will be used by this application. For Jetty this will be relative to jetty home which is var/jetty by default. For Tomcat this will be relative to \"catalina.home\".'

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

'Geronimo supports both Jetty and Tomcat web containers. This element is for a web application needs to take container specific settings. It can hold either a Tomcat element or a Jetty element or both.'

Model group reference (not shown): naming:jndiEnvironmentRefsGroup [1]
Start Sequence [0..1]
<web:security-realm-name> xs:string </web:security-realm-name> [1]
<app:security> ... </app:security> [0..1]
End Sequence
Start Choice [0..*]
<sys:service> ... </sys:service> [0..*]

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

End Choice
</web:web-app>
Diagram
h1508775248 h-1890195131 h1092042317 h-1558966411 h1355340165 h-2080266973 h85315698 h301147612
Schema Component Representation
<xs:element name="web-app" type=" web:web-appType "/>
top

Global Definitions

Complex Type: container-configType

Super-types: None
Sub-types: None
Name container-configType
Used by (from the same schema document) Complex Type web-appType
Abstract no
XML Instance Representation
<...>
Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*]
</...>
Diagram
Schema Component Representation
<xs:complexType name="container-configType">
<xs:sequence>
<xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</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]

'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 be 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.'

<web:context-root> xs:string </web:context-root> [0..1]
<web:work-dir> xs:string </web:work-dir> [0..1]

'This is the work directory that will be used by this application. For Jetty this will be relative to jetty home which is var/jetty by default. For Tomcat this will be relative to \"catalina.home\".'

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

'Geronimo supports both Jetty and Tomcat web containers. This element is for a web application needs to take container specific settings. It can hold either a Tomcat element or a Jetty element or both.'

Model group reference (not shown): naming:jndiEnvironmentRefsGroup [1]
Start Sequence [0..1]
<web:security-realm-name> xs:string </web:security-realm-name> [1]
<app:security> ... </app:security> [0..1]
End Sequence
Start Choice [0..*]
<sys:service> ... </sys:service> [0..*]

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

End Choice
</...>
Diagram
h1508775248 h-1890195131 h1092042317 h-1558966411 h1355340165 h-2080266973 h85315698 h301147612
Schema Component Representation
<xs:complexType name="web-appType">
<xs:sequence>
<xs:element ref=" sys:environment " minOccurs="0"/>
<xs:element name="context-root" type=" xs:string " minOccurs="0"/>
<xs:element name="work-dir" type=" xs:string " minOccurs="0"/>
<--<xs:element name="context-priority-classloader" type="xs:boolean" minOccurs="0"/>-->
<xs:element ref=" naming:web-container " minOccurs="0"/>
<xs:element name="container-config" type=" web:container-configType " 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 ref=" app:security " minOccurs="0"/>
</xs:sequence>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref=" sys:service " minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref=" ee: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}>>.
  • If a local element/attribute has documentation, it will be displayed in a window that pops up when the question mark inside the attribute or next to the element is clicked, e.g. <postcode>.
Schema Component Representation
<complexType name="AusAddress">
<complexContent>
<extension base=" Address ">
<sequence>
<element name="state" type=" AusStates "/>
<element name="postcode">
<simpleType>
<restriction base=" string ">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="country" type=" string " fixed="Australia"/>
</extension>
</complexContent>
</complexType>
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

Generated by <oXygen/> XML Editor using a modified version of xs3p that adds schema diagrams and chunking support. Last modified:

Copyright © 2003-2008, The Apache Software Foundation