Overview

Home
License
ASF
Project Policies
Downloads
Documentation
News Archive

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

Schema Document Properties
Global Declarations
Global Definitions

Legend

Glossary

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

Prefix	Namespace
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

Name	attribute
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.'

">

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

Name	attributes
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

Schema Component Representation

<xsd:element name="attributes" type=" atts:attributesType "/>

top

Element: comment

Name	comment
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

Name	gbean
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

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

Name	attributeType
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]

">

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

Name	attributesType
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

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

Name	gbeanType
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

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

Name	moduleType
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

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

Name	referenceType
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.

Name	AusAddress
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

The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)

top

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.

top

Documentation for attributes-1.2

Table of Contents

Schema Document Properties

Declared Namespaces

Global Declarations

Element: attribute

Element: attributes

Element: comment

Element: gbean

Global Definitions

Complex Type: attributeType

Complex Type: attributesType

Complex Type: gbeanType

Complex Type: moduleType

Complex Type: referenceType

Legend

Complex Type:

AusAddress

Glossary