Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

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

Code Block
xml
xml
borderStylesolid
titlegeronimo-web-1.1.xsdxml
<?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>

...

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

Code Block
xml
xml
borderStylesolid
titleSchema Component Representationxml
<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>

...

Element:

web-app

Name

web-app

Type

web:web-appType

Nillable

no

Abstract

no

Documentation

Code Block
xml
xml
borderStylesolid
titleXML Instance Representation: web-appxml
<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>
Code Block
xml
xml
borderStylesolid
titleSchema Component Representation: web-appxml
<xs:element name="web-app" type="web:web-appType"/>

...

Name

container-configType

Abstract

No

Code Block
xml
xml
borderStylesolid
titleXML Instance Representation: container-configTypexml
<...>
Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*]
</...>
Code Block
xml
xml
borderStylesolid
titleSchema Component Represenation: container-configTypexml
 <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

Super-types:

None

Sub-types:

None

Name

web-appType

Abstract

No

Code Block
xml
xml
borderStylesolid
titleXML Instance Representation: web-appTypexml
<...
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..*]
</...>
Code Block
xml
xml
borderStylesolid
titleSchema Component Representation: web-appTypexml
 <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>

...

The table above displays the properties of this schema component.

Code Block
xml
xml
borderStylesolid
titleXML Instance Representationxml
<...    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 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>.
Code Block
xml
xml
borderStylesolid
titleSchema Component Representationxml
<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> 

...