Showing:

Annotations
Attributes
Diagrams
Facets
Instances
Properties
Source
Used by

Table of Contents

Group by:

http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1

http://java.sun.com/xml/ns/persistence

Main schema geronimo-tomcat-2.0.1.xsd
Namespace http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1
Annotations
 
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
Properties
attribute form default: unqualified
element form default: qualified
version: 1.1
[ top ]
Imported schema persistence_1_0.xsd
Namespace http://java.sun.com/xml/ns/persistence
Annotations
 
@(#)persistence_1_0.xsd  1.0  Feb 9 2006
 
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

      Copyright 2005-2007 Sun Microsystems, Inc. All rights reserved.

      The contents of this file are subject to the terms of either the
      GNU General Public License Version 2 only ("GPL") or the Common
      Development and Distribution License("CDDL") (collectively, the
      "License").  You may not use this file except in compliance with
      the License. You can obtain a copy of the License at
      https://glassfish.dev.java.net/public/CDDL+GPL.html or
      glassfish/bootstrap/legal/LICENSE.txt.  See the License for the
      specific language governing permissions and limitations under the
      License.

      When distributing the software, include this License Header
      Notice in each file and include the License file at
      glassfish/bootstrap/legal/LICENSE.txt.  Sun designates this
      particular file as subject to the "Classpath" exception as
      provided by Sun in the GPL Version 2 section of the License file
      that accompanied this code.  If applicable, add the following
      below the License Header, with the fields enclosed by brackets []
      replaced by your own identifying information:
      "Portions Copyrighted [year] [name of copyright owner]"

      Contributor(s):

      If you wish your version of this file to be governed by only the
      CDDL or only the GPL Version 2, indicate your decision by adding
      "[Contributor] elects to include this software in this
      distribution under the [CDDL or GPL Version 2] license."  If you
      don't indicate a single choice of license, a recipient has the
      option to distribute your version of this file under either the
      CDDL, the GPL Version 2 or to extend the choice of license to its
      licensees as provided above.  However, if you add GPL Version 2
      code and therefore, elected the GPL Version 2 license, then the
      option applies only if the new code is made subject to such
      option by the copyright holder.
 
This is the XML Schema for the persistence configuration file.
     The file must be named "META-INF/persistence.xml" in the 
     persistence archive.
     Persistence configuration files must indicate
     the persistence schema by using the persistence namespace:

     http://java.sun.com/xml/ns/persistence

     and indicate the version of the schema by
     using the version element as shown below:

      <persistence xmlns="http://java.sun.com/xml/ns/persistence"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://java.sun.com/xml/ns/persistence
          http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd"
        version="1.0">
          ...
      </persistence>
Properties
attribute form default: unqualified
element form default: qualified
version: 1.0
[ top ]
Element tomcat:web-app
Namespace http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1
Annotations
 
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.
Diagram
Diagram geronimo-tomcat-2.0.1.tmp#id5 geronimo-tomcat-2.0.1.tmp#id6 geronimo-tomcat-2.0.1.tmp#id9 geronimo-tomcat-2.0.1.tmp#id10 geronimo-tomcat-2.0.1.tmp#id12 geronimo-tomcat-2.0.1.tmp#id13 geronimo-tomcat-2.0.1.tmp#id14 geronimo-tomcat-2.0.1.tmp#id15 geronimo-tomcat-2.0.1.tmp#id16 geronimo-tomcat-2.0.1.tmp#id17 geronimo-tomcat-2.0.1.tmp#id19 geronimo-tomcat-2.0.1.tmp#id22 geronimo-tomcat-2.0.1.tmp#id3
Type tomcat:web-appType
Properties
content: complex
Model environment{0,1} , tomcat:context-root{0,1} , tomcat:work-dir{0,1} , clustering{0,1} , web-container{0,1} , tomcat:host{0,1} , tomcat:cross-context{0,1} , tomcat:disable-cookies{0,1} , tomcat:valve-chain{0,1} , tomcat:listener-chain{0,1} , tomcat:tomcat-realm{0,1} , tomcat:manager{0,1} , tomcat:cluster{0,1} , message-destination* , tomcat:security-realm-name , security{0,1} , (service* | persistence:persistence)
Children clustering, environment, message-destination, persistence:persistence, security, service, tomcat:cluster, tomcat:context-root, tomcat:cross-context, tomcat:disable-cookies, tomcat:host, tomcat:listener-chain, tomcat:manager, tomcat:security-realm-name, tomcat:tomcat-realm, tomcat:valve-chain, tomcat:work-dir, web-container
Instance
 
<tomcat:web-app>
  <environment>{0,1}</environment>
  <tomcat:context-root>{0,1}</tomcat:context-root>
  <tomcat:work-dir>{0,1}</tomcat:work-dir>
  <clustering>{0,1}</clustering>
  <web-container>{0,1}</web-container>
  <tomcat:host>{0,1}</tomcat:host>
  <tomcat:cross-context>{0,1}</tomcat:cross-context>
  <tomcat:disable-cookies>{0,1}</tomcat:disable-cookies>
  <tomcat:valve-chain>{0,1}</tomcat:valve-chain>
  <tomcat:listener-chain>{0,1}</tomcat:listener-chain>
  <tomcat:tomcat-realm>{0,1}</tomcat:tomcat-realm>
  <tomcat:manager>{0,1}</tomcat:manager>
  <tomcat:cluster>{0,1}</tomcat:cluster>
  <message-destination>{0,unbounded}</message-destination>
</tomcat:web-app>
Source
 
<xs:element name="web-app" type="tomcat:web-appType">
  <xs:annotation>
    <xs: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.</xs:documentation>
  </xs:annotation>
</xs:element>
[ top ]
Element tomcat:web-appType / tomcat:context-root
Namespace http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1
Annotations
 
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.
Diagram
Diagram
Type xs:string
Properties
content: simple
minOccurs: 0
Source
 
<xs:element name="context-root" type="xs:string" minOccurs="0">
  <xs:annotation>
    <xs: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 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.</xs:documentation>
  </xs:annotation>
</xs:element>
[ top ]
Element tomcat:web-appType / tomcat:work-dir
Namespace http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1
Annotations
 
This is the work directory that will be used by this
application.  The directory location will be relative
to "catalina.home".
Diagram
Diagram
Type xs:string
Properties
content: simple
minOccurs: 0
Source
 
<xs:element name="work-dir" type="xs:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>This is the work directory that will be used by this
                        application.  The directory location will be relative
                        to "catalina.home".</xs:documentation>
  </xs:annotation>
</xs:element>
[ top ]
Element tomcat:web-appType / tomcat:host
Namespace http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1
Annotations
 
The host element maps the web application to this
particular host name.
Diagram
Diagram
Type xs:string
Properties
content: simple
minOccurs: 0
Source
 
<xs:element name="host" type="xs:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>The host element maps the web application to this
                        particular host name.</xs:documentation>
  </xs:annotation>
</xs:element>
[ top ]
Element tomcat:web-appType / tomcat:cross-context
Namespace http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1
Annotations
 
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.
Diagram
Diagram geronimo-tomcat-2.0.1.tmp#id11
Type tomcat:emptyType
Properties
content: complex
minOccurs: 0
Source
 
<xs:element name="cross-context" type="tomcat:emptyType" minOccurs="0">
  <xs:annotation>
    <xs:documentation>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.</xs:documentation>
  </xs:annotation>
</xs:element>
[ top ]
Element tomcat:web-appType / tomcat:disable-cookies
Namespace http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1
Annotations
 
The presence of disable-cookies element indicates the
cookies will not be used by tomcat web application and
should be disabled.
Diagram
Diagram geronimo-tomcat-2.0.1.tmp#id11
Type tomcat:emptyType
Properties
content: complex
minOccurs: 0
Source
 
<xs:element name="disable-cookies" type="tomcat:emptyType" minOccurs="0">
  <xs:annotation>
    <xs:documentation>The presence of disable-cookies element indicates the
                        cookies will not be used by tomcat web application and
                        should be disabled.</xs:documentation>
  </xs:annotation>
</xs:element>
[ top ]
Element tomcat:web-appType / tomcat:valve-chain
Namespace http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1
Annotations
 
The valve-chain provides the list of first element
tomcat valves chain for this web application.
Diagram
Diagram
Type xs:string
Properties
content: simple
minOccurs: 0
Source
 
<xs:element name="valve-chain" type="xs:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>The valve-chain provides the list of first element
                        tomcat valves chain for this web application.</xs:documentation>
  </xs:annotation>
</xs:element>
[ top ]
Element tomcat:web-appType / tomcat:listener-chain
Namespace http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1
Annotations
 
The listener-chain provides the list of first element
tomcat lifecycle listener chain for this web application.
Diagram
Diagram
Type xs:string
Properties
content: simple
minOccurs: 0
Source
 
<xs:element name="listener-chain" type="xs:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>The listener-chain provides the list of first element
                        tomcat lifecycle listener chain for this web application.</xs:documentation>
  </xs:annotation>
</xs:element>
[ top ]
Element tomcat:web-appType / tomcat:tomcat-realm
Namespace http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1
Annotations
 
The tomcat-realm provides the tomcat security realm used
by this web application.
Diagram
Diagram
Type xs:string
Properties
content: simple
minOccurs: 0
Source
 
<xs:element name="tomcat-realm" type="xs:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>The tomcat-realm provides the tomcat security realm used
                        by this web application.</xs:documentation>
  </xs:annotation>
</xs:element>
[ top ]
Element tomcat:web-appType / tomcat:manager
Namespace http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1
Annotations
 
The manager provides the clustering implementation used
by this web application.
Diagram
Diagram
Type xs:string
Properties
content: simple
minOccurs: 0
Source
 
<xs:element name="manager" type="xs:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>The manager provides the clustering implementation used
                        by this web application.</xs:documentation>
  </xs:annotation>
</xs:element>
[ top ]
Element tomcat:web-appType / tomcat:cluster
Namespace http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1
Annotations
 
The cluster provides the name of cluster this web
application belongs to.
Diagram
Diagram
Type xs:string
Properties
content: simple
minOccurs: 0
Source
 
<xs:element name="cluster" type="xs:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>The cluster provides the name of cluster this web
                        application belongs to.</xs:documentation>
  </xs:annotation>
</xs:element>
[ top ]
Element tomcat:web-appType / tomcat:security-realm-name
Namespace http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1
Annotations
 
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.
Diagram
Diagram
Type xs:string
Properties
content: simple
Source
 
<xs:element name="security-realm-name" type="xs:string">
  <xs:annotation>
    <xs:documentation>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.</xs:documentation>
  </xs:annotation>
</xs:element>
[ top ]
Element persistence:persistence
Namespace http://java.sun.com/xml/ns/persistence
Diagram
Diagram geronimo-tomcat-2.0.1.tmp#id39 geronimo-tomcat-2.0.1.tmp#id23
Properties
content: complex
Used by
Complex Type tomcat:web-appType
Model persistence:persistence-unit*
Children persistence:persistence-unit
Instance
 
<persistence:persistence version="1.0">
  <persistence:persistence-unit name="" transaction-type="">{0,unbounded}</persistence:persistence-unit>
</persistence:persistence>
Attributes
QName Type Fixed Default Use Annotation
version persistence:versionType 1.0 required
Source
 
<xsd:element name="persistence">
  <xsd:complexType>
    <xsd:sequence>
      <!-- **************************************************** -->
      <xsd:element name="persistence-unit" minOccurs="0" maxOccurs="unbounded">
        <xsd:complexType>
          <xsd:annotation>
            <xsd:documentation>Configuration of a persistence unit.</xsd:documentation>
          </xsd:annotation>
          <xsd:sequence>
            <!-- **************************************************** -->
            <xsd:element name="description" type="xsd:string" minOccurs="0">
              <xsd:annotation>
                <xsd:documentation>Textual description of this persistence unit.</xsd:documentation>
              </xsd:annotation>
            </xsd:element>
            <!-- **************************************************** -->
            <xsd:element name="provider" type="xsd:string" minOccurs="0">
              <xsd:annotation>
                <xsd:documentation>Provider class that supplies EntityManagers for this 
                    persistence unit.</xsd:documentation>
              </xsd:annotation>
            </xsd:element>
            <!-- **************************************************** -->
            <xsd:element name="jta-data-source" type="xsd:string" minOccurs="0">
              <xsd:annotation>
                <xsd:documentation>The container-specific name of the JTA datasource to use.</xsd:documentation>
              </xsd:annotation>
            </xsd:element>
            <!-- **************************************************** -->
            <xsd:element name="non-jta-data-source" type="xsd:string" minOccurs="0">
              <xsd:annotation>
                <xsd:documentation>The container-specific name of a non-JTA datasource to use.</xsd:documentation>
              </xsd:annotation>
            </xsd:element>
            <!-- **************************************************** -->
            <xsd:element name="mapping-file" type="xsd:string" minOccurs="0" maxOccurs="unbounded">
              <xsd:annotation>
                <xsd:documentation>File containing mapping information. Loaded as a resource 
                    by the persistence provider.</xsd:documentation>
              </xsd:annotation>
            </xsd:element>
            <!-- **************************************************** -->
            <xsd:element name="jar-file" type="xsd:string" minOccurs="0" maxOccurs="unbounded">
              <xsd:annotation>
                <xsd:documentation>Jar file that should be scanned for entities. 
                    Not applicable to Java SE persistence units.</xsd:documentation>
              </xsd:annotation>
            </xsd:element>
            <!-- **************************************************** -->
            <xsd:element name="class" type="xsd:string" minOccurs="0" maxOccurs="unbounded">
              <xsd:annotation>
                <xsd:documentation>Class to scan for annotations.  It should be annotated 
                    with either @Entity, @Embeddable or @MappedSuperclass.</xsd:documentation>
              </xsd:annotation>
            </xsd:element>
            <!-- **************************************************** -->
            <xsd:element name="exclude-unlisted-classes" type="xsd:boolean" default="false" minOccurs="0">
              <xsd:annotation>
                <xsd:documentation>When set to true then only listed classes and jars will 
                    be scanned for persistent classes, otherwise the enclosing 
                    jar or directory will also be scanned. Not applicable to 
                    Java SE persistence units.</xsd:documentation>
              </xsd:annotation>
            </xsd:element>
            <!-- **************************************************** -->
            <xsd:element name="properties" minOccurs="0">
              <xsd:annotation>
                <xsd:documentation>A list of vendor-specific properties.</xsd:documentation>
              </xsd:annotation>
              <xsd:complexType>
                <xsd:sequence>
                  <xsd:element name="property" minOccurs="0" maxOccurs="unbounded">
                    <xsd:annotation>
                      <xsd:documentation>A name-value pair.</xsd:documentation>
                    </xsd:annotation>
                    <xsd:complexType>
                      <xsd:attribute name="name" type="xsd:string" use="required"/>
                      <xsd:attribute name="value" type="xsd:string" use="required"/>
                    </xsd:complexType>
                  </xsd:element>
                </xsd:sequence>
              </xsd:complexType>
            </xsd:element>
          </xsd:sequence>
          <!-- **************************************************** -->
          <xsd:attribute name="name" type="xsd:string" use="required">
            <xsd:annotation>
              <xsd:documentation>Name used in code to reference this persistence unit.</xsd:documentation>
            </xsd:annotation>
          </xsd:attribute>
          <!-- **************************************************** -->
          <xsd:attribute name="transaction-type" type="persistence:persistence-unit-transaction-type">
            <xsd:annotation>
              <xsd:documentation>Type of transactions used by EntityManagers from this 
                  persistence unit.</xsd:documentation>
            </xsd:annotation>
          </xsd:attribute>
        </xsd:complexType>
      </xsd:element>
    </xsd:sequence>
    <xsd:attribute name="version" type="persistence:versionType" fixed="1.0" use="required"/>
  </xsd:complexType>
</xsd:element>
[ top ]
Element persistence:persistence / persistence:persistence-unit
Namespace http://java.sun.com/xml/ns/persistence
Diagram
Diagram geronimo-tomcat-2.0.1.tmp#id36 geronimo-tomcat-2.0.1.tmp#id37 geronimo-tomcat-2.0.1.tmp#id24 geronimo-tomcat-2.0.1.tmp#id25 geronimo-tomcat-2.0.1.tmp#id26 geronimo-tomcat-2.0.1.tmp#id27 geronimo-tomcat-2.0.1.tmp#id28 geronimo-tomcat-2.0.1.tmp#id29 geronimo-tomcat-2.0.1.tmp#id30 geronimo-tomcat-2.0.1.tmp#id31 geronimo-tomcat-2.0.1.tmp#id32
Properties
content: complex
minOccurs: 0
maxOccurs: unbounded
Model persistence:description{0,1} , persistence:provider{0,1} , persistence:jta-data-source{0,1} , persistence:non-jta-data-source{0,1} , persistence:mapping-file* , persistence:jar-file* , persistence:class* , persistence:exclude-unlisted-classes{0,1} , persistence:properties{0,1}
Children persistence:class, persistence:description, persistence:exclude-unlisted-classes, persistence:jar-file, persistence:jta-data-source, persistence:mapping-file, persistence:non-jta-data-source, persistence:properties, persistence:provider
Instance
 
<persistence:persistence-unit name="" transaction-type="">
  <persistence:description>{0,1}</persistence:description>
  <persistence:provider>{0,1}</persistence:provider>
  <persistence:jta-data-source>{0,1}</persistence:jta-data-source>
  <persistence:non-jta-data-source>{0,1}</persistence:non-jta-data-source>
  <persistence:mapping-file>{0,unbounded}</persistence:mapping-file>
  <persistence:jar-file>{0,unbounded}</persistence:jar-file>
  <persistence:class>{0,unbounded}</persistence:class>
  <persistence:exclude-unlisted-classes>{0,1}</persistence:exclude-unlisted-classes>
  <persistence:properties>{0,1}</persistence:properties>
</persistence:persistence-unit>
Attributes
QName Type Fixed Default Use Annotation
name xsd:string required 
Name used in code to reference this persistence unit.
transaction-type persistence:persistence-unit-transaction-type optional 
Type of transactions used by EntityManagers from this 
persistence unit.
Source
 
<xsd:element name="persistence-unit" minOccurs="0" maxOccurs="unbounded">
  <xsd:complexType>
    <xsd:annotation>
      <xsd:documentation>Configuration of a persistence unit.</xsd:documentation>
    </xsd:annotation>
    <xsd:sequence>
      <!-- **************************************************** -->
      <xsd:element name="description" type="xsd:string" minOccurs="0">
        <xsd:annotation>
          <xsd:documentation>Textual description of this persistence unit.</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <!-- **************************************************** -->
      <xsd:element name="provider" type="xsd:string" minOccurs="0">
        <xsd:annotation>
          <xsd:documentation>Provider class that supplies EntityManagers for this 
                    persistence unit.</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <!-- **************************************************** -->
      <xsd:element name="jta-data-source" type="xsd:string" minOccurs="0">
        <xsd:annotation>
          <xsd:documentation>The container-specific name of the JTA datasource to use.</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <!-- **************************************************** -->
      <xsd:element name="non-jta-data-source" type="xsd:string" minOccurs="0">
        <xsd:annotation>
          <xsd:documentation>The container-specific name of a non-JTA datasource to use.</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <!-- **************************************************** -->
      <xsd:element name="mapping-file" type="xsd:string" minOccurs="0" maxOccurs="unbounded">
        <xsd:annotation>
          <xsd:documentation>File containing mapping information. Loaded as a resource 
                    by the persistence provider.</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <!-- **************************************************** -->
      <xsd:element name="jar-file" type="xsd:string" minOccurs="0" maxOccurs="unbounded">
        <xsd:annotation>
          <xsd:documentation>Jar file that should be scanned for entities. 
                    Not applicable to Java SE persistence units.</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <!-- **************************************************** -->
      <xsd:element name="class" type="xsd:string" minOccurs="0" maxOccurs="unbounded">
        <xsd:annotation>
          <xsd:documentation>Class to scan for annotations.  It should be annotated 
                    with either @Entity, @Embeddable or @MappedSuperclass.</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <!-- **************************************************** -->
      <xsd:element name="exclude-unlisted-classes" type="xsd:boolean" default="false" minOccurs="0">
        <xsd:annotation>
          <xsd:documentation>When set to true then only listed classes and jars will 
                    be scanned for persistent classes, otherwise the enclosing 
                    jar or directory will also be scanned. Not applicable to 
                    Java SE persistence units.</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <!-- **************************************************** -->
      <xsd:element name="properties" minOccurs="0">
        <xsd:annotation>
          <xsd:documentation>A list of vendor-specific properties.</xsd:documentation>
        </xsd:annotation>
        <xsd:complexType>
          <xsd:sequence>
            <xsd:element name="property" minOccurs="0" maxOccurs="unbounded">
              <xsd:annotation>
                <xsd:documentation>A name-value pair.</xsd:documentation>
              </xsd:annotation>
              <xsd:complexType>
                <xsd:attribute name="name" type="xsd:string" use="required"/>
                <xsd:attribute name="value" type="xsd:string" use="required"/>
              </xsd:complexType>
            </xsd:element>
          </xsd:sequence>
        </xsd:complexType>
      </xsd:element>
    </xsd:sequence>
    <!-- **************************************************** -->
    <xsd:attribute name="name" type="xsd:string" use="required">
      <xsd:annotation>
        <xsd:documentation>Name used in code to reference this persistence unit.</xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <!-- **************************************************** -->
    <xsd:attribute name="transaction-type" type="persistence:persistence-unit-transaction-type">
      <xsd:annotation>
        <xsd:documentation>Type of transactions used by EntityManagers from this 
                  persistence unit.</xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
  </xsd:complexType>
</xsd:element>
[ top ]
Element persistence:persistence / persistence:persistence-unit / persistence:description
Namespace http://java.sun.com/xml/ns/persistence
Annotations
 
Textual description of this persistence unit.
Diagram
Diagram
Type xsd:string
Properties
content: simple
minOccurs: 0
Source
 
<xsd:element name="description" type="xsd:string" minOccurs="0">
  <xsd:annotation>
    <xsd:documentation>Textual description of this persistence unit.</xsd:documentation>
  </xsd:annotation>
</xsd:element>
[ top ]
Element persistence:persistence / persistence:persistence-unit / persistence:provider
Namespace http://java.sun.com/xml/ns/persistence
Annotations
 
Provider class that supplies EntityManagers for this 
persistence unit.
Diagram
Diagram
Type xsd:string
Properties
content: simple
minOccurs: 0
Source
 
<xsd:element name="provider" type="xsd:string" minOccurs="0">
  <xsd:annotation>
    <xsd:documentation>Provider class that supplies EntityManagers for this 
                    persistence unit.</xsd:documentation>
  </xsd:annotation>
</xsd:element>
[ top ]
Element persistence:persistence / persistence:persistence-unit / persistence:jta-data-source
Namespace http://java.sun.com/xml/ns/persistence
Annotations
 
The container-specific name of the JTA datasource to use.
Diagram
Diagram
Type xsd:string
Properties
content: simple
minOccurs: 0
Source
 
<xsd:element name="jta-data-source" type="xsd:string" minOccurs="0">
  <xsd:annotation>
    <xsd:documentation>The container-specific name of the JTA datasource to use.</xsd:documentation>
  </xsd:annotation>
</xsd:element>
[ top ]
Element persistence:persistence / persistence:persistence-unit / persistence:non-jta-data-source
Namespace http://java.sun.com/xml/ns/persistence
Annotations
 
The container-specific name of a non-JTA datasource to use.
Diagram
Diagram
Type xsd:string
Properties
content: simple
minOccurs: 0
Source
 
<xsd:element name="non-jta-data-source" type="xsd:string" minOccurs="0">
  <xsd:annotation>
    <xsd:documentation>The container-specific name of a non-JTA datasource to use.</xsd:documentation>
  </xsd:annotation>
</xsd:element>
[ top ]
Element persistence:persistence / persistence:persistence-unit / persistence:mapping-file
Namespace http://java.sun.com/xml/ns/persistence
Annotations
 
File containing mapping information. Loaded as a resource 
by the persistence provider.
Diagram
Diagram
Type xsd:string
Properties
content: simple
minOccurs: 0
maxOccurs: unbounded
Source
 
<xsd:element name="mapping-file" type="xsd:string" minOccurs="0" maxOccurs="unbounded">
  <xsd:annotation>
    <xsd:documentation>File containing mapping information. Loaded as a resource 
                    by the persistence provider.</xsd:documentation>
  </xsd:annotation>
</xsd:element>
[ top ]
Element persistence:persistence / persistence:persistence-unit / persistence:jar-file
Namespace http://java.sun.com/xml/ns/persistence
Annotations
 
Jar file that should be scanned for entities. 
Not applicable to Java SE persistence units.
Diagram
Diagram
Type xsd:string
Properties
content: simple
minOccurs: 0
maxOccurs: unbounded
Source
 
<xsd:element name="jar-file" type="xsd:string" minOccurs="0" maxOccurs="unbounded">
  <xsd:annotation>
    <xsd:documentation>Jar file that should be scanned for entities. 
                    Not applicable to Java SE persistence units.</xsd:documentation>
  </xsd:annotation>
</xsd:element>
[ top ]
Element persistence:persistence / persistence:persistence-unit / persistence:class
Namespace http://java.sun.com/xml/ns/persistence
Annotations
 
Class to scan for annotations.  It should be annotated 
with either @Entity, @Embeddable or @MappedSuperclass.
Diagram
Diagram
Type xsd:string
Properties
content: simple
minOccurs: 0
maxOccurs: unbounded
Source
 
<xsd:element name="class" type="xsd:string" minOccurs="0" maxOccurs="unbounded">
  <xsd:annotation>
    <xsd:documentation>Class to scan for annotations.  It should be annotated 
                    with either @Entity, @Embeddable or @MappedSuperclass.</xsd:documentation>
  </xsd:annotation>
</xsd:element>
[ top ]
Element persistence:persistence / persistence:persistence-unit / persistence:exclude-unlisted-classes
Namespace http://java.sun.com/xml/ns/persistence
Annotations
 
When set to true then only listed classes and jars will 
be scanned for persistent classes, otherwise the enclosing 
jar or directory will also be scanned. Not applicable to 
Java SE persistence units.
Diagram
Diagram
Type xsd:boolean
Properties
content: simple
minOccurs: 0
default: false
Source
 
<xsd:element name="exclude-unlisted-classes" type="xsd:boolean" default="false" minOccurs="0">
  <xsd:annotation>
    <xsd:documentation>When set to true then only listed classes and jars will 
                    be scanned for persistent classes, otherwise the enclosing 
                    jar or directory will also be scanned. Not applicable to 
                    Java SE persistence units.</xsd:documentation>
  </xsd:annotation>
</xsd:element>
[ top ]
Element persistence:persistence / persistence:persistence-unit / persistence:properties
Namespace http://java.sun.com/xml/ns/persistence
Annotations
 
A list of vendor-specific properties.
Diagram
Diagram geronimo-tomcat-2.0.1.tmp#id33
Properties
content: complex
minOccurs: 0
Model persistence:property*
Children persistence:property
Instance
 
<persistence:properties>
  <persistence:property name="" value="">{0,unbounded}</persistence:property>
</persistence:properties>
Source
 
<xsd:element name="properties" minOccurs="0">
  <xsd:annotation>
    <xsd:documentation>A list of vendor-specific properties.</xsd:documentation>
  </xsd:annotation>
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element name="property" minOccurs="0" maxOccurs="unbounded">
        <xsd:annotation>
          <xsd:documentation>A name-value pair.</xsd:documentation>
        </xsd:annotation>
        <xsd:complexType>
          <xsd:attribute name="name" type="xsd:string" use="required"/>
          <xsd:attribute name="value" type="xsd:string" use="required"/>
        </xsd:complexType>
      </xsd:element>
    </xsd:sequence>
  </xsd:complexType>
</xsd:element>
[ top ]
Element persistence:persistence / persistence:persistence-unit / persistence:properties / persistence:property
Namespace http://java.sun.com/xml/ns/persistence
Annotations
 
A name-value pair.
Diagram
Diagram geronimo-tomcat-2.0.1.tmp#id34 geronimo-tomcat-2.0.1.tmp#id35
Properties
content: complex
minOccurs: 0
maxOccurs: unbounded
Attributes
QName Type Fixed Default Use Annotation
name xsd:string required
value xsd:string required
Source
 
<xsd:element name="property" minOccurs="0" maxOccurs="unbounded">
  <xsd:annotation>
    <xsd:documentation>A name-value pair.</xsd:documentation>
  </xsd:annotation>
  <xsd:complexType>
    <xsd:attribute name="name" type="xsd:string" use="required"/>
    <xsd:attribute name="value" type="xsd:string" use="required"/>
  </xsd:complexType>
</xsd:element>
[ top ]
Complex Type tomcat:web-appType
Namespace http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1
Diagram
Diagram geronimo-tomcat-2.0.1.tmp#id5 geronimo-tomcat-2.0.1.tmp#id6 geronimo-tomcat-2.0.1.tmp#id9 geronimo-tomcat-2.0.1.tmp#id10 geronimo-tomcat-2.0.1.tmp#id12 geronimo-tomcat-2.0.1.tmp#id13 geronimo-tomcat-2.0.1.tmp#id14 geronimo-tomcat-2.0.1.tmp#id15 geronimo-tomcat-2.0.1.tmp#id16 geronimo-tomcat-2.0.1.tmp#id17 geronimo-tomcat-2.0.1.tmp#id19 geronimo-tomcat-2.0.1.tmp#id22
Used by
Element tomcat:web-app
Model environment{0,1} , tomcat:context-root{0,1} , tomcat:work-dir{0,1} , clustering{0,1} , web-container{0,1} , tomcat:host{0,1} , tomcat:cross-context{0,1} , tomcat:disable-cookies{0,1} , tomcat:valve-chain{0,1} , tomcat:listener-chain{0,1} , tomcat:tomcat-realm{0,1} , tomcat:manager{0,1} , tomcat:cluster{0,1} , message-destination* , tomcat:security-realm-name , security{0,1} , (service* | persistence:persistence)
Children clustering, environment, message-destination, persistence:persistence, security, service, tomcat:cluster, tomcat:context-root, tomcat:cross-context, tomcat:disable-cookies, tomcat:host, tomcat:listener-chain, tomcat:manager, tomcat:security-realm-name, tomcat:tomcat-realm, tomcat:valve-chain, tomcat:work-dir, web-container
Source
 
<xs:complexType name="web-appType">
  <xs:sequence>
    <xs:element ref="sys:environment" minOccurs="0">
      <xs:annotation>
        <xs:documentation>Reference to environment element defined in imported
                        "geronimo-module-1.2.xsd"</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="context-root" type="xs:string" minOccurs="0">
      <xs:annotation>
        <xs: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 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.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="work-dir" type="xs:string" minOccurs="0">
      <xs:annotation>
        <xs:documentation>This is the work directory that will be used by this
                        application.  The directory location will be relative
                        to "catalina.home".</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element ref="app:clustering" minOccurs="0">
      <xs:annotation>
        <xs:documentation>Reference to abstract clustering element defined in
                        imported "geronimo-application-2.0.xsd"</xs:documentation>
      </xs:annotation>
    </xs:element>
    <!--<xs:element name="context-priority-classloader" type="xs:boolean" minOccurs="0"/>-->
    <xs:element ref="naming:web-container" minOccurs="0">
      <xs:annotation>
        <xs:documentation>Reference to web-container element defined in imported
                        "geronimo-naming-1.2.xsd"</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="host" type="xs:string" minOccurs="0">
      <xs:annotation>
        <xs:documentation>The host element maps the web application to this
                        particular host name.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="cross-context" type="tomcat:emptyType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>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.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="disable-cookies" type="tomcat:emptyType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>The presence of disable-cookies element indicates the
                        cookies will not be used by tomcat web application and
                        should be disabled.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="valve-chain" type="xs:string" minOccurs="0">
      <xs:annotation>
        <xs:documentation>The valve-chain provides the list of first element
                        tomcat valves chain for this web application.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="listener-chain" type="xs:string" minOccurs="0">
      <xs:annotation>
        <xs:documentation>The listener-chain provides the list of first element
                        tomcat lifecycle listener chain for this web application.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="tomcat-realm" type="xs:string" minOccurs="0">
      <xs:annotation>
        <xs:documentation>The tomcat-realm provides the tomcat security realm used
                        by this web application.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="manager" type="xs:string" minOccurs="0">
      <xs:annotation>
        <xs:documentation>The manager provides the clustering implementation used
                        by this web application.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="cluster" type="xs:string" minOccurs="0">
      <xs:annotation>
        <xs:documentation>The cluster provides the name of cluster this web
                        application belongs to.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:group ref="naming:jndiEnvironmentRefsGroup">
      <xs:annotation>
        <xs:documentation>Reference to jndiEnvironmentRefsGroup group defined in
                        imported "geronimo-naming-1.2.xsd"</xs:documentation>
      </xs:annotation>
    </xs:group>
    <xs:element ref="naming:message-destination" minOccurs="0" maxOccurs="unbounded">
      <xs:annotation>
        <xs:documentation>Reference to message-destination element defined in
                        imported "geronimo-naming-1.2.xsd"</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:sequence minOccurs="0">
      <xs:element name="security-realm-name" type="xs:string">
        <xs:annotation>
          <xs:documentation>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.</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element ref="app:security" minOccurs="0">
        <xs:annotation>
          <xs:documentation>Reference to security element defined in imported
                            "geronimo-security-2.0.xsd"</xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
    <xs:choice minOccurs="0" maxOccurs="unbounded">
      <xs:element ref="sys:service" minOccurs="0" maxOccurs="unbounded">
        <xs:annotation>
          <xs:documentation>Reference to abstract service element defined in imported
                            "geronimo-module-1.2.xsd"</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element ref="ee:persistence"/>
    </xs:choice>
  </xs:sequence>
</xs:complexType>
[ top ]
Complex Type tomcat:emptyType
Namespace http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1
Diagram
Diagram
Used by
Source
 
<xs:complexType name="emptyType"/>
[ top ]
Simple Type persistence:persistence-unit-transaction-type
Namespace http://java.sun.com/xml/ns/persistence
Annotations
 
public enum TransactionType { JTA, RESOURCE_LOCAL };
Diagram
Diagram
Type restriction of xsd:token
Facets
enumeration JTA
enumeration RESOURCE_LOCAL
Used by
Source
 
<xsd:simpleType name="persistence-unit-transaction-type">
  <xsd:annotation>
    <xsd:documentation>public enum TransactionType { JTA, RESOURCE_LOCAL };</xsd:documentation>
  </xsd:annotation>
  <xsd:restriction base="xsd:token">
    <xsd:enumeration value="JTA"/>
    <xsd:enumeration value="RESOURCE_LOCAL"/>
  </xsd:restriction>
</xsd:simpleType>
[ top ]
Simple Type persistence:versionType
Namespace http://java.sun.com/xml/ns/persistence
Diagram
Diagram
Type restriction of xsd:token
Facets
pattern [0-9]+(\.[0-9]+)*
Used by
Source
 
<xsd:simpleType name="versionType">
  <xsd:restriction base="xsd:token">
    <xsd:pattern value="[0-9]+(\.[0-9]+)*"/>
  </xsd:restriction>
</xsd:simpleType>
[ top ]
Attribute persistence:persistence / persistence:persistence-unit / persistence:properties / persistence:property / @name
Namespace No namespace
Type xsd:string
Properties
use: required
Used by
Source
 
<xsd:attribute name="name" type="xsd:string" use="required"/>
[ top ]
Attribute persistence:persistence / persistence:persistence-unit / persistence:properties / persistence:property / @value
Namespace No namespace
Type xsd:string
Properties
use: required
Used by
Source
 
<xsd:attribute name="value" type="xsd:string" use="required"/>
[ top ]
Attribute persistence:persistence / persistence:persistence-unit / @name
Namespace No namespace
Annotations
 
Name used in code to reference this persistence unit.
Type xsd:string
Properties
use: required
Used by
Source
 
<xsd:attribute name="name" type="xsd:string" use="required">
  <xsd:annotation>
    <xsd:documentation>Name used in code to reference this persistence unit.</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>
[ top ]
Attribute persistence:persistence / persistence:persistence-unit / @transaction-type
Namespace No namespace
Annotations
 
Type of transactions used by EntityManagers from this 
persistence unit.
Type persistence:persistence-unit-transaction-type
Properties
content: simple
Facets
enumeration JTA
enumeration RESOURCE_LOCAL
Used by
Source
 
<xsd:attribute name="transaction-type" type="persistence:persistence-unit-transaction-type">
  <xsd:annotation>
    <xsd:documentation>Type of transactions used by EntityManagers from this 
                  persistence unit.</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>
[ top ]
Attribute persistence:persistence / @version
Namespace No namespace
Type persistence:versionType
Properties
use: required
fixed: 1.0
Facets
pattern [0-9]+(\.[0-9]+)*
Used by
Source
 
<xsd:attribute name="version" type="persistence:versionType" fixed="1.0" use="required"/>
[ top ]
XML Schema documentation generated by ® XML Editor.