geronimo-web-1.1.xsd

Introduction

Geronimo includes a web application container supporting J2EE web applications.The web container itself supports basic configuration such as network ports and SSL options,and each web application WAR may include Geronimo-Configuration information as well.Geronimo deployment plans are defined by XML Schemas and not Document Type Definitions (DTDs). Though the basic structure XML file remains the same the header of the XML file controlled by the schema looks slightly different than one that is controlled by DTD.The following schema represents the Geronimo deployment plan for a web application. The deployment plan always uses the Geronimo web namespace, and it also requires elements from the Geronimo Naming namespace. Additionally, it has a required attribute to identify its configuration name, and an optional attribute to select a parent configuration.This is the Geronimo XML Schema document for the Servlet 2.4 based deployment descriptor.The deployment descriptor must be named "WEB-INF/geronimo-web.xml" in the web application's war file.

The following article is organized into the following sections : -

Geronimo Web Schema Document

http://geronimo.apache.org/schemas-1.1/geronimo-web-1.1.xsd

geronimo-web-1.1.xsd

<?xml version="1.0" encoding="UTF-8"?>
<!--

    Copyright 2004-2005 The Apache Software Foundation

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
-->
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
targetNamespace="http://geronimo.apache.org/xml/ns/j2ee/web-1.1" version="1.0" 
xmlns:naming="http://geronimo.apache.org/xml/ns/naming-1.1" xmlns:security="http://geronimo.apache.org/xml/ns/security-1.1"
xmlns:sys="http://geronimo.apache.org/xml/ns/deployment-1.1" 
xmlns:web="http://geronimo.apache.org/xml/ns/j2ee/web-1.1" 
xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:import namespace="http://geronimo.apache.org/xml/ns/naming-1.1" schemaLocation="geronimo-naming-1.1.xsd"/>
  <xs:import namespace="http://geronimo.apache.org/xml/ns/security-1.1" schemaLocation="geronimo-security-1.1.xsd"/>
  <xs:import namespace="http://geronimo.apache.org/xml/ns/deployment-1.1" schemaLocation="geronimo-module-1.1.xsd"/>
  <xs:element name="web-app" type="web:web-appType">
	<xsd:annotation>
		<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. 			  
		 </xsd:documentation>
    </xsd:annotation>
  </xs:element>
	  
	  
  <xs:complexType name="web-appType">
    <xs:sequence>
      <xs:element minOccurs="0" ref="sys:environment"/>
      <xs:element minOccurs="0" name="context-root" type="xs:string">
	      <xsd:annotation>
		      <xsd:documentation>			  
			      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 one can use application context
in the "application.xml". This element is necessary unless you want context root to default to the WAR 
name.
		      </xsd:documentation>
    		</xsd:annotation>
      </xs:element>
      <xs:element minOccurs="0" ref="naming:web-container"/>
	     
      
      <xs:element minOccurs="0" name="container-config" type="web:container-configType">
		  <xsd:annotation>
			  <xsd:documentation>
				  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.
			  </xsd:documentation>
		  </xsd:annotation>
	  </xs:element>  
      <xs:group ref="naming:jndiEnvironmentRefsGroup"/>
      <xs:element maxOccurs="unbounded" minOccurs="0" ref="naming:message-destination"/>
      <xs:sequence minOccurs="0">
        <xs:element name="security-realm-name" type="xs:string">
			<xsd:annotation>
				<xsd:documentation>
					The name of the security realm that will authonticate user logins.
It should match the "name" specified for security realm GBean.
				</xsd:documentation>
			</xsd:annotation>
		</xs:element>
        <xs:element minOccurs="0" ref="security:security"/>
      </xs:sequence>
      <xs:element maxOccurs="unbounded" minOccurs="0" ref="sys:gbean"/>
    </xs:sequence>
    </xs:complexType>
    <xs:complexType name="container-configType">
		<xsd:annotation>
				<xsd:documentation>
					This element describes element type for container-config element. 
It describes container specific attributes which are valid for either Tomcat or Jetty container.
				</xsd:documentation>
			</xsd:annotation>
    <xs:sequence>
      <xs:any maxOccurs="unbounded" minOccurs="0" namespace="##other" processContents="lax"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

Schema Document Properties

