XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace http://xmlns.opennms.org/xsd/mail-transport-test
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.

Declared Namespaces

Prefix Namespace
Default namespace http://www.w3.org/2001/XMLSchema
xml http://www.w3.org/XML/1998/namespace
this http://xmlns.opennms.org/xsd/mail-transport-test
Schema Component Representation
<schema targetNamespace="http://xmlns.opennms.org/xsd/mail-transport-test" elementFormDefault="qualified">
...
</schema>
top

Global Declarations

Element: javamail-property

Name javamail-property
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Use these name value pairs to configure freeform properties from the JavaMail class.
XML Instance Representation
<this:javamail-property
name="string [1]"
value="string [1]"/>
Schema Component Representation
<element name="javamail-property">
<complexType>
<attribute name="name" type=" string " use="required"/>
<attribute name="value" type=" string " use="required"/>
</complexType>
</element>
top

Element: mail-test

Name mail-test
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Defines a use case for testing mail. If both a send and a read test are configured, then the use case (d) will be executed.
XML Instance Representation
<this:mail-test>
<this:sendmail-test> ... </this:sendmail-test> [0..1]
<this:readmail-test> ... </this:readmail-test> [0..1]
</this:mail-test>
Schema Component Representation
<element name="mail-test">
<complexType>
<sequence>
<element ref=" this:sendmail-test " minOccurs="0" maxOccurs="1"/>
<element ref=" this:readmail-test " minOccurs="0" maxOccurs="1"/>
</sequence>
</complexType>
</element>
top

Element: mail-transport-test

Name mail-transport-test
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Use this element to define a mail test with the MailTransportMonitor. Supported use cases for the sequence are: a) Class will test that it can successfully send an email. b) Class will test that it can successfully connect to a mail server and get mailbox contents. c) Class will test that it can successfully read a new email message from a mail server. d) Class will test that it can send an email and read that same email from a mail server. The sequence support a max of one send and one receive server. If each are specified, the complete sequence is delivery of a message from one mail host to another.
XML Instance Representation
<this:mail-transport-test>
<this:mail-test> ... </this:mail-test> [1]
</this:mail-transport-test>
Schema Component Representation
<element name="mail-transport-test">
<complexType>
<sequence>
<element ref=" this:mail-test " minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
top

Element: readmail-host

Name readmail-host
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Define the host and port of the sendmail server. If you don't, defaults will be used and ${ipaddr} is replaced with the IP address of the service.
XML Instance Representation
<this:readmail-host
host="string [0..1]"
port="integer [0..1]">
<this:readmail-protocol> ... </this:readmail-protocol> [1]
</this:readmail-host>
Schema Component Representation
<element name="readmail-host">
<complexType>
<sequence>
<element ref=" this:readmail-protocol " minOccurs="1" maxOccurs="1"/>
</sequence>
<attribute name="host" type=" string " use="optional" default="${ipaddr}"/>
<attribute name="port" type=" integer " use="optional" default="110"/>
</complexType>
</element>
top

Element: readmail-protocol

Name readmail-protocol
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Basically attributes that help setup the javamailer's confusion set of properties.
XML Instance Representation
<this:readmail-protocol
transport=" this:read-mail-protocol [0..1]"
ssl-enable="boolean [0..1]"
start-tls="boolean [0..1]"/>
Schema Component Representation
<element name="readmail-protocol">
<complexType>
<attribute name="transport" type=" this:read-mail-protocol " use="optional" default="pop3"/>
<attribute name="ssl-enable" type=" boolean " use="optional" default="false"/>
<attribute name="start-tls" type=" boolean " use="optional" default="false"/>
</complexType>
</element>
top

Element: readmail-test

Name readmail-test
Type Locally-defined complex type
Nillable no
Abstract no
XML Instance Representation
<this:readmail-test
debug="boolean [0..1]"
mail-folder="string [0..1]"
subject-match="string [0..1]"
attempt-interval="integer [0..1]"
delete-all-mail="boolean [0..1]">
<this:javamail-property> ... </this:javamail-property> [0..*]
<this:readmail-host> ... </this:readmail-host> [1]
<this:user-auth> ... </this:user-auth> [1]
</this:readmail-test>
Schema Component Representation
<element name="readmail-test">
<complexType>
<sequence>
<element ref=" this:javamail-property " minOccurs="0" maxOccurs="unbounded"/>
<element ref=" this:readmail-host " minOccurs="1" maxOccurs="1"/>
<element ref=" this:user-auth " minOccurs="1" maxOccurs="1"/>
</sequence>
<attribute name="debug" type=" boolean " use="optional" default="true"/>
<attribute name="mail-folder" type=" string " use="optional" default="INBOX"/>
<attribute name="subject-match" type=" string " use="optional"/>
<attribute name="attempt-interval" type=" integer " use="optional" default="1000"/>
<attribute name="delete-all-mail" type=" boolean " use="optional" default="false"/>
</complexType>
</element>
top

Element: sendmail-host

Name sendmail-host
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Define the host and port of the sendmail server. If you don't, defaults will be used and ${ipaddr} is replaced with the IP address of the service.
XML Instance Representation
<this:sendmail-host
host="string [0..1]"
port="integer [0..1]"/>
Schema Component Representation
<element name="sendmail-host">
<complexType>
<attribute name="host" type=" string " use="optional" default="${ipaddr}"/>
<attribute name="port" type=" integer " use="optional" default="25"/>
</complexType>
</element>
top

