Versions Compared

Old Version 59

changes.mady.by.user Hernan Cunico

Saved on

compared with

New Version 60

changes.mady.by.user Hernan Cunico

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

Wiki Markup
{scrollbar}
Anchor
top
top

The following article describes the XML Schema for the geronimo-application-client.xsd deployment descriptor. In order to deploy an application client JAR, a Geronimo specific deployment plan called "geronimo-application-client.xml" is required. If the deployment plan for the client JAR is included in the client JAR, then it should be named "META-INF/geronimo-application-client.xml". The geronimo application client deployment descriptor describes the EJB components and external resources referenced by the application client.

Geronimo application client XML Schema Document

Code Block
xml
xml
borderStylesolid
titlegeronimo-application-client-1.1.xsd

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

    Copyright 2004 The Apache Software Foundation

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

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

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
-->
<!-- @version $Rev: 409817 $ $Date: 2006-05-27 03:56:38 -0400 (Sat, 27 May 2006) $ -->
<xs:schema
    xmlns:geronimo="http://geronimo.apache.org/xml/ns/j2ee/application-client-1.1"
    targetNamespace="http://geronimo.apache.org/xml/ns/j2ee/application-client-1.1"
    xmlns:naming="http://geronimo.apache.org/xml/ns/naming-1.1"
    xmlns:connector="http://geronimo.apache.org/xml/ns/j2ee/connector-1.1"
    xmlns:security="http://geronimo.apache.org/xml/ns/security-1.1"
    xmlns:sys="http://geronimo.apache.org/xml/ns/deployment-1.1"
    xmlns: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.1" schemaLocation="geronimo-naming-1.1.xsd"/>
    <xs:import namespace="http://geronimo.apache.org/xml/ns/security-1.1" schemaLocation="geronimo-security-1.1.xsd"/>
    <xs:import namespace="http://geronimo.apache.org/xml/ns/j2ee/connector-1.1" schemaLocation="geronimo-connector-1.1.xsd"/>
    <xs:import namespace="http://geronimo.apache.org/xml/ns/deployment-1.1" schemaLocation="geronimo-module-1.1.xsd"/>

    <xs:element name="application-client" type="geronimo:application-clientType"/>

    <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:sequence minOccurs="0">
                <xs:element name="realm-name" type="xs:string"/>
                <xs:element name="callback-handler" type="xs:string" minOccurs="0"/>
            </xs:sequence>


            <xs:element name="resource" type="geronimo:resourceType" minOccurs="0" maxOccurs="unbounded"/>

            <xs:element ref="sys:gbean" minOccurs="0" maxOccurs="unbounded"/>
        </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:choice>
            <xs:element ref="connector:connector"/>
        </xs:sequence>
    </xs:complexType>


</xs:schema>

Schema Document Properties
Anchor
schema
schema

Target Namespace

http://geronimo.apache.org/xml/ns/j2ee/application-client-1.1

Version

1.1

Element and Attribute Namespaces

*Global element and attribute declarations belong to this schema's
target namespace.
*By default, local element declarations belong to this schema's target
namespace.
*By default, local attribute declarations have no namespace.

Schema Composition

*This schema imports schema(s) from the following namespace(s):

http://geronimo.apache.org/xml/ns/naming-1.1(at

geronimo-naming-1.1.xsd)

http://geronimo.apache.org/xml/ns/security-1.1(at

geronimo-security-1.1.xsd)

http://geronimo.apache.org/xml/ns/j2ee/connector-1.1(at

geronimo-connector-1.1.xsd)

http://geronimo.apache.org/xml/ns/deployment-1.1(at

geronimo-config-1.1.xsd)

Declared Namespaces

Prefix

Namespace

xml

http://www.w3.org/XML/1998/namespace

geronimo

http://geronimo.apache.org/xml/ns/j2ee/application-client-1.1

naming

http://geronimo.apache.org/xml/ns/naming-1.1

connector

http://geronimo.apache.org/xml/ns/j2ee/connector-1.1

security

http://geronimo.apache.org/xml/ns/security-1.1

sys

http://geronimo.apache.org/xml/ns/deployment-1.1

xs

http://www.w3.org/2001/XMLSchema

Schema Component Representation

Code Block
xml
xml
borderStylesolid
titleSchema Component Representation
<xs:schema
    xmlns:geronimo="http://geronimo.apache.org/xml/ns/j2ee/application-client-1.1"
    targetNamespace="http://geronimo.apache.org/xml/ns/j2ee/application-client-1.1"
    elementFormDefault="qualified"
    attributeFormDefault="unqualified"
    <xs:import namespace="http://geronimo.apache.org/xml/ns/naming-1.1" schemaLocation="geronimo-naming-1.1.xsd"/>
    <xs:import namespace="http://geronimo.apache.org/xml/ns/security-1.1" schemaLocation="geronimo-security-1.1.xsd"/>
    <xs:import namespace="http://geronimo.apache.org/xml/ns/j2ee/connector-1.1" schemaLocation="geronimo-connector-1.1.xsd"/>
    <xs:import namespace="http://geronimo.apache.org/xml/ns/deployment-1.1" schemaLocation="geronimo-module-1.1.xsd"/>

    <xs:element name="application-client" type="geronimo:application-clientType"/>
