Documentation for jbossws-tool_1_0

Schema Document Properties
Global Declarations
- Element: configuration
Global Definitions

Legend

Glossary

top

Schema Document Properties

Target Namespace	http://www.jboss.org/jbossws-tools
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
ns1	http://www.jboss.org/jbossws-tools
xml	http://www.w3.org/XML/1998/namespace
xs	http://www.w3.org/2001/XMLSchema

Schema Component Representation

<xs:schema targetNamespace="http://www.jboss.org/jbossws-tools" elementFormDefault="qualified" attributeFormDefault="unqualified">

...

</xs:schema>

top

Global Declarations

Element: configuration

Name	configuration
Type	ns1:configurationType
Nillable	no
Abstract	no
Documentation	Configuration Element

Logical Diagram

XML Instance Representation

<ns1:configuration>

<ns1:global> ns1:globalType </ns1:global> [0..1]

'Represents global options'

Start Choice [1]

<ns1:java-wsdl> ns1:javaToWsdlType </ns1:java-wsdl> [1]

'Generates a WSDL file from a JSR-109 service endpoint interface. Additionally, a webservices.xml and a JSR-109 mapping file can also be generated'

<ns1:wsdl-java> ns1:wsdlToJavaType </ns1:wsdl-java> [1]

'Generates a JSR-109 service endpoint interface, and optionally a JSR-109 mapping file'

End Choice
</ns1:configuration>

Diagram

Schema Component Representation

<xs:element name="configuration" type=" ns1:configurationType "/>

top

Global Definitions

Complex Type: configurationType

Super-types:	None
Sub-types:	None

Name	configurationType
Used by (from the same schema document)	Element configuration
Abstract	no

XML Instance Representation

<...>

<ns1:global> ns1:globalType </ns1:global> [0..1]

'Represents global options'

Start Choice [1]

<ns1:java-wsdl> ns1:javaToWsdlType </ns1:java-wsdl> [1]

'Generates a WSDL file from a JSR-109 service endpoint interface. Additionally, a webservices.xml and a JSR-109 mapping file can also be generated'

<ns1:wsdl-java> ns1:wsdlToJavaType </ns1:wsdl-java> [1]

'Generates a JSR-109 service endpoint interface, and optionally a JSR-109 mapping file'

End Choice
</...>

Diagram

Schema Component Representation

<xs:complexType name="configurationType">

<xs:sequence>

<xs:element name="global" type=" ns1:globalType " minOccurs="0"/>

<xs:choice>

<xs:element name="java-wsdl" type=" ns1:javaToWsdlType "/>

<xs:element name="wsdl-java" type=" ns1:wsdlToJavaType "/>

</xs:choice>

</xs:sequence>

</xs:complexType>

top

Complex Type: globalType

Super-types:	None
Sub-types:	None

Name	globalType
Used by (from the same schema document)	Complex Type configurationType
Abstract	no

XML Instance Representation

<...>

<ns1:package-namespace> ns1:pkgNSType </ns1:package-namespace> [0..*]

'Allows customization of the java package name to xml namespace mapping. This is specified in package/namespace element pairs.'

</...>

Diagram

Schema Component Representation

<xs:complexType name="globalType">

<xs:sequence>

<xs:element name="package-namespace" type=" ns1:pkgNSType " minOccurs="0" maxOccurs="unbounded"/>

</xs:sequence>

</xs:complexType>

top

Complex Type: javaToWsdlType

Super-types:	None
Sub-types:	None

Name	javaToWsdlType
Used by (from the same schema document)	Complex Type configurationType
Abstract	no

XML Instance Representation

<...>

<ns1:service> ns1:serviceType </ns1:service> [1]

<ns1:namespaces> ns1:namespacesType </ns1:namespaces> [1]

'Namespaces to use when generating the WSDL file.'

<ns1:mapping> ns1:mappingType </ns1:mapping> [0..1]

'Specifies the JSR-109 mapping file to generate.'

<ns1:webservices> ns1:wsxmlType </ns1:webservices> [0..1]

'Used to generate the JSR-109 webservices.xml file'

</...>

Diagram

Schema Component Representation

<xs:complexType name="javaToWsdlType">

<xs:sequence>

<xs:element name="service" type=" ns1:serviceType "/>

<xs:element name="namespaces" type=" ns1:namespacesType "/>

<xs:element name="mapping" type=" ns1:mappingType " minOccurs="0"/>

<xs:element name="webservices" type=" ns1:wsxmlType " minOccurs="0"/>

</xs:sequence>

</xs:complexType>

top

Complex Type: mappingType

Super-types:	None
Sub-types:	None

Name	mappingType
Used by (from the same schema document)	Complex Type javaToWsdlType , Complex Type wsdlToJavaType
Abstract	no

XML Instance Representation

<...
file=" xs:string (Whitespace policy: collapse) [0..1]

'The JSR-109 mapping file to generate. This defaults to jaxrpc-mapping.xml'

"/>

Diagram

Schema Component Representation

<xs:complexType name="mappingType">

<xs:attribute name="file" use="optional" default="jaxrpc-mapping.xml">

