HomeDocumentation > Apache Geronimo v1.1 - User's Guide > XML schemas > openejb-jar-2.1.xsd


This article is organized into the following sections : -

OpenEJB Schema Document

The following schema uses the OpenEJB namespace, and requires elements from the Geronimo Naming, Geronimo Security, and Geronimo System namespaces. Furthermore, it has a required attribute to identify its configuration name, and an optional attribute to select a parent configuration.The openejb-jar-2.1.xsd defines the schema for the Geronimo Deployment Plan for an EJB JAR.
The attributes here are:

xmlns

The main namespace for the deployment plan, which should always be http://www.openejb.org/xml/ns/openejb-jar-2.1

xmlns:naming

A secondary namespace, used to identify the common elements for resolving EJB references, resource references, and web services references. If any of those need to be resolved in the deployment plan, this attribute should be present, and should be set to http://geronimo.apache.org/xml/ns/naming-1.1

xmlns:security
A secondary namespace, used to identify the common elements for security configuration. If there are any security settings in the deployment plan, this attribute should be present, and should be set to http://geronimo.apache.org/xml/ns/security-1.1

xmlns:sys
A secondary namespace, used to identify the common elements for common libraries and module-scoped services. If there are any of those present in the deployment plan, this attribute should be present, and should be set to http://geronimo.apache.org/xml/ns/deployment-1.1

xmlns:pkgen
A secondary namespace, used to identify the common elements for configuring automatic primary key generation for CMP entity beans (such as, using a sequence or auto-increment column). If there are any primary key generators present in the deployment plan, this attribute should be present, and should be set to http://www.openejb.org/xml/ns/pkgen-2.0

configId
A unique name identifying this module. If deployed as a standalone EJB JAR, this name is used to identify the module to the deployment tool (to start, stop, undeploy, or redeploy the EJB JAR).

parentId
Identifies the parent configuration for this EJB JAR (the value specified here should match the configId for that module). If deployed as a standalone EJB JAR, this can be used to make the EJB JAR depend on another module such as another standalone EJB JAR or a J2EE Connector (or it should otherwise be omitted or set to the usual parent for J2EE modules, geronimo/j2ee-server/1.0/car). If deployed as part of an EAR this is usually not necessary, as EAR configuration will be the parent of this module.

openejb-jar-2.1.xsd

Schema Document Properties

Target Namespace http://www.openejb.org/xml/ns/openejb-jar-2.1
Version 1.1
Element and Attribute NamespacesGlobal 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(at

geronimo-security-1.1.xsd)

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

(at geronimo-module-1.1.xsd)

http://www.openejb.org/xml/ns/pkgen-2.0

(at openejb-pkgen-2.0.xsd)

Declared Namespaces

Prefix Namespace
xml http://www.w3.org/XML/1998/namespace
openejb http://www.openejb.org/xml/ns/openejb-jar-2.1
naming http://geronimo.apache.org/xml/ns/naming-1. 1
securityhttp://geronimo.apache.org/xml/ns/security-1.1
sys http://geronimo.apache.org/xml/ns/deployment-1.1
pkgen http://www.openejb.org/xml/ns/pkgen-2.0
xs http://www.w3.org/2001/XMLSchema
Schema Component Representation

Global Declarations

Element: openejb-jar

Element:openejb-jar
Name openejb-jar
Type openejb:openejb-jarType
Nillableno
Abstractno
XML Instance Representation: openejb-jar
Schema Component Representation: openejb-jar

Global Definitions

Complex Type: activation-config-propertyType

Complex Type: activation-config-propertyType
Super-types: None
Sub-types: None
Name activation-config-propertyType
Abstract no
XML Instance Representation: activation-config-propertyType
Schema Component Representation: activation-config-propertyType

Complex Type: activation-configType

Complex Type:activation-configType
Super-types: None
Sub-types: None
Name activation-configType
Abstractno
XML Instance Representation: activation-configType
Schema Component Representation: activation-configType

Complex Type: cmp-field-group-mappingType

Complex Type: cmp-field-group-mappingType
Super-types: None
Sub-types: None
Name cmp-field-group-mappingType
Abstract no
XML Instance Representation: cmp-field-group-mappingType
Schema Component Representation: cmp-field-group-mappingType