Target Namespace	http://geronimo.apache.org/xml/ns/j2ee/web-1.1 All Servlet/Web geronimo specific deployment descriptors must indicate the web application schema by using the J2EE namespace
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): o http://geronimo.apache.org/xml/ns/naming-1.1 (at geronimo-naming-1.1.xsd) o http://geronimo.apache.org/xml/ns/security-1.1 (at geronimo-security-1.1.xsd) o http://geronimo.apache.org/xml/ns/deployment-1.1 (at geronimo-module-1.1.xsd)

Declared Namespaces

Prefix	Namespace
xml	http://www.w3.org/XML/1998/namespace
web	http://geronimo.apache.org/xml/ns/j2ee/web-1.1
naming	http://geronimo.apache.org/xml/ns/naming-1.1
security	http://geronimo.apache.org/xml/ns/security-1.1
sys	http://geronimo.apache.org/xml/ns/deployment-1.1
xs	http://www.w3.org/2001/XMLSchema

Schema Component Representation

<xs:schema
    targetNamespace="http://geronimo.apache.org/xml/ns/j2ee/web-1.1"
    elementFormDefault="qualified"
    attributeFormDefault="unqualified"
    <xs:import namespace="http://geronimo.apache.org/xml/ns/naming-1.1" schemaLocation="geronimo-naming-1.1.xsd"/>
    <xs:import namespace="http://geronimo.apache.org/xml/ns/security-1.1" schemaLocation="geronimo-security-1.1.xsd"/>
    <xs:import namespace="http://geronimo.apache.org/xml/ns/deployment-1.1" schemaLocation="geronimo-module-1.1.xsd"/>
    version="1.0">
    ...
</xs:schema>

Global Declarations

Element: web-app

Element:	web-app
Name	web-app
Type	web:web-appType
Nillable	no
Abstract	no
Documentation

XML Instance Representation: web-app

<web:web-app
configId=" xs:string [1]"
parentId=" xs:string [0..1]">
<sys:import> ... </sys:import> [0..*]
<sys:dependency> ... </sys:dependency> [0..*]
<web:context-root> xs:string </web:context-root> [0..1]
<web:context-priority-classloader> xs:boolean </web:context-priority-classloader> [0..1]
<web:container-config> web:container-configType </web:container-config> [0..1]
<naming:message-destination> ... </naming:message-destination> [0..*]
Start Sequence [0..1]
<web:security-realm-name> xs:string </web:security-realm-name> [1]
<security:security> ... </security:security> [0..1]
End Sequence
<sys:gbean> ... </sys:gbean> [0..*]
</web:web-app>

Schema Component Representation: web-app

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

Global Definitions

Complex Type: container-configType

Super-types:	None
Sub-types:	None

Name	container-configType
Abstract	No

XML Instance Representation: container-configType

<...>
Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*]
</...>

Schema Component Represenation: container-configType

<xs:complexType name="container-configType">
        <xs:sequence>
            <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
    </xs:complexType>

Complex Type: web-appType

Complex Type:	web-appType
Super-types:	None
Sub-types:	None
Name	web-appType
Abstract	No

XML Instance Representation: web-appType

<...
configId=" xs:string [1]"
parentId=" xs:string [0..1]">
<sys:import> ... </sys:import> [0..*]
<sys:dependency> ... </sys:dependency> [0..*]
<web:context-root> xs:string </web:context-root> [0..1]
<web:context-priority-classloader> xs:boolean </web:context-priority-classloader> [0..1]
<web:container-config> web:container-configType </web:container-config> [0..1]
<naming:message-destination> ... </naming:message-destination> [0..*]
Start Sequence [0..1]
<web:security-realm-name> xs:string </web:security-realm-name> [1]
<security:security> ... </security:security> [0..1]
End Sequence
<sys:gbean> ... </sys:gbean> [0..*]
</...>

Schema Component Representation: web-appType

<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="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="security:security" minOccurs="0"/>
            </xs:sequence>

            <xs:element ref="sys:gbean" minOccurs="0" maxOccurs="unbounded"/>

        </xs:sequence>
    </xs:complexType>

Legend

Complex Type:	AusAddress
Schema Component Type	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.
o If the element/attribute's type is in the schema, a link is provided to it.
o 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.)

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.