Return-Path: X-Original-To: apmail-geronimo-scm-archive@www.apache.org Delivered-To: apmail-geronimo-scm-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id CA8064E37 for ; Tue, 21 Jun 2011 03:47:10 +0000 (UTC) Received: (qmail 48698 invoked by uid 500); 21 Jun 2011 03:47:10 -0000 Delivered-To: apmail-geronimo-scm-archive@geronimo.apache.org Received: (qmail 48578 invoked by uid 500); 21 Jun 2011 03:47:07 -0000 Mailing-List: contact scm-help@geronimo.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: List-Post: Reply-To: dev@geronimo.apache.org List-Id: Delivered-To: mailing list scm@geronimo.apache.org Received: (qmail 47908 invoked by uid 99); 21 Jun 2011 03:46:58 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 21 Jun 2011 03:46:58 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 21 Jun 2011 03:46:49 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id CAB1323889F7; Tue, 21 Jun 2011 03:46:26 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1137853 [2/29] - in /geronimo/site/trunk/docs/schemas-3.0: ./ docs/ docs/schemaDiagrams/ Date: Tue, 21 Jun 2011 03:46:22 -0000 To: scm@geronimo.apache.org From: chirunhua@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20110621034626.CAB1323889F7@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: geronimo/site/trunk/docs/schemas-3.0/docs/attributes-1.2.xsd.html URL: http://svn.apache.org/viewvc/geronimo/site/trunk/docs/schemas-3.0/docs/attributes-1.2.xsd.html?rev=1137853&view=auto ============================================================================== --- geronimo/site/trunk/docs/schemas-3.0/docs/attributes-1.2.xsd.html (added) +++ geronimo/site/trunk/docs/schemas-3.0/docs/attributes-1.2.xsd.html Tue Jun 21 03:46:00 2011 @@ -0,0 +1,1669 @@ + + + + + + + Schema documentation: Apache Geronimo + + + + + + + + + +
+ + +   +
+ + + + + + + + +
  + Apache Geronimo >  + Index >  + Development >  + XML Schemas >  + Apache Geronimo v2.2 XML Schemas + + User List | + Dev List | + Wiki | + Issue Tracker   +
+ + + + + +
+ + + + + + +
+ + + + + + + + + +
+ +   Overview + +
+ + + + + +
+ Home
+ License
+ ASF
+ Project Policies
+ Downloads
+ Documentation
+ News Archive +
+
+
+ +
+ + + + + + + +
+ + + + + + + + + +
+ +   Search + +
+ + + + + + + +
+
+ + + + + + +
+ +
+ Powered by Google Search + +
+
+
+
+ +
+ + + + + +
+ + + + + + + +
+ +   Community + +
+ + + + + +
+ Events
+ Get Involved
+ Committers
+ Mailing Lists
+ Discussion Forums
+ IRC
+ FAQ
+ Wiki
+ Found a Bug?
+ Service and Support
+ ASF Sponsorship
+ ASF Thanks! +
+
+
+ +
+ + + + + +
+ + + + + + + +
+ +   Development + +
+ + + + + +
+ Javadoc
+ XML Schemas
+ Source Code
+ Coding Standards
+ Issue Tracker
+ Related Projects
+ Sample Applications +
+
+
+ +
+ + + + + +
+ + + + + + + +
+ +   Subprojects + +
+ + + + + +
+ Development Tools
+ GBuild
+ GShell
+ XBean +
+
+
+ +
+ + + + + 		+ + + + + + + + +

+ Documentation for attributes-1.2 +

+

Table of Contents

+ + + +
+ top +
+
+

+ Schema Document Properties +

+ + + + + + + + + + + + + +
+ Target Namespace + + http://geronimo.apache.org/xml/ns/attributes-1.2 +
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.
    • +
+
Documentation + This is an XML Schema Definition for storing manageable attribute + values. All the schema's or plans using elements of this schema must + specify the top level element with one of the namespace specified as + "http://geronimo.apache.org/xml/ns/attributes-1.2". The default + location for this document is: + http://geronimo.apache.org/xml/ns/attributes-1.2 + + The definition of the XML format for storing manageable attribute + values. Should look like this: + + <attributes> + <comment>Comment for the whole attribute</comment> + <module name="mygroup/mycomponent/1.1/jar"> + <comment>Comment specific to the module</comment> + <gbean name="MyNetworkService"> + <comment>Comment for the gbean</comment> + <attribute name="host">0.0.0.0</attribute> + <attribute name="port">1234</attribute> + </gbean> + </module> + </attributes> + +
+