Complex Type: cmr-field-group-mappingType

Complex Type: cmr-field-group-mappingType
Super-types: None
Sub-types: None
Name cmr-field-group-mappingType
Abstractno
XML Instance Representation: cmr-field-group-mappingType
Schema Component Representation: cmr-field-group-mappingType

Complex Type: ejb-relationship-roleType

Complex Type: ejb-relationship-roleType
Super-types: None
Sub-types: None
Name ejb-relationship-roleType
Abstract no
XML Instance Representation: ejb-relationship-roleType
Schema Component Representation: ejb-relationship-roleType

Complex Type: ejb-relationType

Complex Type: ejb-relationType
Super-types: None
Sub-types: None
Name ejb-relationType
Abstract no
XML Instance Representation: ejb-relationType
Schema Component Representation: ejb-relationType

Complex Type: emptyType

Complex Type: emptyType
Super-types: None
Sub-types: None
Name emptyType
Abstractno
XML Instance Representation: emptyType
Schema Component Representation: emptyType

Complex Type: entity-beanType

Complex Type:entity-beanType
Super-types: None
Sub-types: None
Name entity-beanType
Abstractno
XML Instance Representation: entity-beanType
Schema Component Representation: entity-beanType

Complex Type: entity-group-mappingType

Complex Type: entity-group-mappingType
Super-types: None
Sub-types: None
Name entity-group-mappingType
Abstractno
XML Instance Representation: entity-group-mappingType
Schema Component Representation: entity-group-mappingType

Complex Type: groupType

Complex Type: groupType
Super-types: None
Sub-types: None
Name groupType
Abstractno
XML Instance Representation: groupType
Schema Component Representation: groupType

Complex Type: message-driven-beanType

Complex Type: message-driven-beanType
Super-types: None
Sub-types: None
Name message-driven-beanType
Abstract no
XML Instance Representation: message-driven-beanType
Schema Component Representation: message-driven-beanType

Complex Type: openejb-jarType

Complex Type:openejb-jarType
Super-types: None
Sub-types: None
Name openejb-jarType
Abstract no
XML Instance Representation: openejb-jarType
Schema Component Representation: openejb-jarType

Complex Type: queryType

Complex Type: queryType
Super-types: None
Sub-types: None
Name queryType
Abstract no
XML Instance Representation: queryType
Schema Component Representation: queryType

Element : relationshipsType

Name relationshipsType
Abstract no
XML Instance Representation: relationshipsType
Schema Component Representation: relationshipsType

Complex Type: session-beanType

Complex Type: session-beanType
Super-types: None
Sub-types: None
Name session-beanType
Abstract no
XML Instance Representation: session-beanType
Schema Component Representation: session-beanType

Complex Type: tssType

Complex Type:tssType
Super-types: None
Sub-types: None
Name tssType
Abstract no
XML Instance Representation: tssType
Schema Component Representation: tssType

Complex Type: web-service-securityType

Complex Type: web-service-securityType
Super-types: None
Sub-types: None
Name web-service-securityType
Abstract no
XML Instance Representation: web-service-securityType
Schema Component Representation: web-service-securityType

Model Group: tssGroup

Model Group:tssGroup
Name tssGroup
XML Instance Representation: tssGroup
Schema Component Representation: tssGroup

Simple Type: auth-methodType

Simple Type: auth-methodType
Super-types: xs:string < auth-methodType (by restriction)
Sub-types: None
Name auth-methodType
Content
  • Base XSD Type: string
  • value comes from list:
    • BASIC
    • DIGEST
    • CLIENT-CERT
    • NONE
Schema Component Representation: auth-methodType

Simple Type: transport-guranteeType

Simple Type:transport-guaranteeType
Super-types:xs:string < transport-guaranteeType (by restriction)
Sub-types: None
Name transport-guranteeType
Content
  • Base XSD Type: string
  • value comes from list:
    • NONE
    • INTEGRAL
    • CONFIDENTIAL
Schema Component Representation: transport-guranteeType

Legend

Complex Type: AusAddress
Schema Component Type 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

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.
    o If the element/attribute's type is in the schema, a link is provided to it.
    o 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>.
Schema Component Representation

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