........
</xs:schema>

Global Declarations
Anchor
global
global

Element: application-client
Anchor
appclient
appclient

Name

application-client

Type

Geronimo:application-clientType

Nillable

no

Abstract

no

Code Block
xml
xml
borderStylesolid
titleXML Instance Representation: application-client
 Code Block
xml
xml
borderStylesolid
titleSchema Component Representation: application-client
<xs:element name="application-client" type="geronimo:application-clientType"/>

Global Definitions
 Anchor
globaldef
globaldef
Complex Type: application-clientType
 Anchor
appClientType
appClientType
Super-types:
None
Sub-types: 
None
Name 
application-clientType
Abstract 
no
 Code Block
xml
xml
borderStylesolid
titleXML Instance Representation: application-clientType
 Code Block
xml
xml
borderStylesolid
titleSchema Component Representation: application-clientType
 <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:sequence minOccurs="0">
                <xs:element name="realm-name" type="xs:string"/>
                <xs:element name="callback-handler" type="xs:string" minOccurs="0"/>
            </xs:sequence>


            <xs:element name="resource" type="geronimo:resourceType" minOccurs="0" maxOccurs="unbounded"/>

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

    </xs:complexType>


Complex Type: resourceType
 Anchor
resourceType
resourceType
Super-types:None
Sub-types: None 
Name 
resourceType
Abstract 
no
 Code Block
xml
xml
borderStylesolid
titleXML Instance Representation: resourceType
<...> 
 Start Choice [1]  
 
<geronimo:external-rar>  xs:string </geronimo:external-rar> [1] 
<geronimo:internal-rar>  xs:string </geronimo:internal-rar> [1] 
End Choice 
 
<connector:connector> ... </connector:connector> [1] 
</...>

 Code Block
xml
xml
borderStylesolid
titleSchema Component Representation: resourceType
 <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:choice>
            <xs:element ref="connector:connector"/>
        </xs:sequence>
    </xs:complexType>

Legend
 Anchor
legend
legend
Complex Type: AusAddress 
Schema Component Type
Schema Component Name
 Super-types: 
 Address < AusAddress (by extension)
 Sub-types: 
 QLDAddress (by restriction)
 Note
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name 
AusAddress
Abstract 
no
The table above displays the properties of this schema component.
 Code Block
xml
xml
borderStylesolid
titleXML Instance Represenation: AusAddress
<...   country="Australia" > 
 <unitNo> string </unitNo> [0..1]  
 <houseNo> string </houseNo> [1]  
 <street> string </street> [1]  
 Start Choice [1]  
 <city> string </city> [1]  
 <town> string </town> [1]  
 End Choice 
  <state> AusStates </state> [1]  
 <postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] ?  
  </...> 

The XML Instance Representation table above shows the schema component's content as an XML instance.
 The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. 0..1.
  • Model group information are shown in gray, e.g. Start Choice ... End Choice.
     For type derivations, the elements and attributes that have been added to or changed from the base 
     type's content are shown in bold.
  • If an element/attribute has a fixed value, the fixed value is shown in green, e.g. country="Australia".
     Otherwise, the type of the element/attribute is displayed. 
  • If the element/attribute's type is in the schema, a link is provided to it.
     For local simple type definitions, the constraints are displayed in angle brackets, 
     e.g. <pattern = [1-9][0-9]{3}/>.
  • If a local element/attribute has documentation, it will be displayed in a window that pops up when the
     question mark inside the attribute or next to the element is clicked, e.g. <postcode>.
 Code Block
xml
xml
borderStylesolid
titleSchema Component Representation: AusAddress
<complexType name="AusAddress"> 
 <complexContent> 
 <extension base=" Address "> 
 <sequence> 
 <element name="state" type=" AusStates "/> 
 <element name="postcode"> 
 <simpleType> 
 <restriction base=" string "> 
 <pattern value="[1-9][0-9]{3}"/> 
 </restriction> 
 </simpleType> 
 </element> 
 </sequence> 
 <attribute name="country" type=" string " fixed="Australia"/> 
 </extension> 
 </complexContent> 
 </complexType> 

The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
Glossary
 Anchor
glossary
glossary
Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.
All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.
Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.
Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.
Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.
Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.
Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.
Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.
Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.
Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.
Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.
Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.
*Prohibited Substitutions *(Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.
Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).
 Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.
Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.
Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.
Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.
Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.