Declared Namespaces

+ + + + + + + + + + + + + + + + + +
PrefixNamespace
+ xml + http://www.w3.org/XML/1998/namespace
+ atts + + http://geronimo.apache.org/xml/ns/attributes-1.2 +
+ xsd + http://www.w3.org/2001/XMLSchema
+
+
+ Schema Component Representation +
+
+
<xsd:schema + targetNamespace="http://geronimo.apache.org/xml/ns/attributes-1.2" elementFormDefault="qualified" attributeFormDefault="unqualified">
...
</xsd:schema>
+
+
+
+ top +
+
+

+ Global Declarations +

+

Element: attribute +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Nameattribute
Used by (from the same schema document)Complex Type + gbeanType + +
Type + + atts:attributeType + +
+ Nillable + no
+ Abstract + no
Documentation + gbean attribute as an element for ease in jaxb serialization to string. +
+
+
+ XML Instance Representation +
+
+
<atts:attribute
+ name="anySimpleType + [1] +

'The name attribute provides the name of single attribute.'

" +
+ null=" + xsd:boolean + [0..1] +

'The null attribute defines if this atribute is null or not.'

" +
+ propertyEditor=" + xsd:string + [0..1] +

'The propertyEditor attribute defines the property editor class to be used to get the value of this attribute based on its string representation. If no editor is specified, then the type of the attribute, as declared by GBeanAttribute, is used to find a propertyEditor through the standard JavaBean search strategy.'

">
+ <!-- Mixed content --> +
+
<!-- ' + xsd:anyType' super type was not found in this schema. Some elements and attributes may be missing. -->
+
Allow any elements from any namespace (lax validation). [0..*] +
</atts:attribute>
+
+
+
+
+ Diagram +
+
+ + + +
+
+
+
+ Schema Component Representation +
+
+
<xsd:element + name="attribute" type=" + + atts:attributeType + + "/>
+
+
+
+ top +
+
+

Element: attributes +

+ + + + + + + + + + + + + + + + + + + + + +
Nameattributes
Type + + atts:attributesType + +
+ Nillable + no
+ Abstract + no
Documentation + Provides the definition of named attributes. Attributes are + mixed type and can include simple text and elements. +
+
+
+ XML Instance Representation +
+
+
<atts:attributes>
+
<atts:comment> + xsd:string </atts:comment> [0..1] +
+ Start Choice + [1] + +
+
<atts:module> + atts:moduleType + </atts:module> [0..*] +
+
<atts:configuration> + atts:moduleType + </atts:configuration> [0..*] +
+ End Choice +
</atts:attributes>
+
+
+
+
+ Diagram +
+
+ + + h-391482901 + + h-391482901 + + +
+
+
+
+ Schema Component Representation +
+
+
<xsd:element + name="attributes" type=" + + atts:attributesType + + "/>
+
+
+
+ top +
+
+

Element: comment +

+ + + + + + + + + + + + + + + + + +
Namecomment
Type + + xsd:string +
+ Nillable + no
+ Abstract + no
+
+
+ XML Instance Representation +
+
+
<atts:comment> + xsd:string </atts:comment>
+
+
+
+
+ Diagram +
+
+ + + +
+
+
+
+ Schema Component Representation +
+
+
<xsd:element + name="comment" type=" + + xsd:string + "/>
+
+
+
+ top +
+
+

Element: gbean +

+ + + + + + + + + + + + + + + + + + + + + +
Namegbean
Type + + atts:gbeanType + +
+ Nillable + no
+ Abstract + no
Documentation + Element used by the plugin system to list individual GBeans. + Note that the name attribute for a gbean element may hold either + the full GBeanName, or only the value for the "name=" portion of + the GBeanName. If there are multiple GBeans in the module with + manageable attributes and the same "name=" portion of the + GBeanName, then all must be listed and all must be listed with a + full GBeanName. +
+
+
+ XML Instance Representation +
+
+
<atts:gbean
+ name=" + xsd:string + [1] +

