Menu
▾
▴
[Jboss-svn-commits] JBossWS SVN: r502 - branches/jbossws-1.0/src/main/resources/schema
|
From: <jbo...@li...> - 2006-06-28 02:58:59
|
Author: jas...@jb...
Date: 2006-06-27 22:58:55 -0400 (Tue, 27 Jun 2006)
New Revision: 502
Modified:
branches/jbossws-1.0/src/main/resources/schema/jbossws-tool_1_0.xsd
Log:
Update documentation
Modified: branches/jbossws-1.0/src/main/resources/schema/jbossws-tool_1_0.xsd
===================================================================
--- branches/jbossws-1.0/src/main/resources/schema/jbossws-tool_1_0.xsd 2006-06-23 16:01:42 UTC (rev 501)
+++ branches/jbossws-1.0/src/main/resources/schema/jbossws-tool_1_0.xsd 2006-06-28 02:58:55 UTC (rev 502)
@@ -17,12 +17,12 @@
<xs:choice>
<xs:element name="java-wsdl" type="ns1:javaToWsdlType">
<xs:annotation>
- <xs:documentation>Element that can be used to pass a Java Service Endpoint Interface (prior to JDK5) or endpointInterface or an endpointImplementation, to obtain a WSDL file. Additionally, a webservices.xml and a mapping file can also be generated. When using annotated endpoints, the request for mapping and webservices.xml deployment descriptors will be ignored.</xs:documentation>
+ <xs:documentation>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</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="wsdl-java" type="ns1:wsdlToJavaType">
<xs:annotation>
- <xs:documentation>Element that denotes WSDL To Java annotated types (JDK5) or Service Endpoint Interface (JDK4) and java types. The WSDLStyle and Version can be detected automatically by jbossws.</xs:documentation>
+ <xs:documentation>Generates a JSR-109 service endpoint interface, and optionally a JSR-109 mapping file</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
@@ -32,14 +32,14 @@
<xs:sequence>
<xs:element name="package-namespace" type="ns1:pkgNSType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
- <xs:documentation>Allows user to customize the java package name to xml namespace mapping. User will provide a package/namespace element pairs.</xs:documentation>
+ <xs:documentation>Allows customization of the java package name to xml namespace mapping. This is specified in package/namespace element pairs.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="pkgNSType">
<xs:annotation>
- <xs:documentation>Type that defines a package and namespace map</xs:documentation>
+ <xs:documentation>A package namespace pair.</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:string">
@@ -68,11 +68,15 @@
</xs:complexType>
<xs:complexType name="serviceType">
<xs:sequence>
- <xs:element name="operation" type="ns1:operationType" minOccurs="0" maxOccurs="unbounded"/>
+ <xs:element name="operation" type="ns1:operationType" minOccurs="0" maxOccurs="unbounded">
+ <xs:annotation>
+ <xs:documentation>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.</xs:documentation>
+ </xs:annotation>
+ </xs:element>
</xs:sequence>
<xs:attribute name="name" use="required">
<xs:annotation>
- <xs:documentation>Name of the service. This will appear in the service element of the wsdl as well as in the name attribute of the wsdl definitions.</xs:documentation>
+ <xs:documentation>Name of the service. This will appear in the service element of the generated WSDL file.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
@@ -82,7 +86,7 @@
</xs:attribute>
<xs:attribute name="endpoint" use="required">
<xs:annotation>
- <xs:documentation>Fully Qualified Name of an annotated Endpoint Interface .</xs:documentation>
+ <xs:documentation>The fully qualified Java interface name of the service endpoint interface.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
@@ -92,7 +96,7 @@
</xs:attribute>
<xs:attribute name="style" use="optional" default="rpc">
<xs:annotation>
- <xs:documentation>WSDL Style- either rpc or document. Default is RPC.</xs:documentation>
+ <xs:documentation>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.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
@@ -103,7 +107,7 @@
</xs:attribute>
<xs:attribute name="parameter-style" use="optional" default="wrapped">
<xs:annotation>
- <xs:documentation>The parameter style convention to use when using document/literal</xs:documentation>
+ <xs:documentation>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.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
@@ -116,7 +120,7 @@
<xs:complexType name="namespacesType">
<xs:attribute name="target-namespace" use="required">
<xs:annotation>
- <xs:documentation>The target namespace of the wsdl. By default, it will be derived from the package name of the java endpoint.</xs:documentation>
+ <xs:documentation>The target namespace of the WSDL. By default, it will be derived from the package name of the java endpoint.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:anyURI">
@@ -126,7 +130,7 @@
</xs:attribute>
<xs:attribute name="type-namespace" use="required">
<xs:annotation>
- <xs:documentation>The Namespace to be used for the schema types.By default, will be the same as the target namespace of the wsdl.</xs:documentation>
+ <xs:documentation>The namespace to be used for the schema types.By default, will be the same as the target namespace of the WSDL file.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:anyURI">
@@ -138,7 +142,7 @@
<xs:complexType name="mappingType">
<xs:attribute name="file" use="optional" default="jaxrpc-mapping.xml">
<xs:annotation>
- <xs:documentation>File Name of the jax-rpc mapping file. Defaults to jaxrpc-mapping.xml</xs:documentation>
+ <xs:documentation>The JSR-109 mapping file to generate. This defaults to jaxrpc-mapping.xml</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
@@ -149,16 +153,32 @@
</xs:complexType>
<xs:complexType name="operationType">
<xs:sequence>
- <xs:element name="parameter" type="ns1:parameterType" minOccurs="0" maxOccurs="unbounded"/>
+ <xs:element name="parameter" type="ns1:parameterType" minOccurs="0" maxOccurs="unbounded">
+ <xs:annotation>
+ <xs:documentation>Represents a method parameter. It must be in the exact order of the Java method signature.</xs:documentation>
+ </xs:annotation>
+ </xs:element>
</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:attribute name="name" use="required">
+ <xs:annotation>
+ <xs:documentation>The Java method name.</xs:documentation>
+ </xs:annotation>
+ </xs:attribute>
+ <xs:attribute name="one-way" use="optional">
+ <xs:annotation>
+ <xs:documentation>If true, the generated WSDL operation should have no response message.</xs:documentation>
+ </xs:annotation>
+ </xs:attribute>
+ <xs:attribute name="return-xml-name" type="xs:QName" use="optional">
+ <xs:annotation>
+ <xs:documentation>The name of the return value in the response message.</xs:documentation>
+ </xs:annotation>
+ </xs:attribute>
</xs:complexType>
<xs:complexType name="wsxmlType">
<xs:attribute name="servlet-link" use="optional">
<xs:annotation>
- <xs:documentation>servlet-link attribute for JSE</xs:documentation>
+ <xs:documentation>Specifies the web.xml servlet-link that is used by Java Service Endpoints (WAR style deployments)</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
@@ -168,7 +188,7 @@
</xs:attribute>
<xs:attribute name="ejb-link" use="optional">
<xs:annotation>
- <xs:documentation>ejb-link attribute for Stateless Session Bean endpoints</xs:documentation>
+ <xs:documentation>Specifies the ejb-jar.xml ejb-link for Stateless Session Bean endpoints</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
@@ -179,29 +199,20 @@
</xs:complexType>
<xs:complexType name="javaToWsdlType">
<xs:sequence>
- <xs:element name="service">
- <xs:annotation>
- <xs:documentation>Element that is used to convert the Java endpoint to WSDL.</xs:documentation>
- </xs:annotation>
- <xs:complexType>
- <xs:complexContent>
- <xs:extension base="ns1:serviceType"/>
- </xs:complexContent>
- </xs:complexType>
- </xs:element>
+ <xs:element name="service" type="ns1:serviceType"/>
<xs:element name="namespaces" type="ns1:namespacesType" minOccurs="0">
<xs:annotation>
- <xs:documentation>Namespaces for the WSDL. If this element is unspecified, jbossws will use reasonable defaults, as mandated by the specs.</xs:documentation>
+ <xs:documentation>Namespaces to use when generating the WSDL file.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="mapping" type="ns1:mappingType" minOccurs="0">
<xs:annotation>
- <xs:documentation>Element that deals with the generation of JSR-109 jax-rpc mapping file.</xs:documentation>
+ <xs:documentation>Specifies the JSR-109 mapping file to generate.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="webservices" type="ns1:wsxmlType" minOccurs="0">
<xs:annotation>
- <xs:documentation>Element that deals with the webservices.xml artifact.</xs:documentation>
+ <xs:documentation>Used to generate the JSR-109 webservices.xml file</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
@@ -210,20 +221,31 @@
<xs:sequence>
<xs:element name="mapping" type="ns1:mappingType" minOccurs="0">
<xs:annotation>
- <xs:documentation>Element that deals with the generation of JSR-109 jax-rpc mapping file.</xs:documentation>
+ <xs:documentation>Specifies the JSR-109 mapping file to generate.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="file" type="xs:anyURI" use="required">
<xs:annotation>
- <xs:documentation>Specifies the location of the wsdl file as a URL. An example of a wsdlLocation would be:wsdlLocation="http://example.com/wsdl" or if on the local file system, you can use: wsdlLocation="wsdl/TestService.wsdl" which basically points to the wsdl in the subfolder wsdl, in the current directory where the tool jbossws is executed.</xs:documentation>
+ <xs:documentation>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.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="parameterType">
- <xs:attribute name="type" use="required"/>
- <xs:attribute name="xml-name" type="xs:QName" use="optional"/>
+ <xs:attribute name="type" use="required">
+ <xs:annotation>
+ <xs:documentation>The fully qualified Java class name of the method parameter type.</xs:documentation>
+ </xs:annotation>
+ </xs:attribute>
+ <xs:attribute name="xml-name" type="xs:QName" use="optional">
+ <xs:annotation>
+ <xs:documentation>Used to customize the name of the parameter that is used in the generated WSDL file.</xs:documentation>
+ </xs:annotation>
+ </xs:attribute>
<xs:attribute name="mode" use="optional" default="IN">
+ <xs:annotation>
+ <xs:documentation>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".</xs:documentation>
+ </xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:whiteSpace value="collapse"/>
@@ -233,6 +255,10 @@
</xs:restriction>
</xs:simpleType>
</xs:attribute>
- <xs:attribute name="header" type="xs:boolean" use="optional"/>
+ <xs:attribute name="header" type="xs:boolean" use="optional">
+ <xs:annotation>
+ <xs:documentation>Indicates whether this parameter should be mapped to a SOAP header instead of a SOAP body part.</xs:documentation>
+ </xs:annotation>
+ </xs:attribute>
</xs:complexType>
</xs:schema>
|