<xs:simpleType>

<xs:restriction base=" xs:string ">

<xs:whiteSpace value="collapse"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

</xs:complexType>

top

Complex Type: namespacesType

Super-types:	None
Sub-types:	None

Name	namespacesType
Used by (from the same schema document)	Complex Type javaToWsdlType
Abstract	no

XML Instance Representation

<...
target-namespace=" xs:anyURI (Whitespace policy: collapse) [1]

'The target namespace of the WSDL. By default, it will be derived from the package name of the java endpoint.'

"
type-namespace=" xs:anyURI (Whitespace policy: collapse) [1]

'The namespace to be used for the schema types.By default, will be the same as the target namespace of the WSDL file.'

"/>

Diagram

Schema Component Representation

<xs:complexType name="namespacesType">

<xs:attribute name="target-namespace" use="required">

<xs:simpleType>

<xs:restriction base=" xs:anyURI ">

<xs:whiteSpace value="collapse"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

<xs:attribute name="type-namespace" use="required">

<xs:simpleType>

<xs:restriction base=" xs:anyURI ">

<xs:whiteSpace value="collapse"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

</xs:complexType>

top

Complex Type: operationType

Super-types:	None
Sub-types:	None

Name	operationType
Used by (from the same schema document)	Complex Type serviceType
Abstract	no

XML Instance Representation

<...
name="anySimpleType [1]

'The Java method name.'

"
one-way="anySimpleType [0..1]

'If true, the generated WSDL operation should have no response message.'

"
return-xml-name=" xs:QName [0..1]

'The name of the return value in the response message.'

<ns1:parameter> ns1:parameterType </ns1:parameter> [0..*]

'Represents a method parameter. It must be in the exact order of the Java method signature.'

</...>

Diagram

Schema Component Representation

<xs:complexType name="operationType">

<xs:sequence>

<xs:element name="parameter" type=" ns1:parameterType " minOccurs="0" maxOccurs="unbounded"/>

</xs:sequence>

<xs:attribute name="name" use="required"/>

<xs:attribute name="one-way" use="optional"/>

<xs:attribute name="return-xml-name" type=" xs:QName " use="optional"/>

</xs:complexType>

top

Complex Type: parameterType

Super-types:	None
Sub-types:	None

Name	parameterType
Used by (from the same schema document)	Complex Type operationType
Abstract	no

XML Instance Representation

<...
type="anySimpleType [1]

'The fully qualified Java class name of the method parameter type.'

"
xml-name=" xs:QName [0..1]

'Used to customize the name of the parameter that is used in the generated WSDL file.'

"
mode=" xs:string (value comes from list: {'IN'|'OUT'|'INOUT'}) (Whitespace policy: collapse) [0..1]

'Indicates the in/out mode of the parameter. The \"IN\" mode is a normal java parameter. The \"OUT\" mode is a holder parameter that is used to pass multiple return values. The \"INOUT\" mode is a holder parameter that is used to receive as well as return values. The default is \"IN\".'

"
header=" xs:boolean [0..1]

'Indicates whether this parameter should be mapped to a SOAP header instead of a SOAP body part.'

"/>

Diagram

Schema Component Representation

<xs:complexType name="parameterType">

<xs:attribute name="type" use="required"/>

<xs:attribute name="xml-name" type=" xs:QName " use="optional"/>

<xs:attribute name="mode" use="optional" default="IN">

<xs:simpleType>

<xs:restriction base=" xs:string ">

<xs:whiteSpace value="collapse"/>

<xs:enumeration value="IN"/>

<xs:enumeration value="OUT"/>

<xs:enumeration value="INOUT"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

<xs:attribute name="header" type=" xs:boolean " use="optional"/>

</xs:complexType>

top

Complex Type: pkgNSType

Super-types:	xs:string < pkgNSType (by extension)
Sub-types:	None

Name	pkgNSType
Used by (from the same schema document)	Complex Type globalType
Abstract	no
Documentation	A package namespace pair.

XML Instance Representation

<...
package=" xs:string (Whitespace policy: collapse) [0..1]

'Package Name'

"
namespace=" xs:string (Whitespace policy: collapse) [0..1]

'XML Namespace'

">
xs:string
</...>

Diagram

Schema Component Representation

<xs:complexType name="pkgNSType">

<xs:simpleContent>

<xs:extension base=" xs:string ">

<xs:attribute name="package">

<xs:simpleType>

<xs:restriction base=" xs:string ">

<xs:whiteSpace value="collapse"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

<xs:attribute name="namespace">

<xs:simpleType>

<xs:restriction base=" xs:string ">

<xs:whiteSpace value="collapse"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

</xs:extension>

</xs:simpleContent>

</xs:complexType>

top

Complex Type: serviceType

Super-types:	None
Sub-types:	None

Name	serviceType
Used by (from the same schema document)	Complex Type javaToWsdlType
Abstract	no

XML Instance Representation

<...
name=" xs:string (Whitespace policy: collapse) [1]

'Name of the service. This will appear in the service element of the generated WSDL file.'