'The name attribute specifies the name portion of the GBeanName.'

" +
+ gbeanInfo=" + xsd:string + [0..1] +

'The gbeanInfo attribute provide the gbean infomation for specified GBean.'

" +
+ load=" + xsd:boolean + [0..1] +

'The load attribute specifies if the gbean is to be loaded or not.'

">
+
<atts:comment> + xsd:string </atts:comment> [0..1] +
+ Start Choice + [0..*] + +
+
<atts:attribute> ... </atts:attribute> [1] +
+
<atts:reference> + atts:referenceType + </atts:reference> [1] +
+ End Choice +
</atts:gbean>
+
+
+
+
+ Diagram +
+
+ + + h591280409 + + h-2038376224 + + +
+
+
+
+ Schema Component Representation +
+
+
<xsd:element + name="gbean" type=" + + atts:gbeanType + + "/>
+
+
+
+ top +
+
+

+ Global Definitions +

+

Complex Type: attributeType +

+ + + + + + + + + +
Super-types: + + xsd:anyType < attributeType (by restriction)
Sub-types:None
+ + + + + + + + + + + + + + + + + +
NameattributeType
Used by (from the same schema document)Element + attribute + +
+ Abstract + no
Documentation + Provides the definition of a single named attribute. Attributes + are mixed type and can include simple text and elements. +
+
+
+ XML Instance Representation +
+
+
<...
+ name="anySimpleType + [1] +

'The name attribute provides the name of single attribute.'

" +
+ null=" + xsd:boolean + [0..1] +

'The null attribute defines if this atribute is null or not.'

" +
+ propertyEditor=" + xsd:string + [0..1] +

'The propertyEditor attribute defines the property editor class to be used to get the value of this attribute based on its string representation. If no editor is specified, then the type of the attribute, as declared by GBeanAttribute, is used to find a propertyEditor through the standard JavaBean search strategy.'

">
+ <!-- Mixed content --> +
+
<!-- ' + xsd:anyType' super type was not found in this schema. Some elements and attributes may be missing. -->
+
Allow any elements from any namespace (lax validation). [0..*] +
</...>
+
+
+
+
+ Diagram +
+
+ + + +
+
+
+
+ Schema Component Representation +
+
+
<xsd:complexType + name="attributeType">
<xsd:complexContent + mixed="true">
<xsd:restriction + base=" + + xsd:anyType + ">
<xsd:sequence>
<xsd:any + minOccurs="0" maxOccurs="unbounded" processContents="lax"/>
</xsd:sequence>
+
<xsd:attribute + name="name" use="required"/>
+
<xsd:attribute + name="null" type=" + + xsd:boolean + " use="optional" default="false"/>
+
<xsd:attribute + name="propertyEditor" type=" + + xsd:string + " use="optional"/>
+
<--<xsd:attribute name="value" use="optional">-->
+
<--<xsd:annotation>-->
+
<--<xsd:documentation>-->
+
<--The value attribute is the value of specified-->
+
<--attribute.-->
+
<--</xsd:documentation>-->
+
<--</xsd:annotation>-->
+
<--</xsd:attribute>-->
</xsd:restriction>
</xsd:complexContent>
</xsd:complexType>
+
+
+
+ top +
+
+

Complex Type: attributesType +

+ + + + + + + + + +
Super-types:None
Sub-types:None
+ + + + + + + + + + + + + +
NameattributesType
Used by (from the same schema document)Element + attributes + +
+ Abstract + no
+
+
+ XML Instance Representation +
+
+
<...>
+
<atts:comment> + xsd:string </atts:comment> [0..1] +
+ Start Choice + [1] + +
+
<atts:module> + atts:moduleType + </atts:module> [0..*] +
+
<atts:configuration> + atts:moduleType + </atts:configuration> [0..*] +
+ End Choice +
</...>
+
+
+
+
+ Diagram +
+
+ + + h-391482901 + + h-391482901 + + +
+
+
+
+ Schema Component Representation +
+
+
<xsd:complexType + name="attributesType">
<xsd:sequence>
<xsd:element + name="comment" type=" + + xsd:string + " minOccurs="0" maxOccurs="1"/>
+
<xsd:choice>
<xsd:element + name="module" type=" + + atts:moduleType + + " minOccurs="0" maxOccurs="unbounded"/>
+
<-- The config.xml file in 1.0 use configuration instead of module -->
+
<xsd:element + name="configuration" type=" + + atts:moduleType + + " minOccurs="0" maxOccurs="unbounded"/>
</xsd:choice>
</xsd:sequence>
</xsd:complexType>
+
+
+
+ top +
+
+