Element: sendmail-message

Name sendmail-message
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Define the to, from, subject, and body of a message. If not defined, one will be defined for your benefit (or confusion ;-)
XML Instance Representation
<this:sendmail-message
to="string [0..1]"
from="string [0..1]"
subject="string [0..1]"
body="string [0..1]"/>
Schema Component Representation
<element name="sendmail-message">
<complexType>
<attribute name="to" type=" string " use="optional" default="root@localhost"/>
<attribute name="from" type=" string " use="optional" default="root@[127.0.0.1]"/>
<attribute name="subject" type=" string " use="optional" default="OpenNMS Test Message"/>
<attribute name="body" type=" string " use="optional" default="This is an OpenNMS test message."/>
</complexType>
</element>
top

Element: sendmail-protocol

Name sendmail-protocol
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Basically attributes that help setup the javamailer's confusion set of properties.
XML Instance Representation
<this:sendmail-protocol
char-set="string [0..1]"
mailer="string [0..1]"
message-content-type="string [0..1]"
message-encoding="string [0..1]"
quit-wait="boolean [0..1]"
transport=" this:transport-types [0..1]"
ssl-enable="boolean [0..1]"
start-tls="boolean [0..1]"/>
Schema Component Representation
<element name="sendmail-protocol">
<complexType>
<attribute name="char-set" type=" string " use="optional" default="us-ascii"/>
<attribute name="mailer" type=" string " use="optional" default="smtpsend"/>
<attribute name="message-content-type" type=" string " use="optional" default="text/plain"/>
<attribute name="message-encoding" type=" string " use="optional" default="7-bit"/>
<attribute name="quit-wait" type=" boolean " use="optional" default="true"/>
<attribute name="transport" type=" this:transport-types " use="optional" default="smtp"/>
<attribute name="ssl-enable" type=" boolean " use="optional" default="false"/>
<attribute name="start-tls" type=" boolean " use="optional" default="false"/>
</complexType>
</element>
top

Element: sendmail-test

Name sendmail-test
Type Locally-defined complex type
Nillable no
Abstract no
Documentation This entity defines the test for sending mail. Attributes are used to derive values of java mail properties, or, they can be specified directly as key value pairs. Attributes will are easier to read but there isn't an attribute for every javamail property possible (some are fairly obscure).
XML Instance Representation
<this:sendmail-test
debug="boolean [0..1]"
use-authentication="boolean [0..1]"
use-jmta="boolean [0..1]"
attempt-interval="integer [0..1]">
<this:javamail-property> ... </this:javamail-property> [0..*]
<this:sendmail-host> ... </this:sendmail-host> [1]
<this:sendmail-protocol> ... </this:sendmail-protocol> [1]
<this:sendmail-message> ... </this:sendmail-message> [1]
<this:user-auth> ... </this:user-auth> [1]
</this:sendmail-test>
Schema Component Representation
<element name="sendmail-test">
<complexType>
<sequence>
<element ref=" this:javamail-property " minOccurs="0" maxOccurs="unbounded"/>
<element ref=" this:sendmail-host " minOccurs="1" maxOccurs="1"/>
<element ref=" this:sendmail-protocol " minOccurs="1" maxOccurs="1"/>
<element ref=" this:sendmail-message " minOccurs="1" maxOccurs="1"/>
<element ref=" this:user-auth " minOccurs="1" maxOccurs="1"/>
</sequence>
<attribute name="debug" type=" boolean " use="optional" default="true"/>
<attribute name="use-authentication" type=" boolean " use="optional" default="false"/>
<attribute name="use-jmta" type=" boolean " use="optional" default="true"/>
<attribute name="attempt-interval" type=" integer " use="optional" default="3000"/>
</complexType>
</element>
top

Element: user-auth

Name user-auth
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Configure user based authentication.
XML Instance Representation
<this:user-auth
user-name="string [0..1]"
password="string [0..1]"/>
Schema Component Representation
<element name="user-auth">
<complexType>
<attribute name="user-name" type=" string " use="optional" default="opennms"/>
<attribute name="password" type=" string " use="optional" default="opennms"/>
</complexType>
</element>
top

Global Definitions

Simple Type: read-mail-protocol

Super-types: string < read-mail-protocol (by restriction)
Sub-types: None
Name read-mail-protocol
Content
  • Base XSD Type: string
  • pattern = pop3|pop3s|imap|imaps
Documentation Don't allow poorly configured read protocols. These are case sensitive.
Schema Component Representation
<simpleType name="read-mail-protocol">
<restriction base=" string ">
<pattern value="pop3|pop3s|imap|imaps"/>
</restriction>
</simpleType>
top

Simple Type: transport-types

Super-types: string < transport-types (by restriction)
Sub-types: None
Name transport-types
Content
  • Base XSD Type: string
  • pattern = smtp|smtps
Schema Component Representation
<simpleType name="transport-types">
<restriction base=" string ">
<pattern value="smtp|smtps"/>
</restriction>
</simpleType>
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.

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 " fixed="Australia"/>
</extension>
</complexContent>
</complexType>
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

Generated by xs3p (old link) . Last modified: