1 <?xml version="1.0" encoding="UTF-8"?>
4 DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
6 Copyright (c) 2012-2017 Oracle and/or its affiliates. All rights reserved.
8 The contents of this file are subject to the terms of either the GNU
9 General Public License Version 2 only ("GPL") or the Common Development
10 and Distribution License("CDDL") (collectively, the "License"). You
11 may not use this file except in compliance with the License. You can
12 obtain a copy of the License at
13 https://oss.oracle.com/licenses/CDDL+GPL-1.1
14 or LICENSE.txt. See the License for the specific
15 language governing permissions and limitations under the License.
17 When distributing the software, include this License Header Notice in each
18 file and include the License file at LICENSE.txt.
20 GPL Classpath Exception:
21 Oracle designates this particular file as subject to the "Classpath"
22 exception as provided by Oracle in the GPL Version 2 section of the License
23 file that accompanied this code.
26 If applicable, add the following below the License Header, with the fields
27 enclosed by brackets [] replaced by your own identifying information:
28 "Portions Copyright [year] [name of copyright owner]"
31 If you wish your version of this file to be governed by only the CDDL or
32 only the GPL Version 2, indicate your decision by adding "[Contributor]
33 elects to include this software in this distribution under the [CDDL or GPL
34 Version 2] license." If you don't indicate a single choice of license, a
35 recipient has the option to distribute your version of this file under
36 either the CDDL, the GPL Version 2 or to extend the choice of license to
37 its licensees as provided above. However, if you add GPL Version 2 code
38 and therefore, elected the GPL Version 2 license, then the option applies
39 only if the new code is made subject to such option by the copyright
45 XML Schema for external mapping metadata for the JAX-WS RI & JSR-181.
46 The data is used to define the attributes of a particular Java Web Service
49 Corresponding Java annotation: javax.jws.WebParam.Mode
53 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
54 targetNamespace="http://xmlns.oracle.com/webservices/jaxws-databinding"
55 xmlns="http://xmlns.oracle.com/webservices/jaxws-databinding"
56 elementFormDefault="qualified" attributeFormDefault="unqualified" version="1.0">
58 <xs:element name="java-wsdl-mapping" type="java-wsdl-mapping-type">
61 The top-level element is the Web Service end-point being defined.
64 java-type-name: the SEI class these definitions apply to
65 databinding: the databinding module to use, such as
66 "glassfish.jaxb", "toplink.jaxb", "toplink.sdo".
71 <xs:complexType name="java-wsdl-mapping-type">
73 <xs:element name="xml-schema-mapping" minOccurs="0">
76 The xml-schema-mapping element points to the
77 external JAXB annotations for the value types
78 that occur in an SEI. This mapping element can
79 either be defined externally and referenced via a
80 URI, or embedded as an XML fragment within the
81 current instance end-point definition document.
86 <xs:any minOccurs="0" maxOccurs="unbounded"/>
90 <xs:group ref="class-annotation" minOccurs="0" maxOccurs="unbounded">
93 The class-annotation group defines the set of
94 annotations applicable to the Java class
99 <xs:element name="java-methods" minOccurs="0">
102 Each java method in the SEI may use the external
103 metadata defined in this schema in addition to or
104 in lieu of the standard JAX-WS annotations.
109 <xs:element ref="java-method" minOccurs="0" maxOccurs="unbounded"/>
114 <xs:attribute name="name" type="xs:string" use="optional"/>
115 <xs:attribute name="java-type-name" type="xs:string" use="optional"/>
116 <xs:attribute name="existing-annotations" type="existing-annotations-type" use="optional"/>
117 <xs:attribute name="databinding" type="xs:string" use="optional"/>
118 <xs:anyAttribute namespace="##other" processContents="skip"/>
121 <xs:group name="class-annotation">
124 The class-annotation group defines the set of annotations
125 that may be applied to a class declaration.
129 <xs:any namespace="##other" processContents="skip"/>
130 <xs:element ref="web-service" minOccurs="0"/>
131 <xs:element ref="soap-binding" minOccurs="0"/>
132 <xs:element ref="binding-type" minOccurs="0"/>
133 <xs:element ref="mtom" minOccurs="0"/>
134 <xs:element ref="handler-chain" minOccurs="0"/>
135 <xs:element ref="service-mode" minOccurs="0"/>
136 <xs:element ref="web-fault" minOccurs="0"/>
137 <xs:element ref="web-service-client" minOccurs="0"/>
138 <xs:element ref="addressing" minOccurs="0"/>
142 <xs:element name="java-method">
145 The java-method element defines a set of annotations that may
146 be applied to a method and its parameters.
152 <xs:group ref="method-annotation" minOccurs="0" maxOccurs="unbounded"/>
153 <xs:element name="java-params" minOccurs="0">
156 Each Java parameter may have the annotations
157 defined by the java-param element.
162 <xs:element ref="java-param" maxOccurs="unbounded"/>
167 <xs:attribute name="name" type="xs:string" use="required">
170 The name parameter corresponds to the Java name of
171 the method to which the annotations apply.
175 <xs:anyAttribute namespace="##other" processContents="skip"/>
179 <xs:group name="method-annotation">
182 The method-annotation group defines the set of
183 annotations applicable to a defined method in the SEI.
187 <xs:any namespace="##other" processContents="skip"/>
188 <xs:element ref="web-method" minOccurs="0"/>
189 <xs:element ref="web-result" minOccurs="0"/>
190 <xs:element ref="oneway" minOccurs="0"/>
191 <xs:element ref="soap-binding" minOccurs="0"/>
192 <xs:element ref="action" minOccurs="0"/>
193 <xs:element ref="web-endpoint" minOccurs="0"/>
197 <xs:element name="java-param">
200 The java-param element contains the group of JAX-WS parameter
201 annotations, plus optionally binds a specific Java type
202 mapping to the parameter. The set of applicable attributes is
203 not specifically enumerated.
208 <xs:group ref="param-annotation" minOccurs="0" maxOccurs="unbounded"/>
210 <xs:attribute name="java-type" type="xs:string" use="optional"/>
211 <xs:anyAttribute namespace="##other" processContents="skip"/>
215 <xs:group name="param-annotation">
218 The param-annotation defines the annotations applied to an
219 individual parameter. Theses consist of the JAX-WS standard
220 WebParam plus others to be defined.
224 <xs:any namespace="##other" processContents="skip"/>
225 <xs:element ref="web-param" minOccurs="0"/>
229 <xs:simpleType name="web-param-mode">
232 Corresponding Java annotation: javax.jws.WebParam.Mode (Enum)
235 <xs:restriction base="xs:string">
236 <xs:enumeration value="IN"/>
237 <xs:enumeration value="OUT"/>
238 <xs:enumeration value="INOUT"/>
242 <xs:element name="web-service">
245 Corresponding Java annotation: javax.jws.WebService
250 <xs:attribute name="endpoint-interface" type="xs:string" default=""/>
251 <xs:attribute name="name" type="xs:string" default=""/>
252 <xs:attribute name="port-name" type="xs:string" default=""/>
253 <xs:attribute name="service-name" type="xs:string" default=""/>
254 <xs:attribute name="target-namespace" type="xs:string" default=""/>
255 <xs:attribute name="wsdl-location" type="xs:string" default=""/>
259 <xs:element name="web-param">
262 Corresponding Java annotation: javax.jws.WebParam
263 @Target(value={PARAMETER}
267 <xs:attribute name="header" type="xs:boolean" default="false"/>
268 <xs:attribute name="mode" type="web-param-mode" default="IN"/>
269 <xs:attribute name="name" type="xs:string" default=""/>
270 <xs:attribute name="part-name" type="xs:string" default=""/>
271 <xs:attribute name="target-namespace" type="xs:string" default=""/>
276 The following elements may be applied to a method:
277 @Target(value={METHOD})
279 <xs:element name="oneway">
282 Corresponding Java annotation: javax.jws.Oneway
290 <xs:element name="web-method">
293 Corresponding Java annotation: javax.jws.WebMethod
297 <xs:attribute name="action" type="xs:string" default=""/>
298 <xs:attribute name="exclude" type="xs:boolean" default="false"/>
299 <xs:attribute name="operation-name" type="xs:string" default=""/>
303 <xs:element name="web-result">
306 Corresponding Java annotation: javax.jws.WebResult
310 <xs:attribute name="header" type="xs:boolean" default="false"/>
311 <xs:attribute name="name" type="xs:string" default=""/>
312 <xs:attribute name="part-name" type="xs:string" default=""/>
313 <xs:attribute name="target-namespace" type="xs:string" default=""/>
319 The following types correspond to JAX-WS Enums
321 <xs:simpleType name="soap-binding-style">
324 Corresponding Java annotation: javax.jws.soap.SOAPBinding.Style
327 <xs:restriction base="xs:string">
328 <xs:enumeration value="DOCUMENT"/>
329 <xs:enumeration value="RPC"/>
333 <xs:simpleType name="soap-binding-use">
336 Corresponding Java annotation: javax.jws.soap.SOAPBinding.Use
339 <xs:restriction base="xs:string">
340 <xs:enumeration value="LITERAL"/>
341 <xs:enumeration value="ENCODED"/>
345 <xs:simpleType name="soap-binding-parameter-style">
348 Corresponding Java annotation:
349 javax.jws.soap.SOAPBinding.ParameterStyle
352 <xs:restriction base="xs:string">
353 <xs:enumeration value="BARE"/>
354 <xs:enumeration value="WRAPPED"/>
359 The following apply to types and in some cases methods.
361 <xs:element name="soap-binding">
364 Corresponding Java annotation: javax.jws.soap.SOAPBinding
368 <xs:attribute name="style" type="soap-binding-style" default="DOCUMENT"/>
369 <xs:attribute name="use" type="soap-binding-use" default="LITERAL"/>
370 <xs:attribute name="parameter-style" type="soap-binding-parameter-style" default="WRAPPED"/>
374 <xs:element name="binding-type">
377 Corresponding Java annotation: javax.xml.ws.BindingType
381 <xs:attribute name="value" type="xs:string" default=""/>
385 <xs:element name="request-wrapper">
388 Corresponding Java annotation: javax.xml.ws.RequestWrapper
392 <xs:attribute name="local-name" type="xs:string" default=""/>
393 <xs:attribute name="target-namespace" type="xs:string" default=""/>
394 <xs:attribute name="class-name" type="xs:string" default=""/>
395 <xs:attribute name="part-name" type="xs:string" default=""/>
399 <xs:element name="response-wrapper">
402 Corresponding Java annotation: javax.xml.ws.ResponseWrapper
406 <xs:attribute name="local-name" type="xs:string" default=""/>
407 <xs:attribute name="target-namespace" type="xs:string" default=""/>
408 <xs:attribute name="class-name" type="xs:string" default=""/>
409 <xs:attribute name="part-name" type="xs:string" default=""/>
413 <xs:element name="action">
416 Corresponding Java annotation: javax.xml.ws.Action
421 <xs:element ref="fault-action" minOccurs="0" maxOccurs="unbounded"/>
423 <xs:attribute name="input" type="xs:string" default=""/>
424 <xs:attribute name="output" type="xs:string" default=""/>
428 <xs:element name="fault-action">
431 Corresponding Java annotation: javax.xml.ws.FaultAction
435 <xs:attribute name="className" type="xs:string" use="required"/>
436 <xs:attribute name="value" type="xs:string" default=""/>
440 <xs:element name="mtom">
443 Corresponding Java annotation: javax.xml.ws.soap.MTOM
447 <xs:attribute name="enabled" type="xs:boolean" default="true"/>
448 <xs:attribute name="threshold" type="xs:int" default="0"/>
453 <xs:element name="handler-chain">
456 Corresponding Java annotation: javax.jws.HandlerChain
460 <xs:attribute name="file" type="xs:string"/>
462 <!--<xs:attribute name="name" type="xs:string" default=""/>-->
466 <xs:element name="service-mode">
469 Corresponding Java annotation: javax.xml.ws.ServiceMode
473 <xs:attribute name="value" type="xs:string" default="PAYLOAD"/>
477 <xs:element name="web-endpoint">
480 Corresponding Java annotation: javax.xml.ws.WebEndpoint
484 <xs:attribute name="name" type="xs:string"/>
488 <xs:element name="web-fault">
491 Corresponding Java annotation: javax.xml.ws.WebFault
495 <xs:attribute name="name" type="xs:string"/>
496 <xs:attribute name="targetNamespace" type="xs:string"/>
497 <xs:attribute name="faultBean" type="xs:string"/>
498 <xs:attribute name="messageName" type="xs:string"/>
502 <xs:element name="web-service-client">
505 Corresponding Java annotation: javax.xml.ws.WebServiceClient
509 <xs:attribute name="name" type="xs:string"/>
510 <xs:attribute name="targetNamespace" type="xs:string"/>
511 <xs:attribute name="wsdlLocation" type="xs:string"/>
515 <xs:element name="web-service-provider">
518 Corresponding Java annotation: javax.xml.ws.WebServiceProvider
522 <xs:attribute name="targetNamespace" type="xs:string"/>
523 <xs:attribute name="serviceName" type="xs:string"/>
524 <xs:attribute name="portName" type="xs:string"/>
525 <xs:attribute name="wsdlLocation" type="xs:string"/>
529 <xs:element name="web-service-ref">
532 Corresponding Java annotation: javax.xml.ws.WebServiceRef
536 <xs:attribute name="name" type="xs:string"/>
537 <xs:attribute name="type" type="xs:string"/>
538 <xs:attribute name="mappedName" type="xs:string"/>
539 <xs:attribute name="value" type="xs:string"/>
540 <xs:attribute name="wsdlLocation" type="xs:string"/>
541 <xs:attribute name="lookup" type="xs:string"/>
545 <xs:element name="addressing">
547 <xs:documentation>Corresponding Java annotation: javax.xml.ws.soap.Addressing</xs:documentation>
550 <xs:attribute name="enabled" type="xs:boolean" default="true"/>
551 <xs:attribute name="required" type="xs:boolean" default="false"/>
555 <xs:simpleType name="existing-annotations-type">
556 <xs:restriction base="xs:string">
557 <xs:enumeration value="merge"/>
558 <xs:enumeration value="ignore"/>