Complex Type: gbeanType +

+ + + + + + + + + +
Super-types:None
Sub-types:None
+ + + + + + + + + + + + + + + + + +
NamegbeanType
Used by (from the same schema document)Element + gbean + , Complex Type + moduleType + +
+ Abstract + no
Documentation + Element used by the plugin system to list individual GBeans. + Note that the name attribute for a gbean element may hold either + the full GBeanName, or only the value for the "name=" portion of + the GBeanName. If there are multiple GBeans in the module with + manageable attributes and the same "name=" portion of the + GBeanName, then all must be listed and all must be listed with a + full GBeanName. +
+
+
+ XML Instance Representation +
+
+
<...
+ name=" + xsd:string + [1] +

'The name attribute specifies the name portion of the GBeanName.'

" +
+ gbeanInfo=" + xsd:string + [0..1] +

'The gbeanInfo attribute provide the gbean infomation for specified GBean.'

" +
+ load=" + xsd:boolean + [0..1] +

'The load attribute specifies if the gbean is to be loaded or not.'

">
+
<atts:comment> + xsd:string </atts:comment> [0..1] +
+ Start Choice + [0..*] + +
+
<atts:attribute> ... </atts:attribute> [1] +
+
<atts:reference> + atts:referenceType + </atts:reference> [1] +
+ End Choice +
</...>
+
+
+
+
+ Diagram +
+
+ + + h591280409 + + h-2038376224 + + +
+
+
+
+ Schema Component Representation +
+
+
<xsd:complexType + name="gbeanType">
<xsd:sequence>
<xsd:element + name="comment" type=" + + xsd:string + " minOccurs="0" maxOccurs="1"/>
+
<xsd:choice + minOccurs="0" maxOccurs="unbounded">
<xsd:element + ref=" + atts:attribute + "/>
+
<xsd:element + name="reference" type=" + + atts:referenceType + + "/>
</xsd:choice>
</xsd:sequence>
+
<xsd:attribute + name="name" type=" + + xsd:string + " use="required"/>
+
<xsd:attribute + name="gbeanInfo" type=" + + xsd:string + " use="optional"/>
+
<xsd:attribute + name="load" type=" + + xsd:boolean + " use="optional" default="true"/>
</xsd:complexType>
+
+
+
+ top +
+
+

Complex Type: moduleType +

+ + + + + + + + + +
Super-types:None
Sub-types:None
+ + + + + + + + + + + + + +
NamemoduleType
Used by (from the same schema document)Complex Type + attributesType + , Complex Type + attributesType + +
+ Abstract + no
+
+
+ XML Instance Representation +
+
+
<...
+ name=" + xsd:string + [1]" +
+ load=" + xsd:boolean + [0..1]" +
+ condition=" + xsd:string + [0..1]">
+
<atts:comment> + xsd:string </atts:comment> [0..1] +
+
<atts:gbean> + atts:gbeanType + </atts:gbean> [0..*] +
</...>
+
+
+
+
+ Diagram +
+
+ + + h-839994964 + + +
+
+
+
+ Schema Component Representation +
+
+
<xsd:complexType + name="moduleType">
<xsd:sequence>
<xsd:element + name="comment" type=" + + xsd:string + " minOccurs="0" maxOccurs="1"/>
+
<xsd:element + name="gbean" type=" + + atts:gbeanType + + " minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
+
<xsd:attribute + name="name" type=" + + xsd:string + " use="required"/>
+
<xsd:attribute + name="load" type=" + + xsd:boolean + " use="optional" default="true"/>
+
<xsd:attribute + name="condition" type=" + + xsd:string + " use="optional"/>
</xsd:complexType>
+
+
+
+ top +
+
+

Complex Type: referenceType +