"
endpoint=" xs:string (Whitespace policy: collapse) [1]

'The fully qualified Java interface name of the service endpoint interface.'

"
style=" xs:string (value comes from list: {'rpc'|'document'}) [0..1]

'The style of the web service. The \"rpc\" style indicates multiple parts where each part is a separate schema document instance. The \"document\" style indicates that the body of the message is represented by a single part.'

"
parameter-style=" xs:string (value comes from list: {'bare'|'wrapped'}) [0..1]

'The parameter style convention to use when using document/literal. The \"bare\" convention requires that the Java method have a single parameter that represents the full request message body, and a single return value that represents the full response message body. The \"wrapped\" convention allows any Java method signature because it wraps all parameter in a single schema type.'

<ns1:operation> ns1:operationType </ns1:operation> [0..*]

'Used to customize a WSDL operation. This chlid elements of this tag are mapped to a Java method on the endpoint interface. The name and parameter types must be specified in order to locate the method.'

</...>

Diagram

Schema Component Representation

<xs:complexType name="serviceType">

<xs:sequence>

<xs:element name="operation" type=" ns1:operationType " minOccurs="0" maxOccurs="unbounded"/>

</xs:sequence>

<xs:attribute name="name" use="required">

<xs:simpleType>

<xs:restriction base=" xs:string ">

<xs:whiteSpace value="collapse"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

<xs:attribute name="endpoint" use="required">

<xs:simpleType>

<xs:restriction base=" xs:string ">

<xs:whiteSpace value="collapse"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

<xs:attribute name="style" use="optional" default="rpc">

<xs:simpleType>

<xs:restriction base=" xs:string ">

<xs:enumeration value="rpc"/>

<xs:enumeration value="document"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

<xs:attribute name="parameter-style" use="optional" default="wrapped">

<xs:simpleType>

<xs:restriction base=" xs:string ">

<xs:enumeration value="bare"/>

<xs:enumeration value="wrapped"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

</xs:complexType>

top

Complex Type: wsdlToJavaType

Super-types:	None
Sub-types:	None

Name	wsdlToJavaType
Used by (from the same schema document)	Complex Type configurationType
Abstract	no

XML Instance Representation

<...
location=" xs:anyURI [1]

'Specifies the location of the WSDL file as a URL. The URL may be either absolute or relative to the current directory. Remote protocols such as http are supported.'

"
parameter-style=" xs:string (value comes from list: {'bare'|'wrapped'}) [0..1]

<ns1:mapping> ns1:mappingType </ns1:mapping> [0..1]

'Specifies the JSR-109 mapping file to generate.'

<ns1:webservices> ns1:wsxmlType </ns1:webservices> [0..1]

'Used to generate the JSR-109 webservices.xml file'

</...>

Diagram

Schema Component Representation

<xs:complexType name="wsdlToJavaType">

<xs:sequence>

<xs:element name="mapping" type=" ns1:mappingType " minOccurs="0"/>

<xs:element name="webservices" type=" ns1:wsxmlType " minOccurs="0"/>

</xs:sequence>

<xs:attribute name="location" type=" xs:anyURI " use="required"/>

<xs:attribute name="parameter-style" use="optional" default="wrapped">

<xs:simpleType>

<xs:restriction base=" xs:string ">

<xs:enumeration value="bare"/>

<xs:enumeration value="wrapped"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

</xs:complexType>

top

Complex Type: wsxmlType

Super-types:	None
Sub-types:	None

Name	wsxmlType
Used by (from the same schema document)	Complex Type javaToWsdlType , Complex Type wsdlToJavaType
Abstract	no

XML Instance Representation

<...
servlet-link=" xs:string (Whitespace policy: collapse) [0..1]

'Specifies the web.xml servlet-link that is used by Java Service Endpoints (WAR style deployments)'

"
ejb-link=" xs:string (Whitespace policy: collapse) [0..1]

'Specifies the ejb-jar.xml ejb-link for Stateless Session Bean endpoints'

"
append=" xs:boolean [0..1]"/>

Diagram

Schema Component Representation

<xs:complexType name="wsxmlType">

<xs:attribute name="servlet-link" use="optional">

<xs:simpleType>

<xs:restriction base=" xs:string ">

<xs:whiteSpace value="collapse"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

<xs:attribute name="ejb-link" use="optional">

<xs:simpleType>

<xs:restriction base=" xs:string ">

<xs:whiteSpace value="collapse"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

<xs:attribute name="append" type=" xs:boolean " use="optional"/>

</xs: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}>>.
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.)

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 jbossws-tool_1_0

Table of Contents

Schema Document Properties

Declared Namespaces

Global Declarations

Element: configuration

Global Definitions

Complex Type: configurationType

Complex Type: globalType

Complex Type: javaToWsdlType

Complex Type: mappingType

Complex Type: namespacesType

Complex Type: operationType

Complex Type: parameterType

Complex Type: pkgNSType

Complex Type: serviceType

Complex Type: wsdlToJavaType

Complex Type: wsxmlType

Legend

Complex Type:

AusAddress

Glossary