geronimo-scm mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ccard...@apache.org
Subject svn commit: r511458 [1/5] - in /geronimo/server/trunk/modules: geronimo-client-builder/src/main/schema/ geronimo-connector-builder/src/main/schema/ geronimo-j2ee-builder/src/main/schema/ geronimo-jetty6-builder/src/main/schema/ geronimo-naming-builder/...
Date Sun, 25 Feb 2007 06:29:16 GMT
Author: ccardona
Date: Sat Feb 24 22:29:15 2007
New Revision: 511458

URL: http://svn.apache.org/viewvc?view=rev&rev=511458
Log:
GERONIMO-2661 Make geronimo schema files more human readable
- Applied alldoc.patch (Thanks Rakesh..) and made additional modifications:
- Removed the extra Apache license annotation (I think the original Apache license header is enough)
- Arranged the schema formatting
- Changed some annotation/documentation text

Modified:
    geronimo/server/trunk/modules/geronimo-client-builder/src/main/schema/geronimo-application-client-1.2.xsd
    geronimo/server/trunk/modules/geronimo-connector-builder/src/main/schema/geronimo-connector-1.2.xsd
    geronimo/server/trunk/modules/geronimo-j2ee-builder/src/main/schema/geronimo-application-1.2.xsd
    geronimo/server/trunk/modules/geronimo-jetty6-builder/src/main/schema/geronimo-jetty-1.2.xsd
    geronimo/server/trunk/modules/geronimo-jetty6-builder/src/main/schema/geronimo-jetty-config-1.0.xsd
    geronimo/server/trunk/modules/geronimo-naming-builder/src/main/schema/geronimo-naming-1.2.xsd
    geronimo/server/trunk/modules/geronimo-security-builder/src/main/schema/geronimo-login-config-1.2.xsd
    geronimo/server/trunk/modules/geronimo-security-builder/src/main/schema/geronimo-security-1.2.xsd
    geronimo/server/trunk/modules/geronimo-service-builder/src/main/schema/geronimo-module-1.2.xsd
    geronimo/server/trunk/modules/geronimo-system/src/main/resources/META-INF/schema/attributes-1.1.xsd
    geronimo/server/trunk/modules/geronimo-system/src/main/resources/META-INF/schema/plugins-1.1.xsd
    geronimo/server/trunk/modules/geronimo-tomcat6-builder/src/main/schema/geronimo-tomcat-1.2.xsd
    geronimo/server/trunk/modules/geronimo-tomcat6-builder/src/main/schema/geronimo-tomcat-config-1.0.xsd
    geronimo/server/trunk/modules/geronimo-web-builder/src/main/schema/geronimo-web-1.2.xsd

Modified: geronimo/server/trunk/modules/geronimo-client-builder/src/main/schema/geronimo-application-client-1.2.xsd
URL: http://svn.apache.org/viewvc/geronimo/server/trunk/modules/geronimo-client-builder/src/main/schema/geronimo-application-client-1.2.xsd?view=diff&rev=511458&r1=511457&r2=511458
==============================================================================
--- geronimo/server/trunk/modules/geronimo-client-builder/src/main/schema/geronimo-application-client-1.2.xsd (original)
+++ geronimo/server/trunk/modules/geronimo-client-builder/src/main/schema/geronimo-application-client-1.2.xsd Sat Feb 24 22:29:15 2007
@@ -1,22 +1,23 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-
     Licensed to the Apache Software Foundation (ASF) under one or more
     contributor license agreements.  See the NOTICE file distributed with
     this work for additional information regarding copyright ownership.
     The ASF licenses this file to You 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
-
+    
+        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.
 -->
+
 <!-- @version $Rev$ $Date$ -->
+
 <xs:schema
     xmlns:geronimo="http://geronimo.apache.org/xml/ns/j2ee/application-client-1.2"
     targetNamespace="http://geronimo.apache.org/xml/ns/j2ee/application-client-1.2"
@@ -24,54 +25,245 @@
     xmlns:connector="http://geronimo.apache.org/xml/ns/j2ee/connector-1.2"
     xmlns:security="http://geronimo.apache.org/xml/ns/security-1.2"
     xmlns:sys="http://geronimo.apache.org/xml/ns/deployment-1.2"
-    xmlns:xs="http://www.w3.org/2001/XMLSchema"
-    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/security-1.2" schemaLocation="geronimo-security-1.2.xsd"/>
-    <xs:import namespace="http://geronimo.apache.org/xml/ns/j2ee/connector-1.2" schemaLocation="geronimo-connector-1.2.xsd"/>
-    <xs:import namespace="http://geronimo.apache.org/xml/ns/deployment-1.2" schemaLocation="geronimo-module-1.2.xsd"/>
+    xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"
+    attributeFormDefault="unqualified" version="1.0">
 
-    <xs:element name="application-client" type="geronimo:application-clientType"/>
+    <xs:annotation>
+        <xs:documentation>
+            This is an XML Schema Definition for Geronimo Java application
+            client deployment plan. In case the Java application client
+            deployment plan is provided internally in the java archive, it
+            should be named META-INF/geronimo-application-client.xml. In case
+            the java application client deployment plan is provided externally,
+            the deployment descriptor can be named anything and provided to the
+            deploy tool. All the Java application client deployment plan must
+            specify the top level element as application-client with namespace
+            specified as
+            xmlns="http://geronimo.apache.org/xml/ns/j2ee/application-client-1.2".
+            The default location for this document is
+            http://geronimo.apache.org/schemas-1.2/geronimo-application-client-1.2.xsd
+        </xs:documentation>
+    </xs:annotation>
+
+    <xs:import namespace="http://geronimo.apache.org/xml/ns/naming-1.2"
+        schemaLocation="geronimo-naming-1.2.xsd">
+        <xs:annotation>
+            <xs:documentation>
+                Import partial schema containing common naming elements, the
+                imported plan declares elements like ejb-ref, ejb-local-ref,
+                service-ref, resource-ref, and resource-env-ref required by this
+                plan schema.
+            </xs:documentation>
+        </xs:annotation>
+    </xs:import>
+    <xs:import namespace="http://geronimo.apache.org/xml/ns/security-1.2"
+        schemaLocation="geronimo-security-1.2.xsd">
+        <xs:annotation>
+            <xs:documentation>
+                Import Geronimo security deployment plans. The imported plan
+                includes complex types for defining security and principals.
+            </xs:documentation>
+        </xs:annotation>
+    </xs:import>
+    <xs:import namespace="http://geronimo.apache.org/xml/ns/j2ee/connector-1.2"
+        schemaLocation="geronimo-connector-1.2.xsd">
+        <xs:annotation>
+            <xs:documentation>
+                Import Geronimo resource adapter deployment plans. The imported
+                plan includes complex types for defining connectors and resource
+                adapters.
+            </xs:documentation>
+        </xs:annotation>
+    </xs:import>
+    <xs:import namespace="http://geronimo.apache.org/xml/ns/deployment-1.2"
+        schemaLocation="geronimo-module-1.2.xsd">
+        <xs:annotation>
+            <xs:documentation>
+                Import Geronimo Services deployment plans. The imported plan
+                includes complex types like moduleType, environmentType,
+                dependenciesType, etc. required by this plan schema.
+            </xs:documentation>
+        </xs:annotation>
+    </xs:import>
+
+    <xs:element name="application-client"
+        type="geronimo:application-clientType">
+        <xs:annotation>
+            <xs:documentation>
+                The root element for Geronimo Java application client deployment
+                plan, this element should always exist in instance documents. It
+                mirrors the application-client defined by
+                application-client_1_4.xsd. It specifies the references for the
+                java application client modules. These references could be
+                reference to external gbeans, ejb modules, service modules,
+                resources, or security principals.
+            </xs:documentation>
+        </xs:annotation>
+    </xs:element>
 
     <xs:complexType name="application-clientType">
         <xs:sequence>
-            <xs:element ref="sys:client-environment"/>
-            <xs:element ref="sys:server-environment"/>
-
-            <xs:element ref="naming:gbean-ref" minOccurs="0" maxOccurs="unbounded"/>
-            <xs:element ref="naming:ejb-ref" minOccurs="0" maxOccurs="unbounded"/>
-            <xs:element ref="naming:service-ref" minOccurs="0" maxOccurs="unbounded"/>
-            <xs:element ref="naming:resource-ref" minOccurs="0" maxOccurs="unbounded"/>
-            <xs:element ref="naming:resource-env-ref" minOccurs="0" maxOccurs="unbounded"/>
-            <xs:element ref="naming:message-destination" minOccurs="0" maxOccurs="unbounded"/>
-
-            <xs:element ref="security:default-principal" minOccurs="0"/>
+            <xs:element ref="sys:client-environment">
+                <xs:annotation>
+                    <xs:documentation>
+                        Reference to client-environment element defined in
+                        imported "geronimo-module-1.2.xsd"
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
+            <xs:element ref="sys:server-environment">
+                <xs:annotation>
+                    <xs:documentation>
+                        Reference to server-environment element defined in
+                        imported "geronimo-module-1.2.xsd"
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
+
+            <xs:element ref="naming:gbean-ref" minOccurs="0"
+                maxOccurs="unbounded">
+                <xs:annotation>
+                    <xs:documentation>
+                        Reference to gbean-ref element defined in imported
+                        "geronimo-naming-1.2.xsd"
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
+            <xs:element ref="naming:ejb-ref" minOccurs="0"
+                maxOccurs="unbounded">
+                <xs:annotation>
+                    <xs:documentation>
+                        Reference to ejb-ref element defined in imported
+                        "geronimo-naming-1.2.xsd"
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
+            <xs:element ref="naming:service-ref" minOccurs="0"
+                maxOccurs="unbounded">
+                <xs:annotation>
+                    <xs:documentation>
+                        Reference to service-ref element defined in imported
+                        "geronimo-naming-1.2.xsd"
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
+            <xs:element ref="naming:resource-ref" minOccurs="0"
+                maxOccurs="unbounded">
+                <xs:annotation>
+                    <xs:documentation>
+                        Reference to resource-ref element defined in imported
+                        "geronimo-naming-1.2.xsd"
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
+            <xs:element ref="naming:resource-env-ref" minOccurs="0"
+                maxOccurs="unbounded">
+                <xs:annotation>
+                    <xs:documentation>
+                        Reference to resource-env-ref element defined in
+                        imported "geronimo-naming-1.2.xsd"
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
+            <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:element ref="security:default-principal" minOccurs="0">
+                <xs:annotation>
+                    <xs:documentation>
+                        Reference to default-principal element defined in
+                        imported "geronimo-security-1.2.xsd"
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
 
             <xs:sequence minOccurs="0">
-                <xs:element name="realm-name" type="xs:string"/>
-                <xs:element name="callback-handler" type="xs:string" minOccurs="0"/>
+                <xs:element name="realm-name" type="xs:string">
+                    <xs:annotation>
+                        <xs:documentation>
+                            The realm-name element names the security realm used
+                            for JAAS login
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
+                <xs:element name="callback-handler" type="xs:string"
+                    minOccurs="0">
+                    <xs:annotation>
+                        <xs:documentation>
+                            The callback-handler element specifies the name of a
+                            callback class provided by the application for JAAS
+                            authentication. This class must implement the
+                            javax.security.auth.callback.CallbackHandler
+                            interface and follow its specification, as this
+                            class will be used by the application client
+                            container to collect authentication information from
+                            the user.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
             </xs:sequence>
 
-
-            <xs:element name="resource" type="geronimo:resourceType" minOccurs="0" maxOccurs="unbounded"/>
-
-            <xs:element ref="sys:service" minOccurs="0" maxOccurs="unbounded"/>
+            <xs:element name="resource" type="geronimo:resourceType"
+                minOccurs="0" maxOccurs="unbounded">
+                <xs:annotation>
+                    <xs:documentation>
+                        The resource element names contains the definition of
+                        all the module-scoped connector resources. The connector
+                        resource can be both external and internal to the
+                        application client.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
+
+            <xs:element ref="sys:service" minOccurs="0" maxOccurs="unbounded">
+                <xs:annotation>
+                    <xs:documentation>
+                        Reference to service element defined in imported
+                        "geronimo-module-1.2.xsd"
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
         </xs:sequence>
-
     </xs:complexType>
 
     <xs:complexType name="resourceType">
         <xs:sequence>
             <xs:choice>
-                <xs:element name="external-rar" type="xs:string"/>
-                <xs:element name="internal-rar" type="xs:string"/>
+                <xs:element name="external-rar" type="xs:string">
+                    <xs:annotation>
+                        <xs:documentation>
+                            The external-rar is a Module ID of the resource
+                            adapter in the Geronimo repository.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
+                <xs:element name="internal-rar" type="xs:string">
+                    <xs:annotation>
+                        <xs:documentation>
+                            The internal-rar is a Module ID of the resource
+                            adapter in the client module.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
             </xs:choice>
-            <xs:element ref="connector:connector"/>
+            <xs:element ref="connector:connector">
+                <xs:annotation>
+                    <xs:documentation>
+                        This element contains the contents of the Resource Group
+                        deployment plan. The content is no different that the
+                        content of the deployment plan would have been for the
+                        server-wide or application-scoped resource group.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
         </xs:sequence>
     </xs:complexType>
-
 
 </xs:schema>

Modified: geronimo/server/trunk/modules/geronimo-connector-builder/src/main/schema/geronimo-connector-1.2.xsd
URL: http://svn.apache.org/viewvc/geronimo/server/trunk/modules/geronimo-connector-builder/src/main/schema/geronimo-connector-1.2.xsd?view=diff&rev=511458&r1=511457&r2=511458
==============================================================================
--- geronimo/server/trunk/modules/geronimo-connector-builder/src/main/schema/geronimo-connector-1.2.xsd (original)
+++ geronimo/server/trunk/modules/geronimo-connector-builder/src/main/schema/geronimo-connector-1.2.xsd Sat Feb 24 22:29:15 2007
@@ -1,15 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-
     Licensed to the Apache Software Foundation (ASF) under one or more
     contributor license agreements.  See the NOTICE file distributed with
     this work for additional information regarding copyright ownership.
     The ASF licenses this file to You 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
-
+    
+        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.
@@ -22,85 +21,117 @@
     xmlns:naming="http://geronimo.apache.org/xml/ns/naming-1.2"
     xmlns:sys="http://geronimo.apache.org/xml/ns/deployment-1.2"
     targetNamespace="http://geronimo.apache.org/xml/ns/j2ee/connector-1.2"
-    xmlns:xs="http://www.w3.org/2001/XMLSchema"
-    elementFormDefault="qualified"
+    xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"
     attributeFormDefault="unqualified">
 
-    <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/deployment-1.2" schemaLocation="geronimo-module-1.2.xsd"/>
-    <xs:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="http://www.w3.org/2001/xml.xsd"/>
+    <xs:annotation>
+        <xs:documentation>
+            This is an XML Schema Definition for Geronimo resource adapter
+            deployment plan. In case the Geronimo resource adapter deployment
+            plan is provided internally in the resource adapter archive, it
+            should be names META-INF/geronimo-ra.xml. In case the Geronimo
+            resource adapter 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
+            Geronimo resource adapter deployment plan must specify the top level
+            element as connector with namespace specified as xmlns=
+            "http://geronimo.apache.org/xml/ns/j2ee/connector-1.2". The default
+            location for this document is
+            http://geronimo.apache.org/schemas-1.2/geronimo-connector-1.2.xsd
+        </xs:documentation>
+    </xs:annotation>
+    <xs:import namespace="http://geronimo.apache.org/xml/ns/naming-1.2"
+        schemaLocation="geronimo-naming-1.2.xsd">
+        <xs:annotation>
+            <xs:documentation>
+                Import partial schema containing common naming elements, the
+                imported plan declares elements like ejb-ref, ejb-local-ref,
+                service-ref,resource-ref, and resource-env-ref required by this
+                plan schema.
+            </xs:documentation>
+        </xs:annotation>
+    </xs:import>
+    <xs:import namespace="http://geronimo.apache.org/xml/ns/deployment-1.2"
+        schemaLocation="geronimo-module-1.2.xsd">
+        <xs:annotation>
+            <xs:documentation>
+                Import Geronimo Services deployment plans. The imported plan
+                includes complex types like moduleType, environmentType,
+                dependenciesType, etc. required by this plan schema.
+            </xs:documentation>
+        </xs:annotation>
+    </xs:import>
+    <xs:import namespace="http://www.w3.org/XML/1998/namespace"
+        schemaLocation="http://www.w3.org/2001/xml.xsd" />
 
     <xs:annotation>
         <xs:documentation>
             <![CDATA[
             documents using this schema should start like:
-<connector xmlns="http://geronimo.apache.org/xml/ns/j2ee/connector-1.2"
-    version="1.5">
+            <connector xmlns="http://geronimo.apache.org/xml/ns/j2ee/connector-1.2"
+            version="1.5">
 
-          @(#)geronimo-connector_1_5.xsds
+            @(#)geronimo-connector_1_5.xsds
             ]]>
         </xs:documentation>
     </xs:annotation>
 
-
-
     <!-- **************************************************** -->
 
-
     <xs:element name="connector" type="ger:connectorType">
         <xs:annotation>
             <xs:documentation>
-
                 The connector element is the root element of the deployment
-                descriptor for the resource adapter. This element includes
+                descriptor for the resource adapter. Note that the sub-elements
+                of this element should be as in the given order in a sequence.
+                It includes geronimo specific information for the resource
+                adapter library.
             </xs:documentation>
         </xs:annotation>
 
         <xs:unique name="resourceadapter-instance-name-uniqueness">
             <xs:annotation>
                 <xs:documentation>
-
-              The resourceadapter-instance element must have a unique name.
-
+                    The resourceadapter-instance element must have a unique
+                    name.
                 </xs:documentation>
             </xs:annotation>
-            <xs:selector xpath="ger:resourceadapter/ger:resourceadapter-instance"/>
-            <xs:field xpath="ger:resourceadapter-name"/>
+            <xs:selector
+                xpath="ger:resourceadapter/ger:resourceadapter-instance" />
+            <xs:field xpath="ger:resourceadapter-name" />
         </xs:unique>
 
         <xs:unique name="connectiondefinition-instance-name-uniqueness">
             <xs:annotation>
                 <xs:documentation>
-
-              The connectiondefinition-instance element must have a unique name.
-
+                    The connectiondefinition-instance element must have a unique
+                    name.
                 </xs:documentation>
             </xs:annotation>
-            <xs:selector xpath="ger:resourceadapter/ger:outbound-resourceadapter/ger:connection-definition/ger:connectiondefinition-instance"/>
-            <xs:field xpath="ger:name"/>
+            <xs:selector
+                xpath="ger:resourceadapter/ger:outbound-resourceadapter/ger:connection-definition/ger:connectiondefinition-instance" />
+            <xs:field xpath="ger:name" />
         </xs:unique>
 
         <xs:unique name="admin-object-instance-name-uniqueness">
             <xs:annotation>
                 <xs:documentation>
-
-              The admin-object-instance element must have a unique name.
-
+                    The admin-object-instance element must have a unique name.
                 </xs:documentation>
             </xs:annotation>
-            <xs:selector xpath="ger:adminobject/ger:adminobject-instance"/>
-            <xs:field xpath="ger:message-destination-name"/>
+            <xs:selector xpath="ger:adminobject/ger:adminobject-instance" />
+            <xs:field xpath="ger:message-destination-name" />
         </xs:unique>
-
     </xs:element>
 
-
     <!-- **************************************************** -->
 
     <xs:complexType name="adminobjectType">
         <xs:annotation>
             <xs:documentation>
-                reference back into standard dd
+                This complex type maps back to adminobjectType complex type in
+                connectors xsd.
             </xs:documentation>
         </xs:annotation>
 
@@ -109,7 +140,10 @@
                 type="ger:fully-qualified-classType">
                 <xs:annotation>
                     <xs:documentation>
-                        believe it or not, there are no uniqueness constraints on admin object intf or class
+                        The element adminobject-interface maps back to an
+                        adminobject-interface element in ra.xml. It specifies
+                        the fully qualified name of Java interface of the
+                        administrated object.
                     </xs:documentation>
                 </xs:annotation>
 
@@ -117,47 +151,75 @@
             <xs:element name="adminobject-class"
                 type="ger:fully-qualified-classType">
                 <xs:annotation>
-                    <xs:documentation>reference back into the standard dd</xs:documentation>
+                    <xs:documentation>
+                        The element adminobject-class maps back to an
+                        adminobject-class element in ra.xml. It specifies the
+                        fully qualified name of Java class of the administrated
+                        object.
+                    </xs:documentation>
                 </xs:annotation>
             </xs:element>
             <xs:element name="adminobject-instance"
-                type="ger:adminobject-instanceType"
-                minOccurs="0"
-                maxOccurs="unbounded"/>
+                type="ger:adminobject-instanceType" minOccurs="0"
+                maxOccurs="unbounded">
+                <xs:annotation>
+                    <xs:documentation>
+                        The element adminobject-instance contains the
+                        configuration for this specific instance of the
+                        administered object type, with a unique name, and values
+                        for any configuration properties necessary for that
+                        administered object type.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
         </xs:sequence>
     </xs:complexType>
 
     <xs:complexType name="adminobject-instanceType">
         <xs:sequence>
-            <xs:element name="message-destination-name"
-                type="xs:string">
+            <xs:element name="message-destination-name" type="xs:string">
                 <xs:annotation>
-                    <xs:documentation>unique name for admin object instance.  Used in object name of gbean for it. Matches message-destination-name in ejb-jar.xml assembly descriptor.
+                    <xs:documentation>
+                        A unique name for admin object instance. Used in object
+                        name of gbean for it. Matches message-destination-name
+                        in ejb-jar.xml assembly descriptor.
                     </xs:documentation>
                 </xs:annotation>
             </xs:element>
             <xs:element name="config-property-setting"
-                type="ger:config-property-settingType"
-                minOccurs="0"
-                maxOccurs="unbounded"/>
+                type="ger:config-property-settingType" minOccurs="0"
+                maxOccurs="unbounded">
+                <xs:annotation>
+                    <xs:documentation>
+                        The element config-property-setting specifies the set of
+                        properties for admin object instance.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
         </xs:sequence>
     </xs:complexType>
 
-
     <!-- **************************************************** -->
 
     <xs:complexType name="config-property-settingType">
         <xs:annotation>
             <xs:documentation>
-
                 The config-property-settingType contains a name-value pair for a
                 config-property or required-config-property
-
             </xs:documentation>
         </xs:annotation>
         <xs:simpleContent>
             <xs:extension base="xs:string">
-                <xs:attribute name="name" type="xs:string" use="required"/>
+                <xs:attribute name="name" type="xs:string" use="required">
+                    <xs:annotation>
+                        <xs:documentation>
+                            The name of the property in name-value pair. It
+                            should match the config-property-name in a
+                            config-property in the adminobject element of the
+                            ra.xml file.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:attribute>
             </xs:extension>
         </xs:simpleContent>
     </xs:complexType>
@@ -167,15 +229,13 @@
     <xs:complexType name="connection-definitionType">
         <xs:annotation>
             <xs:documentation>
-
                 The connection-definitionType defines a set of connection
                 interfaces and classes pertaining to a particular connection
                 type. This also includes configurable properties for
-                ManagedConnectionFactory instances that may be produced out
-                of this set.
+                ManagedConnectionFactory instances that may be produced out of
+                this set.
 
                 The name element uniquely identifies this instance
-
             </xs:documentation>
         </xs:annotation>
 
@@ -184,43 +244,77 @@
                 type="ger:fully-qualified-classType">
                 <xs:annotation>
                     <xs:documentation>
-                        connectionfactory-interface is unique in ra.xml so is used to index into ra.xml
+                        The connectionfactory-interface is unique in ra.xml so
+                        is used to index into ra.xml. It provides the fully
+                        qualified name of java interface used as
+                        connectionfactory for resource adapter.
                     </xs:documentation>
                 </xs:annotation>
             </xs:element>
             <xs:element name="connectiondefinition-instance"
-                type="ger:connectiondefinition-instanceType"
-                minOccurs="0"
-                maxOccurs="unbounded"/>
+                type="ger:connectiondefinition-instanceType" minOccurs="0"
+                maxOccurs="unbounded">
+                <xs:annotation>
+                    <xs:documentation>
+                        The connectiondefinition-instance provides the
+                        configuration for a specific connection.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
         </xs:sequence>
     </xs:complexType>
 
     <xs:complexType name="connectiondefinition-instanceType">
         <xs:sequence>
-            <xs:element name="name"
-                type="xs:string"/>
+            <xs:element name="name" type="xs:string">
+                <xs:annotation>
+                    <xs:documentation>
+                        The unique name of the connection definition instance
+                        used to identify the connection configuration specified
+                        here.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
 
             <xs:element name="implemented-interface"
-                type="ger:fully-qualified-classType"
-                minOccurs="0"
+                type="ger:fully-qualified-classType" minOccurs="0"
                 maxOccurs="unbounded">
                 <xs:annotation>
                     <xs:documentation>
-                        Additional interfaces implemented by the connectionfactory, used by the application
+                        Additional fully qualified name of java interfaces
+                        implemented by the connectionfactory used by the
+                        application apart from the connectionfactory-interface
+                        specified before.
                     </xs:documentation>
                 </xs:annotation>
             </xs:element>
 
             <xs:element name="config-property-setting"
-                type="ger:config-property-settingType"
-                minOccurs="0"
-                maxOccurs="unbounded"/>
-            <!--            <xs:choice>-->
+                type="ger:config-property-settingType" minOccurs="0"
+                maxOccurs="unbounded">
+                <xs:annotation>
+                    <xs:documentation>
+                        The element config-property-setting specifies the set of
+                        properties for connection instance.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
+
+            <!--<xs:choice>-->
+
             <xs:element name="connectionmanager"
                 type="ger:connectionmanagerType">
+                <xs:annotation>
+                    <xs:documentation>
+                        The connectionmanager element specifies the connection
+                        specific settings like transaction, security, and
+                        connection pool.
+                    </xs:documentation>
+                </xs:annotation>
             </xs:element>
-            <!--                <xs:element name="connectionmanager-ref" type="xs:string"/>-->
-            <!--            </xs:choice>-->
+
+            <!--<xs:element name="connectionmanager-ref" type="xs:string"/>-->
+            <!--</xs:choice>-->
 
         </xs:sequence>
     </xs:complexType>
@@ -230,43 +324,193 @@
     <xs:complexType name="connectionmanagerType">
         <xs:annotation>
             <xs:documentation>
-                The ConnectionManager configuration.
+                The connectionmanager element specifies the connection specific
+                settings like transaction, security, and connection pool.
             </xs:documentation>
         </xs:annotation>
 
         <xs:sequence>
-            <xs:element name="container-managed-security" type="ger:emptyType" minOccurs="0"/>
+            <xs:element name="container-managed-security" type="ger:emptyType"
+                minOccurs="0">
+                <xs:annotation>
+                    <xs:documentation>
+                        This empty element indicates that the connection is
+                        authenticated by container and no user authentication is
+                        required. This setting is ignored if res-auth is
+                        provided inr resource-ref.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
             <xs:choice minOccurs="0">
-                <xs:element name="no-transaction" type="ger:emptyType"/>
-                <xs:element name="local-transaction" type="ger:emptyType"/>
-                <xs:element name="xa-transaction" type="ger:xatransactionType"/>
-                <xs:element name="transaction-log" type="ger:emptyType"/>
+                <xs:element name="no-transaction" type="ger:emptyType">
+                    <xs:annotation>
+                        <xs:documentation>
+                            This empty element indicates no participation of
+                            connection in any transactions.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
+                <xs:element name="local-transaction" type="ger:emptyType">
+                    <xs:annotation>
+                        <xs:documentation>
+                            This empty element indicates participation of
+                            connection in only local transactions involving only
+                            this connection.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
+                <xs:element name="xa-transaction"
+                    type="ger:xatransactionType">
+                    <xs:annotation>
+                        <xs:documentation>
+                            The xa-transaction element indicates participation
+                            of connection in multi resource transactions. This
+                            element provides caching information for XA
+                            transaction.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
+                <xs:element name="transaction-log" type="ger:emptyType">
+                    <xs:annotation>
+                        <xs:documentation>
+                            This empty element indicates participation JDBC
+                            resource of local transaction type in XA
+                            transactions.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
             </xs:choice>
             <xs:choice>
-                <xs:element name="no-pool" type="ger:emptyType"/>
-                <xs:element name="single-pool" type="ger:singlepoolType"/>
-                <xs:element name="partitioned-pool" type="ger:partitionedpoolType"/>
+                <xs:element name="no-pool" type="ger:emptyType">
+                    <xs:annotation>
+                        <xs:documentation>
+                            This empty element indicates connection will not be
+                            pooled at all, which mean every connection request
+                            will open a connection for its own purpose.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
+                <xs:element name="single-pool" type="ger:singlepoolType">
+                    <xs:annotation>
+                        <xs:documentation>
+                            This element indicates connection will pooled in
+                            only one connection pool. This element provides
+                            information about single connection pool being
+                            deployed.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
+                <xs:element name="partitioned-pool"
+                    type="ger:partitionedpoolType">
+                    <xs:annotation>
+                        <xs:documentation>
+                            This element indicates connection will pooled in
+                            multiple connection pools. This element provides
+                            information about multiple connection pools being
+                            deployed.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
             </xs:choice>
         </xs:sequence>
     </xs:complexType>
 
     <xs:complexType name="xatransactionType">
         <xs:sequence>
-            <xs:element name="transaction-caching" type="ger:emptyType" minOccurs="0"/>
-            <xs:element name="thread-caching" type="ger:emptyType" minOccurs="0"/>
+            <xs:element name="transaction-caching" type="ger:emptyType"
+                minOccurs="0">
+                <xs:annotation>
+                    <xs:documentation>
+                        This empty element indicates the sharing of same
+                        connection in same transaction if multiple connections
+                        are requested in same transaction.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
+            <xs:element name="thread-caching" type="ger:emptyType"
+                minOccurs="0">
+                <xs:annotation>
+                    <xs:documentation>
+                        This empty element indicates the sharing of same
+                        connection in same thread if multiple connections are
+                        requested in same thread.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
         </xs:sequence>
     </xs:complexType>
 
     <xs:complexType name="singlepoolType">
         <xs:sequence>
-            <xs:element name="max-size" type="xs:int" minOccurs="0"/>
-            <xs:element name="min-size" type="xs:int" minOccurs="0"/>
-            <xs:element name="blocking-timeout-milliseconds" type="xs:int" minOccurs="0"/>
-            <xs:element name="idle-timeout-minutes" type="xs:int" minOccurs="0"/>
+            <xs:element name="max-size" type="xs:int" minOccurs="0">
+                <xs:annotation>
+                    <xs:documentation>
+                        The maximum number of connection in a connection pool
+                        being deployed. The connection pool will stop filling
+                        once reached this value.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
+            <xs:element name="min-size" type="xs:int" minOccurs="0">
+                <xs:annotation>
+                    <xs:documentation>
+                        The minimum number of connection in a connection pool
+                        being deployed. The connection pool will try to fill
+                        itself if the number of connections fall below this
+                        value.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
+            <xs:element name="blocking-timeout-milliseconds" type="xs:int"
+                minOccurs="0">
+                <xs:annotation>
+                    <xs:documentation>
+                        The time after which timeout will be thrown if no
+                        connections are available to be loaned in a connection
+                        pool.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
+            <xs:element name="idle-timeout-minutes" type="xs:int"
+                minOccurs="0">
+                <xs:annotation>
+                    <xs:documentation>
+                        The time after which connection will be automatically
+                        considered released.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
             <xs:choice>
-                <xs:element name="match-one" type="ger:emptyType"/>
-                <xs:element name="match-all" type="ger:emptyType"/>
-                <xs:element name="select-one-assume-match" type="ger:emptyType"/>
+                <xs:element name="match-one" type="ger:emptyType">
+                    <xs:annotation>
+                        <xs:documentation>
+                            This element indicates that only one connection
+                            needs to be checked for matching the connection
+                            request. If the connection does not match, it throws
+                            an error to the effect of "please adjust your
+                            configuration and try again".
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
+                <xs:element name="match-all" type="ger:emptyType">
+                    <xs:annotation>
+                        <xs:documentation>
+                            This element indicates that all the connections need
+                            to be checked for matching the connection request.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
+                <xs:element name="select-one-assume-match"
+                    type="ger:emptyType">
+                    <xs:annotation>
+                        <xs:documentation>
+                            This empty field indicated that no connection
+                            settings need to checked and matched, and assumes
+                            that all connections are same and one of them will
+                            be returned back to client.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
             </xs:choice>
         </xs:sequence>
     </xs:complexType>
@@ -275,8 +519,26 @@
         <complexContent>
             <extension base="ger:singlepoolType">
                 <xs:sequence>
-                    <xs:element name="partition-by-subject" type="ger:emptyType" minOccurs="0"/>
-                    <xs:element name="partition-by-connectionrequestinfo" type="ger:emptyType" minOccurs="0"/>
+                    <xs:element name="partition-by-subject" type="ger:emptyType"
+                        minOccurs="0">
+                        <xs:annotation>
+                            <xs:documentation>
+                                This empty partition-by-subject field indicates
+                                that connection pool has to be partitioned by
+                                subject field.
+                            </xs:documentation>
+                        </xs:annotation>
+                    </xs:element>
+                    <xs:element name="partition-by-connectionrequestinfo"
+                        type="ger:emptyType" minOccurs="0">
+                        <xs:annotation>
+                            <xs:documentation>
+                                This empty partition-by-connectionrequestinfo
+                                field indicates that connection pool has to be
+                                partitioned by connection request information.
+                            </xs:documentation>
+                        </xs:annotation>
+                    </xs:element>
                 </xs:sequence>
             </extension>
         </complexContent>
@@ -287,69 +549,137 @@
     <xs:complexType name="connectorType">
         <xs:annotation>
             <xs:documentation>
-                The connectorType defines a resource adapter.
+                The connector element is the root element of the deployment
+                descriptor for the resource adapter. Note that the sub-elements
+                of this element should be as in the given order in a sequence.
+                It includes geronimo specific information for the resource
+                adapter library.
             </xs:documentation>
         </xs:annotation>
 
         <xs:sequence>
-            <xs:element ref="sys:environment" minOccurs="0"/>
+            <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="resourceadapter" type="ger:resourceadapterType" maxOccurs="unbounded"/>
+            <xs:element name="resourceadapter" type="ger:resourceadapterType"
+                maxOccurs="unbounded">
+                <xs:annotation>
+                    <xs:documentation>
+                        The element resourceadapter defines the resource
+                        adapters for the connector defined in the document.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
 
-            <xs:element name="adminobject" type="ger:adminobjectType" minOccurs="0" maxOccurs="unbounded"/>
+            <xs:element name="adminobject" type="ger:adminobjectType"
+                minOccurs="0" maxOccurs="unbounded">
+                <xs:annotation>
+                    <xs:documentation>
+                        The element adminobject maps back to adminobject defined
+                        in ra.xml. It provides specific instance information for
+                        administer object defined in ra.xml. For example, if
+                        topic is declared in the ra.xml this could provide topic
+                        instance information.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
 
-            <xs:element ref="sys:service" minOccurs="0" maxOccurs="unbounded"/>
+            <xs:element ref="sys:service" minOccurs="0" maxOccurs="unbounded">
+                <xs:annotation>
+                    <xs:documentation>
+                        Reference to service element defined in imported
+                        "geronimo-module-1.2.xsd".
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
         </xs:sequence>
 
     </xs:complexType>
 
     <!-- **************************************************** -->
 
-    <xs:complexType name="emptyType"/>
+    <xs:complexType name="emptyType" />
 
     <!-- **************************************************** -->
 
     <xs:complexType name="outbound-resourceadapterType">
         <xs:annotation>
             <xs:documentation>
-
-                The outbound-resourceadapterType specifies information about
-                an outbound resource adapter. The information includes fully
-                qualified names of classes/interfaces required as part of
-                the connector architecture specified contracts for
-                connection management, level of transaction support
-                provided, one or more authentication mechanisms supported
-                and additional required security permissions.
+                The outbound-resourceadapterType specifies information about an
+                outbound resource adapter. The information includes fully
+                qualified names of classes/interfaces required as part of the
+                connector architecture specified contracts for connection
+                management, level of transaction support provided, one or more
+                authentication mechanisms supported and additional required
+                security permissions.
 
                 If there is no authentication-mechanism specified as part of
                 resource adapter element then the resource adapter does not
-                support any standard security authentication mechanisms as
-                part of security contract. The application server ignores
-                the security part of the system contracts in this case.
-
+                support any standard security authentication mechanisms as part
+                of security contract. The application server ignores the
+                security part of the system contracts in this case.
             </xs:documentation>
         </xs:annotation>
 
         <xs:sequence>
             <xs:element name="connection-definition"
-                type="ger:connection-definitionType"
-                maxOccurs="unbounded"/>
+                type="ger:connection-definitionType" maxOccurs="unbounded">
+                <xs:annotation>
+                    <xs:documentation>
+                        The connection-definitionType defines a set of
+                        connection interfaces and classes pertaining to a
+                        particular connection type. This also includes
+                        configurable properties for ManagedConnectionFactory
+                        instances that may be produced out of this set.
+
+                        The name element uniquely identifies this instance.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
         </xs:sequence>
     </xs:complexType>
 
-
     <!-- **************************************************** -->
 
     <xs:complexType name="resourceadapterType">
-
         <xs:sequence>
             <xs:element name="resourceadapter-instance"
-                type="ger:resourceadapter-instanceType"
-                minOccurs="0">
+                type="ger:resourceadapter-instanceType" minOccurs="0">
+                <xs:annotation>
+                    <xs:documentation>
+                        The resourceadapter instance provide resource adapter
+                        instance specific information like configuration
+                        properties and workmanager implementation.
+                    </xs:documentation>
+                </xs:annotation>
             </xs:element>
             <xs:element name="outbound-resourceadapter"
-                type="ger:outbound-resourceadapterType"
-                minOccurs="0">
+                type="ger:outbound-resourceadapterType" minOccurs="0">
+                <xs:annotation>
+                    <xs:documentation>
+                        The outbound-resourceadapterType specifies information
+                        about an outbound resource adapter. The information
+                        includes fully qualified names of classes/interfaces
+                        required as part of the connector architecture specified
+                        contracts for connection management, level of
+                        transaction support provided, one or more authentication
+                        mechanisms supported and additional required security
+                        permissions.
+
+                        If there is no authentication-mechanism specified as
+                        part of resource adapter element then the resource
+                        adapter does not support any standard security
+                        authentication mechanisms as part of security contract.
+                        The application server ignores the security part of the
+                        system contracts in this case.
+                    </xs:documentation>
+                </xs:annotation>
             </xs:element>
         </xs:sequence>
     </xs:complexType>
@@ -357,36 +687,56 @@
     <xs:complexType name="resourceadapter-instanceType">
         <xs:annotation>
             <xs:documentation>
-                The resourceadapter instance info is put in a separate optional element
-                to provide easier more consistent support for 1.0 adapters.
+                The resourceadapter instance info is put in a separate optional
+                element to provide easier more consistent support for 1.0
+                adapters. The resourceadapter instance provide resource adapter
+                instance specific information like configuration properties and
+                workmanager implementation.
             </xs:documentation>
         </xs:annotation>
         <xs:sequence>
-            <xs:element name="resourceadapter-name" type="xs:string"/>
+            <xs:element name="resourceadapter-name" type="xs:string">
+                <xs:annotation>
+                    <xs:documentation>
+                        The element resourceadapter-name provides a name for
+                        this resource adapter, and it is used to index back to
+                        the resourceadapter-name specified in ra.xml.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
             <xs:element name="config-property-setting"
-                type="ger:config-property-settingType"
-                minOccurs="0"
-                maxOccurs="unbounded"/>
-            <xs:element ref="naming:workmanager"/>
+                type="ger:config-property-settingType" minOccurs="0"
+                maxOccurs="unbounded">
+                <xs:annotation>
+                    <xs:documentation>
+                        The element config-property-setting specifies the set of
+                        properties for resource adapter instance.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
+            <xs:element ref="naming:workmanager">
+                <xs:annotation>
+                    <xs:documentation>
+                        Reference to workmanager element defined in imported
+                        "geronimo-naming-1.2.xsd"
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
         </xs:sequence>
     </xs:complexType>
 
-
-
     <!-- types borrowed from the j2ee schema.  We might want to centralize  these -->
 
     <xs:simpleType name="fully-qualified-classType">
-        <xs:restriction base="xs:string"/>
+        <xs:restriction base="xs:string" />
     </xs:simpleType>
 
     <xs:complexType name="descriptionType">
         <xs:simpleContent>
             <xs:extension base="xs:string">
-                <xs:attribute ref="xml:lang"/>
+                <xs:attribute ref="xml:lang" />
             </xs:extension>
         </xs:simpleContent>
     </xs:complexType>
 
-
 </xs:schema>
-

Modified: geronimo/server/trunk/modules/geronimo-j2ee-builder/src/main/schema/geronimo-application-1.2.xsd
URL: http://svn.apache.org/viewvc/geronimo/server/trunk/modules/geronimo-j2ee-builder/src/main/schema/geronimo-application-1.2.xsd?view=diff&rev=511458&r1=511457&r2=511458
==============================================================================
--- geronimo/server/trunk/modules/geronimo-j2ee-builder/src/main/schema/geronimo-application-1.2.xsd (original)
+++ geronimo/server/trunk/modules/geronimo-j2ee-builder/src/main/schema/geronimo-application-1.2.xsd Sat Feb 24 22:29:15 2007
@@ -1,15 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-
     Licensed to the Apache Software Foundation (ASF) under one or more
     contributor license agreements.  See the NOTICE file distributed with
     this work for additional information regarding copyright ownership.
     The ASF licenses this file to You 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
-
+    
+        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.
@@ -21,126 +20,361 @@
     xmlns:geronimo="http://geronimo.apache.org/xml/ns/j2ee/application-1.2"
     targetNamespace="http://geronimo.apache.org/xml/ns/j2ee/application-1.2"
     xmlns:sys="http://geronimo.apache.org/xml/ns/deployment-1.2"
-    xmlns:xs="http://www.w3.org/2001/XMLSchema"
-    elementFormDefault="qualified"
-    attributeFormDefault="unqualified"
-    version="1.0">
-    <!--xmlns:security="http://geronimo.apache.org/xml/ns/security-1.2"-->
+    xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"
+    attributeFormDefault="unqualified" version="1.0">
 
+    <xs:annotation>
+        <xs:documentation>
+            This is an XML Schema Definition for Geronimo enterprise application
+            deployment plan. In case the enterprise application deployment plan
+            is provided internally in the enterprise archive, it should be
+            located under META-INF/geronimo-application.xml. In case the
+            enterprise application deployment plan is provided externally, the
+            deployment descriptor can be named anything and provided as an
+            argument to the deploy tool. All the enterprise application
+            deployment plan must specify the top level element as application
+            with namespace specified as xmlns =
+            "http://geronimo.apache.org/xml/ns/j2ee/application-1.2". The
+            default location for this document is
+            http://geronimo.apache.org/schemas-1.2/geronimo-application-1.2.xsd
+        </xs:documentation>
+    </xs:annotation>
+
+    <!--xmlns:security="http://geronimo.apache.org/xml/ns/security-1.2"-->
     <!--<xs:import namespace="http://geronimo.apache.org/xml/ns/security-1.2" schemaLocation="geronimo-security-1.2.xsd"/>-->
-    <xs:import namespace="http://geronimo.apache.org/xml/ns/deployment-1.2" schemaLocation="geronimo-module-1.2.xsd"/>
 
-    <xs:element name="application" type="geronimo:applicationType"/>
+    <xs:import namespace="http://geronimo.apache.org/xml/ns/deployment-1.2"
+        schemaLocation="geronimo-module-1.2.xsd">
+        <xs:annotation>
+            <xs:documentation>
+                Import Geronimo Services deployment plans. The imported plan
+                includes complex types like moduleType, environmentType,
+                dependenciesType, etc. required by this plan schema.
+            </xs:documentation>
+        </xs:annotation>
+    </xs:import>
 
+    <xs:element name="application" type="geronimo:applicationType">
+        <xs:annotation>
+            <xs:documentation>
+                The root element for Geronimo web application deployment plan.
+                This element should always exist in instance documents. Note
+                that the sub-elements of this element should be as in the given
+                order in the sequence.
+            </xs:documentation>
+        </xs:annotation>
+    </xs:element>
     <xs:complexType name="applicationType">
+        <xs:annotation>
+            <xs:documentation>
+                The complex type for root element, it defines the elements of
+                root element for Geronimo enterprise application deployment
+                plan. Basically it is a sequence of elements environment,
+                module, ext-module, security, and services.
+            </xs:documentation>
+        </xs:annotation>
         <xs:sequence>
-            <xs:element ref="sys:environment"/>
+            <xs:element ref="sys:environment">
+                <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="module" type="geronimo:moduleType" minOccurs="0"
+                maxOccurs="unbounded">
+                <xs:annotation>
+                    <xs:documentation>
+                        An optional module element which defines various
+                        modules included in the enterprise application archive.
+                        It mirrors the moduleType defined by application_1_4.xsd
+                        and adds an optional alt-dd element defining a Geronimo
+                        specific deployment descriptor.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
+            <xs:element name="ext-module" type="geronimo:ext-moduleType"
+                minOccurs="0" maxOccurs="unbounded">
+                <xs:annotation>
+                    <xs:documentation>
+                        It is used to define modules included in this
+                        application externally and these module could be
+                        included in the archive, or they may reside in Geronimo
+                        repository. It defines optional internal-path or
+                        external-path to module/repository element being
+                        referenced.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
 
-            <xs:element name="module" type="geronimo:moduleType" minOccurs="0" maxOccurs="unbounded"/>
-            <xs:element name="ext-module" type="geronimo:ext-moduleType" minOccurs="0" maxOccurs="unbounded"/>
             <!--<xs:element ref="security:security" minOccurs="0"/>-->
             <!--<xs:any namespace="http://geronimo.apache.org/xml/ns/security-1.2" processContents="lax" minOccurs="0"/>-->
             <!--<xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>-->
-            <xs:element ref="geronimo:security" minOccurs="0"/>
-            <xs:element ref="sys:service" minOccurs="0" maxOccurs="unbounded"/>
+
+            <xs:element ref="geronimo:security" minOccurs="0">
+                <xs:annotation>
+                    <xs:documentation>
+                        Reference to security element defined in this schema. If
+                        this optional element is present, all web and EJB
+                        modules must make the appropriate access checks as
+                        outlined in the JACC spec. This element groups the
+                        security role mapping settings for the application.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
+            <xs:element ref="sys:service" minOccurs="0" maxOccurs="unbounded">
+                <xs:annotation>
+                    <xs:documentation>
+                        Reference to service element defined in imported
+                        "geronimo-module-1.2.xsd".
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
         </xs:sequence>
 
         <!--TODO application name should be settable using name-key in the environment.  Does this work? -->
-        <xs:attribute name="application-name" type="xs:string" use="optional"/>
+        <xs:attribute name="application-name" type="xs:string" use="optional">
+            <xs:annotation>
+                <xs:documentation>
+                    An optional attribute used to define the application name
+                    for main parent enterprise application defined in ear
+                    module.
+                </xs:documentation>
+            </xs:annotation>
+        </xs:attribute>
     </xs:complexType>
 
     <xs:complexType name="moduleType">
         <xs:annotation>
             <xs:documentation>
-	Mirrors the moduleType defined by application_1_4.xsd and adds an
-	optional alt-dd element defining a Geronimo specific deployment descriptor.
+                Mirrors the moduleType defined by application_1_4.xsd and adds
+                an optional alt-dd element defining a Geronimo specific
+                deployment descriptor for J2EE connector, ejb, web, or java
+                client modules.
             </xs:documentation>
         </xs:annotation>
         <xs:sequence>
             <xs:choice>
-                <xs:element name="connector" type="geronimo:pathType"/>
-                <xs:element name="ejb" type="geronimo:pathType"/>
-                <xs:element name="java" type="geronimo:pathType"/>
-                <xs:element name="web" type="geronimo:pathType"/>
+                <xs:element name="connector" type="geronimo:pathType">
+                    <xs:annotation>
+                        <xs:documentation>
+                            The presence of this element is indicative of J2EE
+                            module type to be resource adapter module, and the
+                            value of this element provides URI of resource
+                            adapter archive file path relative to the enterprise
+                            application package main directory.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
+                <xs:element name="ejb" type="geronimo:pathType">
+                    <xs:annotation>
+                        <xs:documentation>
+                            The presence of this element is indicative of J2EE
+                            module type to be EJB module, and the value of this
+                            element provides URI of EJB archive file path
+                            relative to the enterprise application package main
+                            directory.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
+                <xs:element name="java" type="geronimo:pathType">
+                    <xs:annotation>
+                        <xs:documentation>
+                            The presence of this element is indicative of J2EE
+                            module type to be Java Application client module,
+                            and the value of this element provides URI of
+                            application client java archive file path relative
+                            to the enterprise application package main
+                            directory.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
+                <xs:element name="web" type="geronimo:pathType">
+                    <xs:annotation>
+                        <xs:documentation>
+                            The presence of this element is indicative of Web
+                            module type to be EJB module, and the value of this
+                            element provides URI of Web archive file path
+                            relative to the enterprise application package main
+                            directory.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
             </xs:choice>
             <xs:choice>
                 <xs:element name="alt-dd" type="geronimo:pathType">
                     <xs:annotation>
                         <xs:documentation>
-  Specifies an optional URI to the post-assembly version of the Geronimo
-  specific deployment descriptor file for a particular J2EE module.
+                            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.
                         </xs:documentation>
                     </xs:annotation>
                 </xs:element>
-                <xs:any namespace="##other" processContents="lax"/>
+                <xs:any namespace="##other" processContents="lax">
+                    <xs:annotation>
+                        <xs:documentation>
+                            This option element contains the alternate geronimo
+                            deployment plan for included modules.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:any>
             </xs:choice>
         </xs:sequence>
     </xs:complexType>
 
-
-    <xs:element name="security" type="geronimo:abstract-securityType"/>
+    <xs:element name="security" type="geronimo:abstract-securityType">
+        <xs:annotation>
+            <xs:documentation>
+                If this optional element is present, all web and EJB modules
+                must make the appropriate access checks as outlined in the JACC
+                spec. This element groups the security role mapping settings for
+                the application.
+            </xs:documentation>
+        </xs:annotation>
+    </xs:element>
 
     <xs:complexType name="abstract-securityType" abstract="true">
-        <xs:sequence>
-        </xs:sequence>
+        <xs:annotation>
+            <xs:documentation>
+                An abstract abstract-securityType used to indicate, all web and
+                EJB modules must make the appropriate access checks as outlined
+                in the JACC spec. This type will be extended and implemented by
+                geronimo-security-1.2.xsd file.
+            </xs:documentation>
+        </xs:annotation>
+        <xs:sequence></xs:sequence>
     </xs:complexType>
 
-    <xs:element name="clustering" type="geronimo:abstract-clusteringType"/>
-    
+    <xs:element name="clustering" type="geronimo:abstract-clusteringType">
+        <xs:annotation>
+            <xs:documentation>
+                An abstract clustering used to provide clustering informtation
+                for this application.
+            </xs:documentation>
+        </xs:annotation>
+    </xs:element>
+
     <xs:complexType name="abstract-clusteringType" abstract="true">
-        <xs:sequence>
-        </xs:sequence>
+        <xs:sequence></xs:sequence>
     </xs:complexType>
 
     <xs:complexType name="ext-moduleType">
         <xs:annotation>
             <xs:documentation>
-	Mirrors the moduleType defined by application_1_4.xsd and adds an
-	optional alt-dd element defining a Geronimo specific deployment descriptor.
+                It is used to define modules included in this application
+                externally and is not a part of the archive. It defines optional
+                internal-path or external-path to module/repository element
+                being referenced.
             </xs:documentation>
         </xs:annotation>
         <xs:sequence>
             <xs:choice>
-                <xs:annotation>
-                    <xs:documentation>
-            This is the name for the module, not the path inside the ear.
-                    </xs:documentation>
-                </xs:annotation>
-                <xs:element name="connector" type="geronimo:pathType"/>
-                <xs:element name="ejb" type="geronimo:pathType"/>
-                <xs:element name="java" type="geronimo:pathType"/>
-                <xs:element name="web" type="geronimo:pathType"/>
+                <xs:element name="connector" type="geronimo:pathType">
+                    <xs:annotation>
+                        <xs:documentation>
+                            The presence of this element is indicative of J2EE
+                            module type to be resource adapter module, and the
+                            value of this element provides URI of resource
+                            adapter archive file path relative to the enterprise
+                            application package main directory.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
+                <xs:element name="ejb" type="geronimo:pathType">
+                    <xs:annotation>
+                        <xs:documentation>
+                            The presence of this element is indicative of J2EE
+                            module type to be EJB module, and the value of this
+                            element provides URI of EJB archive file path
+                            relative to the enterprise application package main
+                            directory.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
+                <xs:element name="java" type="geronimo:pathType">
+                    <xs:annotation>
+                        <xs:documentation>
+                            The presence of this element is indicative of J2EE
+                            module type to be Java Application client module,
+                            and the value of this element provides URI of
+                            application client java archive file path relative
+                            to the enterprise application package main
+                            directory.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
+                <xs:element name="web" type="geronimo:pathType">
+                    <xs:annotation>
+                        <xs:documentation>
+                            The presence of this element is indicative of Web
+                            module type to be EJB module, and the value of this
+                            element provides URI of Web archive file path
+                            relative to the enterprise application package main
+                            directory.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
             </xs:choice>
             <xs:choice>
-                <xs:element name="internal-path" type="xs:token"/>
-                <xs:element name="external-path" type="xs:token"/>
+                <xs:element name="internal-path" type="xs:token">
+                    <xs:annotation>
+                        <xs:documentation>
+                            The element indicates that the module is a part of
+                            this enterprise application. The value of this
+                            element specifies the path of module relative to
+                            internal path indicates that the module is packaged
+                            in the EAR, and a path specified here is relative to
+                            the enterprise application package main directory.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
+                <xs:element name="external-path" type="xs:token">
+                    <xs:annotation>
+                        <xs:documentation>
+                            The element indicates that the module is not a part
+                            of this enterprise application, and used from
+                            Geronimo repository. The value of this element
+                            specifies the URI of module in a Geronimo
+                            repository.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:element>
             </xs:choice>
+
             <!--TODO consider an alt-spec-dd element-->
             <!--Do not allow vendor plan inside ear.  If it is in the ear, this does not need to be an external module -->
-            <xs:any namespace="##other" processContents="lax"/>
+            <xs:any namespace="##other" processContents="lax">
+                <xs:annotation>
+                    <xs:documentation>
+                        This option element contains the geronimo deployment
+                        plan for included modules. The geronimo deployment plan
+                        for included modules can be packaged with module.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:any>
         </xs:sequence>
     </xs:complexType>
 
     <xs:complexType name="pathType">
         <xs:annotation>
-            <xs:documentation>
-  Mirrors j2ee:pathType.
-            </xs:documentation>
+            <xs:documentation>Mirrors j2ee:pathType.</xs:documentation>
         </xs:annotation>
         <xs:simpleContent>
-            <xs:restriction base="geronimo:string"/>
+            <xs:restriction base="geronimo:string" />
         </xs:simpleContent>
     </xs:complexType>
 
     <xs:complexType name="string">
         <xs:annotation>
-            <xs:documentation>
-   Mirrors j2ee:string.
-            </xs:documentation>
+            <xs:documentation>Mirrors j2ee:string.</xs:documentation>
         </xs:annotation>
         <xs:simpleContent>
             <xs:extension base="xs:token">
-                <xs:attribute name="id" type="xs:ID"/>
+                <xs:attribute name="id" type="xs:ID" />
             </xs:extension>
         </xs:simpleContent>
     </xs:complexType>



Mime
View raw message