+ + + + + + + + + +
Super-types:None
Sub-types:None
+ + + + + + + + + + + + + +
NamereferenceType
Used by (from the same schema document)Complex Type + gbeanType + +
+ Abstract + no
+
+
+ XML Instance Representation +
+
+
<...
+ name=" + xsd:string + [0..1]">
+
<atts:pattern> [0..*] +
+
<atts:groupId> + xsd:string </atts:groupId> [0..1] +

'The name for group containing module to match. By default is set to wild card \'*\'.'

+
+
<atts:artifactId> + xsd:string </atts:artifactId> [0..1] +

'The name for module in a specified group to be matched. All the artifactId\'s should be unique within a group. If no articfactId is provided it will be defaulted to file name of the module file.'

+
+
<atts:version> + xsd:string </atts:version> [0..1] +

'The version number for the module formatted by dot separated numbers. If no version is provided it will be defaulted to latest available version matching other criterions.'

+
+
<atts:type> + xsd:string </atts:type> [0..1] +

'This element defines the type of the module. The type could be \'CAR\', \'JAR\', EAR\', \'WAR\' etc. If no type is provided it will be defaulted appropriately by the deployer depending upon type of deployed module.'

+
+
<atts:module> + xsd:string </atts:module> [0..1] +

'The value specified here should match the file name of the module referenced.'

+
+
<atts:name> + xsd:string </atts:name> [1] +

'The name element to identify the referenced GBean by name.'

+
</atts:pattern>
</...>
+
+
+
+
+ Diagram +
+
+ + + +
+
+
+
+ Schema Component Representation +
+
+
<xsd:complexType + name="referenceType">
<xsd:sequence>
<xsd:element + name="pattern" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<xsd:element + name="groupId" type=" + + xsd:string + " minOccurs="0"/>
+
<xsd:element + name="artifactId" type=" + + xsd:string + " minOccurs="0"/>
+
<xsd:element + name="version" type=" + + xsd:string + " minOccurs="0"/>
+
<xsd:element + name="type" type=" + + xsd:string + " minOccurs="0"/>
+
<xsd:element + name="module" type=" + + xsd:string + " minOccurs="0"/>
+
<xsd:element + name="name" type=" + + xsd:string + "/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
+
<xsd:attribute + name="name" type=" + + xsd:string + "/>
</xsd:complexType>
+
+
+
+ top +
+
+
+

+ Legend +

+
+

Complex Type:

+
Schema Component Type
+
+
+

+ AusAddress +

+
Schema Component Name
+
+ + + + + + + + + +
Super-types: + Address < AusAddress (by extension)
Sub-types: +
    +
  • + QLDAddress (by restriction)
    • +
+
+
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
+ + + + + + + + + +
NameAusAddress
+ Abstract + no
+
The table above displays the properties of this schema component.
+
+
+ XML Instance Representation +
+
+ <... + + country="Australia" + >
+ <unitNo> string </unitNo> [0..1] + +
+ <houseNo> string </houseNo> [1] + +
+ <street> string </street> [1] + +
+ Start Choice + [1] + +
+ <city> string </city> [1] + +
+ <town> string </town> [1] + +
+ End Choice +
+ + <state> AusStates </state> [1] + +
+ <postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] + +
+ + </...> +
+
+
+
+

The XML Instance Representation table above shows the schema component's content as an XML instance.

+
    +
  • The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. [0..1].
    • +
  • Model group information are shown in gray, e.g. Start Choice ... End Choice.
    • +
  • For type derivations, the elements and attributes that have been added to or changed from the base type's content are shown in bold.
    • +
  • If an element/attribute has a fixed value, the fixed value is shown in green, e.g. country="Australia".
    • +
  • Otherwise, the type of the element/attribute is displayed. +
      +
    • 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}>>.
      • +
    +
    • +
+
+
+
+ Schema Component Representation +
+
+ <complexType + name="AusAddress"> +
+ <complexContent> +
+ <extension + base=" + Address + "> +
+ <sequence> +
+ <element + name="state" type=" + AusStates + "/> +
+ <element + name="postcode"> +
+ <simpleType> +
+ <restriction + base=" + string + "> +
+ <pattern + value="[1-9][0-9]{3}"/> +
+ </restriction> +
+ </simpleType> +
+ </element> +
+ </sequence> +
+ <attribute + name="country" type=" + string [... 118 lines stripped ...]