Introduction
Geronimo includes a connecter container supporting both in bound and out bound Resource adapters.A Connector RAR may include Geronimo-specific configuration information in addition to the standard J2EE deployment descriptor.This is the Geronimo specific XML Schema Documentation for the Connector 1.5 deployment descriptor.The deployment descriptor must be named "META-INF/ra.xml" in the connector's RAR file.
This article is organized into the following sections : -
- #Geronimo Connector Schema Document
- #Schema Document Properties
- #Global Declarations
- #Global Definitions
- Complex Type: adminobject-instanceType
- Complex Type: adminobjectType
- Complex Type: config-property-settingType
- Complex Type: connection-definitionType
- Complex Type: connectiondefinition-instanceType
- Complex Type: connectionmanagerType
- Complex Type: connectorType
- Complex Type: descriptionType
- Complex Type: emptyType
- Complex Type: outbound-resourceadapterType
- Complex Type: partitionedpoolType
- Complex Type: resourceadapter-instanceType
- Complex Type: resourceadapterType
- Complex Type: singlepoolType
- Complex Type: xatransactionType
- Simple Type: fully-qualified-classType
- #Legend
- #Glossary
Geronimo Connector Schema Document
Schema Document Properties
Target Namespace |
http://geronimo.apache.org/xml/ns/j2ee/connector-1.1 Geronimo |
Element and Attribute Namespaces |
|
Schema Composition |
This schema imports schema(s) from the following namespace(s): |
Documentation |
documents using this schema should start as : |
Declared Namespaces
Prefix |
Namespace |
---|---|
Default namespace |
|
xml |
http://www.w3.org/XML/1998/namespace |
ger |
http://geronimo.apache.org/xml/ns/j2ee/connector-1.1 |
naming |
http://geronimo.apache.org/xml/ns/naming-1.1 |
sys |
http://geronimo.apache.org/xml/ns/deployment-1.1 |
xs |
http://www.w3.org/2001/XMLSchema |
Global Declarations
Element : connectorconnector
The connector element is the root element of the deployment descriptor for the resource adapter. This element includes general information - vendor name, resource adapter version,icon - about the resource adapter module. It also includes information specific to the implementation of the resource adapter library as specified through the element resource adapter.
Element: |
connector |
Name |
connector |
Type |
ger:connectorType |
Nillable |
No |
Abstract |
No |
Documentation |
The connector element is the root element of the deployment
|
Global Definitions
Complex Type : adminobject-instanceTypeinstanceType
Complex Type: |
adminobject-instanceType |
Super-types: |
None |
Sub-types: |
None |
Name |
adminobject-instanceType |
Abstract |
no |
Complex Type: adminobjectTypeadminobjectType
The adminobjectType specifies information about an administered object.Administered objects are specific to a messaging style or message provider in Geronimo connector xml schema.
Complex Type: |
adminobjectType |
Super-types: |
None |
Sub-types: |
None |
Name |
adminobjectType |
Abstract |
no |
Documentation |
reference back into standard dd |
Complex Type: config-property-settingTypesettingType
The config-propertyType contains a declaration of a single configuration property that may be used for providing configuration information.The declaration consists of an optional description, name,type and an optional value of the configuration property. If the resource adapter provider does not specify a value than the deployer is responsible for providing a valid value for a configuration property.
Any bounds or well-defined values of properties should be described in the description element
Complex Type: |
config-property-settingType |
Super-types: |
xs:string < config-property-settingType (by extension) |
Sub-types: |
None |
Name |
config-property-settingType |
Abstract |
no |
Documentation |
The config-property-settingType contains a name-value pair for a config-property or |
Complex Type: connection-definitionTypedefinitionType
Complex Type: |
connection-definitionType |
Super-types: |
None |
Sub-types: |
None |
Name |
connection-definitionType |
Abstract |
no |
Documentation |
The connection-definitionType defines a set of connection interfaces and classes |
Complex Type: connectiondefinition-instanceTypedefinitioninstanceType
Complex Type: |
connectiondefinition-instanceType |
Super-types: |
None |
Sub-types: |
None |
Name |
connectiondefinition-instanceType |
Abstract |
No |
Complex Type: connectionmangerTypeconnectionmanagerType
Complex Type: |
connectionmanagerType |
Super-types: |
None |
Sub-types: |
None |
Name |
connectionmanagerType |
Abstract |
no |
Documentation |
The ConnectionManager configuration |
Complex Type: connectorTypeconnectorType
The connectorType defines a resource adapter
Complex Type: |
connectorType |
Super-types: |
None |
Sub-types: |
None |
Name |
connectorType |
Abstract |
no |
Documentation |
The connectorType defines a resource adapter |
Complex Type: descriptionTypedescriptionType
Complex Type: |
descriptionType |
Super-types: |
xs:string < descriptionType (by extension) |
Sub-types: |
None |
Name |
descriptionType |
Abstract |
no |
Complex Type: emptyTypeemptyType
Complex Type: |
emptyType |
Super-types: |
None |
Sub-types: |
None |
Name |
emptyType |
Abstract |
no |
Complex Type: outbound-resourceadapterTyperesourceadapterType
Complex Type: |
outbound-resourceadapterType |
Super-types: |
None |
Sub-types: |
None |
Name |
outbound-resourceadapterType |
Abstract |
no |
Documentation |
The outbound-resourceadapterType specifies information about an outbound resource |
Complex Type: partitionedpoolTypepartitionedpoolType
Complex Type: |
partitionedpoolType |
Super-types: |
singlepoolType < partitionedpoolType (by extension) |
Sub-types: |
None |
Name |
partitionedpoolType |
Abstract |
No |
Complex Type: resourceadapter-instanceTypeadapterinstanceType
Complex Type: |
resourceadapter-instanceType |
Super-types: |
None |
Sub-types: |
None |
Name |
resourceadapter-instanceType |
Abstract |
no |
Documentation |
The resourceadapter instance info is put in a separate optional element |
Complex Type: resourceadapterTyperesourceadapterType1
Complex Type: |
resourceadapterType |
Super-types: |
None |
Sub-types: |
None |
Name |
resourceadapterType |
Abstract |
no |
Complex Type: singlepoolTypesinglepoolType
Complex Type: |
singlepoolType |
Super-types: |
None |
Sub-types: |
*partitionedpoolType (by extension) |
Name |
singlepoolType |
Abstract |
no |
Complex Type: xatransationTypexatransactionType
Complex Type: |
xatransactionType |
Super-types: |
None |
Sub-types: |
None |
Name |
xatransactionType |
Abstract |
no |
Simple Type: fully-qualifies-classTypeclassType
Simple Type: |
fully-qualified-classType |
Super-types: |
xs:string < fully-qualified-classType (by restriction) |
Sub-types: |
None |
Name |
fully-qualified-classType |
Content |
|
Legend
Complex Type: |
AusAddress |
Schema Component Type |
|
Schema Component Name |
Super-types: |
Address < AusAddress (by extension) |
Sub-types: |
|
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.
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>
.
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
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 Substitution (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.