Jakarta XML Web Services

The expert group decided against this goal for this release. We will look at adding support in a future revision of the Jakarta XML Web Services specification.

Specification: Jakarta XML Web Services

Version: 4.0

Status: Final Release

Release: February 23, 2022

  1
2
3
4
5
6
7

  package com.example.hello;

public class Hello {
    public static void main(String args[]) {
        System.out.println("Hello World");
    }
}

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

  // Types generated when importing WSDL
package example;
public class A { ... }

package example1;
public class B extends A { ... }

package example2;
public class C extends A { ... }

// Directly annotated SEI with classes B and C
@WebService
@XmlSeeAlso({B.class, C.class})
public interface MyService {
    public A echo(A a);
}

// Indirectly annotated SEI using generated JAXB ObjectFatories
@XmlSeeAlso({example1.ObjectFactory.class, example2.ObjectFactory.class})
public interface MyService {
    public A echo(A a);
}

  1
2
3
4
5
6
7
8
9
10
11
12

  <operation name="getPrice">
  <input message="tns:getPrice" />
  <output message="tns:getPriceResponse" wsam:Action="outAction"/>
  <fault name="InvalidTickerException"
         message="tns:InvalidTickerException" wsam:Action="faultAction"/>
</operation>

// the mapped java method
@Action(output = "outAction", fault = {
        @FaultAction(className=InvalidTickerException.class,
                     value="faultAction")})
float getPrice(String ticker) throws InvalidTickerException;

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

  <!-- WSDL extract -->
<types>
  <xsd:element name="setLastTradePrice">
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="tickerSymbol" type="xsd:string"/>
        <xsd:element name="lastTradePrice" type="xsd:float"/>
      </xsd:sequence>
    </xsd:complexType>
  </xsd:element>

  <xsd:element name="setLastTradePriceResponse">
    <xsd:complexType>
      <xsd:sequence/>
    </xsd:complexType>
  </xsd:element>
</types>

<message name="setLastTradePrice">
  <part name="setLastTradePrice"
        element="tns:setLastTradePrice"/>
</message>

<message name="setLastTradePriceResponse">
  <part name="setLastTradePriceResponse"
        element="tns:setLastTradePriceResponse"/>
</message>

<portType name="StockQuoteUpdater">
  <operation name="setLastTradePrice">
    <input message="tns:setLastTradePrice"/>
    <output message="tns:setLastTradePriceResponse"/>
  </operation>
</portType>

// non-wrapper style mapping
SetLastTradePriceResponse setLastTradePrice(
    SetLastTradePrice setLastTradePrice);

// wrapper style mapping
void setLastTradePrice(String tickerSymbol, float lastTradePrice);

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

  <!-- WSDL extract -->
<message name="getPrice">
  <part name="ticker" type="xsd:string"/>
</message>

<message name="getPriceResponse">
  <part name="price" type="xsd:float"/>
</message>

<portType name="StockQuote">
  <operation name="getPrice">
    <input message="tns:getPrice"/>
    <output message="tns:getPriceResponse"/>
  </operation>
</portType>

<!-- Synthesized response bean element -->
<xsd:element name="getPriceResponse">
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element name="price" type="xsd:float"/>
    </xsd:sequence>
  </xsd:complexType>
</xsd:element>

// synchronous mapping
@WebService
public interface StockQuote {
    float getPrice(String ticker);
}

// asynchronous mapping
@WebService
public interface StockQuote {
    float getPrice(String ticker);
    Response<Float> getPriceAsync(String ticker);
    Future<?> getPriceAsync(String ticker, AsyncHandler<Float>);
}

Service service = ...;
StockQuote quoteService = (StockQuote) service.getPort(portName);
Float quote = quoteService.getPrice(ticker);
Service service = ...;
StockQuote quoteService = (StockQuote) service.getPort(portName);
Response<Float> response = quoteService.getPriceAsync(ticker);
while (!response.isDone()) {
    // do something while we wait
}
Float quote = response.get();
class MyPriceHandler implements AsyncHandler<Float> {
    ...
    public void handleResponse(Response<Float> response) {

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

  <!-- WSDL extract -->
<types>
  <xsd:schema targetNamespace="...">
    <xsd:element name="faultDetail">
      <xsd:complexType>
        <xsd:sequence>
          <xsd:element name="majorCode" type="xsd:int"/>
          <xsd:element name="minorCode" type="xsd:int"/>
        </xsd:sequence>
      </xsd:complexType>
    </xsd:element>
  </xsd:schema>
</types>

<message name="operationException">
  <part name="faultDetail" element="tns:faultDetail"/>
</message>

<portType name="StockQuoteUpdater">
  <operation name="setLastTradePrice">
    <input .../>
    <output .../>
    <fault name="operationException"
           message="tns:operationException"/>
  </operation>
</portType>

// fault mapping
@WebFault(name="faultDetail", targetNamespace="...")
class OperationException extends Exception {
    OperationException(String message, FaultDetail faultInfo) {...}
    OperationException(String message, FaultDetail faultInfo, Throwable cause) {...}
    FaultDetail getFaultInfo() {...}
}

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

  <!-- WSDL extract -->
<wsdl:message name="ClaimIn">
  <wsdl:part name="body" element="types:ClaimDetail"/>
  <wsdl:part name="ClaimPhoto" type="xsd:base64Binary"/>
</wsdl:message>

<wsdl:portType name="ClaimPortType">
  <wsdl:operation name="SendClaim">
    <wsdl:input message="tns:ClaimIn"/>
  </wsdl:operation>
</wsdl:portType>

<wsdl:binding name="ClaimBinding" type="tns:ClaimPortType">
  <soapbind:binding style="document" transport="..."/>
  <wsdl:operation name="SendClaim">
    <soapbind:operation soapAction="..."/>
    <wsdl:input>
      <mime:multipartRelated>
        <mime:part>
          <soapbind:body parts="body" use="literal"/>
        </mime:part>
        <mime:part>
          <mime:content part="ClaimPhoto" type="image/jpeg"/>
          <mime:content part="ClaimPhoto" type="image/gif"/>
        </mime:part>
      </mime:multipartRelated>
    </wsdl:input>
  </wsdl:operation>
</wsdl:binding>

// Mapped Java interface without mime:content metadata
@WebService
public interface ClaimPortType {
    public String sendClaim(ClaimDetail detail, byte claimPhoto[]);
}

// Mapped Java interface using mime:content metadata
@WebService
public interface ClaimPortType {
    public String sendClaim(ClaimDetail detail, Image claimPhoto);
}

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

  <!-- WSDL extract -->
<wsdl:service name="StockQuoteService">
  <wsdl:port name="StockQuoteHTTPPort" binding="StockQuoteHTTPBinding"/>
  <wsdl:port name="StockQuoteSMTPPort" binding="StockQuoteSMTPBinding"/>
</wsdl:service>

// Generated Service Class
@WebServiceClient(name="StockQuoteService",
                  targetNamespace="http://example.com/stocks",
                  wsdlLocation="http://example.com/stocks.wsdl")
public class StockQuoteService extends jakarta.xml.ws.Service {

    public StockQuoteService() {
        super(new URL("http://example.com/stocks.wsdl"),
              new QName("http://example.com/stocks", "StockQuoteService"));
    }

    public StockQuoteService(WebServiceFeature ... featurs) {
        super(new URL("http://example.com/stocks.wsdl"),
              new QName("http://example.com/stocks", "StockQuoteService"),
              features);
    }

    public StockQuoteService(URL wsdlLocation) {
        super(wsdlLocation,
              new QName("http://example.com/stocks", "StockQuoteService"));
    }

    public StockQuoteService(URL wsdlLocation, WebServiceFeature ... features) {
        super(wsdlLocation,
              new QName("http://example.com/stocks", "StockQuoteService"),
              features);
    }

    public StockQuoteService(URL wsdlLocation, QName serviceName) {
        super(wsdlLocation, serviceName);
    }

    public StockQuoteService(URL wsdlLocation, QName serviceName,
                             WebServiceFeature ... features) {
        super(wsdlLocation, serviceName, features);
    }

    @WebEndpoint(name="StockQuoteHTTPPort")
    public StockQuoteProvider getStockQuoteHTTPPort() {
        return (StockQuoteProvider) super.getPort(
                    new QName("http://example.com/stocks","StockQuoteHTTPPort"),
                    StockQuoteProvider.class);
    }

    @WebEndpoint(name="StockQuoteHTTPPort")
    public StockQuoteProvider getStockQuoteHTTPPort(WebServiceFeature... features) {
        return (StockQuoteProvider) super.getPort(
                    new QName("http://example.com/stocks","StockQuoteHTTPPort"),
                    StockQuoteProvider.class,
                    features);
    }

    @WebEndpoint(name="StockQuoteSMTPPort")
    public StockQuoteProvider getStockQuoteSMTPPort() {
        return (StockQuoteProvider) super.getPort(
                    new QName("http://example.com/stocks","StockQuoteSMTPPort"),
                    StockQuoteProvider.class);
    }

    @WebEndpoint(name="StockQuoteSMTPPort")
    public StockQuoteProvider getStockQuoteSMTPPort(WebServiceFeature... features) {
        return (StockQuoteProvider) super.getPort(
                    new QName("http://example.com/stocks","StockQuoteSMTPPort"),
                    StockQuoteProvider.class,
                    features);
    }
}

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

  // Java
package com.example;
@WebService
public interface StockQuoteProvider {
    float getPrice(String tickerSymbol)
        throws TickerException;
}

<!-- WSDL extract -->
<types>
  <xsd:schema targetNamespace="...">
    <!-- element declarations -->
    <xsd:element name="getPrice"
        type="tns:getPriceType"/>
    <xsd:element name="getPriceResponse"
        type="tns:getPriceResponseType"/>
    <xsd:element name="TickerException"
        type="tns:TickerExceptionType"/>

    <!-- type definitions -->
    ...
  </xsd:schema>
</types>

<message name="getPrice">
  <part name="getPrice" element="tns:getPrice"/>
</message>

<message name="getPriceResponse">
  <part name="getPriceResponse" element="tns:getPriceResponse"/>
</message>

<message name="TickerException">
  <part name="TickerException" element="tns:TickerException"/>
</message>

<portType name="StockQuoteProvider">
  <operation name="getPrice">
    <input message="tns:getPrice" wsam:action="..."/>
    <output message="tns:getPriceResponse" wsam:action="..."/>
    <fault message="tns:TickerException" wsam:action="..."/>
  </operation>
</portType>

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

  // Java
package com.example;
@WebService
public interface StockQuoteProvider {
    float getPrice(String tickerSymbol)
        throws TickerException;
}

<!-- WSDL extract -->
<types>
  <xsd:schema targetNamespace="...">
    <!-- element declarations -->
    <xsd:element name="TickerException"
        type="tns:TickerExceptionType"/>

    <!-- type definitions -->
    ...
  </xsd:schema>
</types>

<message name="getPrice">
  <part name="tickerSymbol" type="xsd:string"/>
</message>

<message name="getPriceResponse">
  <part name="return" type="xsd:float"/>
</message>

<message name="TickerException">
  <part name="TickerException" element="tns:TickerException"/>
</message>

<portType name="StockQuoteProvider">
  <operation name="getPrice">
    <input message="tns:getPrice"/>
    <output message="tns:getPriceResponse"/>
    <fault message="tns:TickerException"/>
  </operation>
</portType>

  1
2
3
4
5
6
7
8
9
10
11
12

  @Action(input="inAction")
public float getPrice(String ticker) throws InvalidTickerException;

// the mapped wsdl:operation if targetNamespace="http://example.com" and
// portType="StockQuoteProvider"
<operation name="getPrice">
  <input name="foo" message="tns:getPrice" wsam:Action="inAction"/>
  <output name="bar" message="tns:getPriceResponse"
    wsam:Action="http://example.com/StockQuoteProvider/getPriceResponse" />
  <fault name="FooTickerException" message="tns:InvalidTickerException"
    wsam:Action="http://example.com/StockQuoteProvider/getPrice/Fault/InvalidTickerException"/>
</operation>

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

  float getPrice(@WebParam(name="tickerSymbol") String sym);

@XmlRootElement(name="getPrice", targetNamespace="...")
@XmlType(name="getPrice", targetNamespace="...")
@XmlAccessorType(AccessType.FIELD)
public class GetPrice {
    @XmlElement(name="tickerSymbol", targetNamespace="")
    public String tickerSymbol;
}

@XmlRootElement(name="getPriceResponse", targetNamespace="...")
@XmlType(name="getPriceResponse", targetNamespace="...")
@XmlAccessorType(AccessType.FIELD)
public class GetPriceResponse {
    @XmlElement(name="return", targetNamespace="")
    public float _return;
}

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

  @WebFault(name="UnknownTickerFault", targetNamespace="...")
public class UnknownTicker extends Exception {
    ...
    public UnknownTicker(Sting ticker) { ... }
    public UnknownTicker(Sting ticker, String message) { ... }
    public UnknownTicker(Sting ticker, String message, Throwable cause)
        { ... }
    public String getTicker() { ... }
}

@XmlRootElement(name="UnknownTickerFault" targetNamespace="...")
@XmlAccessorType(AccessType.FIELD)
@XmlType(name="UnknownTicker", namespace="...",
    propOrder={"message", "ticker"})
public class UnknownTickerBean {
    ...
    public UnknownTickerBean() { ... }
    public String getTicker() { ... }
    public void setTicker(String ticker) { ... }
    public String getMessage() { ... }
    public void setMessage(String message) { ... }
}

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

  <portType name="StockQuoteProvider">
  <operation name="getPrice" parameterOrder="tickerSymbol">
    <input message="tns:getPrice"/>
    <output message="tns:getPriceResponse"/>
    <fault message="tns:unknowntickerException"/>
  </operation>
</portType>

<binding name="StockQuoteProviderBinding">
  <!-- binding specific extensions possible here -->
  <operation name="getPrice">
    <!-- binding specific extensions possible here -->
    <input message="tns:getPrice">
      <!-- binding specific extensions possible here -->
    </input>
    <output message="tns:getPriceResponse">
      <!-- binding specific extensions possible here -->
    </output>
    <fault message="tns:unknowntickerException">
      <!-- binding specific extensions possible here -->
    </fault>
  </operation>
</binding>

  1
2
3
4

  public <T extends Shape> T setColor(T shape, Color color) {
    shape.setColor(color);
    return shape;
}

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

  @XmlRootElement(name = "setColor", namespace = "...")
@XmlAccessorType(AccessType.FIELD)
@XmlType(name = "setColor", namespace = "...")
public class SetColor {

    @XmlElement(name = "arg0", namespace = "")
    private Shape arg0;

    @XmlElement(name = "arg1", namespace = "")
    private Color arg0;

    public Shape getArg0() {
        return this.arg0;
    }

    public void setArg0(Shape arg0) {
        this.arg0 = arg0;
    }

    public Color getArg1() {
        return this.arg1;
    }

    public void setArg1(Color arg1) {
        this.arg1 = arg1;
    }
}

  1
2
3

  public List<Shape> echoShapeList(List<Shape> list) {
    return list;
}

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

  @XmlRootElement(name = "echoShapeList", namespace = "...")
@XmlAccessorType(AccessType.FIELD)
@XmlType(name = "echoShapeList", namespace = "...")
public class EchoShapeList {

    @XmlElement(name = "arg0", namespace = "")
    private List<Shape> arg0;

    public List<Shape> getArg0() {
        return this.arg0;
    }

    public void setArg0(List<Shape> arg0) {
        this.arg0 = arg0;
    }
}

  1
2
3
4
5

  public <T> T echoTList(List<T> list) {
    if (list.size() == 0)
        return null;
    return list.iterator().next();
}

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

  @XmlRootElement(name = "echoTList", namespace = "...")
@XmlAccessorType(AccessType.FIELD)
@XmlType(name = "echoTList", namespace = "...")
public class EchoTList {

    @XmlElement(name = "arg0", namespace = "")
    private List<Object> arg0;

    public List<Object> getArg0() {
        return this.arg0;
    }

    public void setArg0(List<Object> arg0) {
        this.arg0 = arg0;
    }
}

  1
2
3
4
5
6
7

  public List<? extends Shape> setArea(List<? extends Shape> list) {
    Iterator iterator = list.iterator();
    while(iterator.haNext()) {
        iterator.next().setArea(...);
    }
    return list;
}

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

  @XmlRootElement(name = "setArea", namespace = "...")
@XmlAccessorType(AccessType.FIELD)
@XmlType(name = "setArea", namespace = "...")
public class SetArea {

    @XmlElement(name = "arg0", namespace = "")
    private List<Shape> arg0;

    public List<Shape> getArg0() {
        return this.arg0;
    }

    public void setArg0(List<Shape> arg0) {
        this.arg0 = arg0;
    }
}

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

  <binding name="StockQuoteProviderBinding">
  <soap:binding
    transport="http://schemas.xmlsoap.org/soap/http"
        style="document"/>
  <operation name="getPrice">
    <soap:operation style="document|rpc"/>
    <input message="tns:getPrice">
      <soap:body use="literal"/>
    </input>
    <output message="tns:getPriceResponse">
      <soap:body use="literal"/>
    </output>
    <fault message="tns:unknowntickerException">
      <soap:fault use="literal"/>
    </fault>
  </operation>
</binding>

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

  <types>
  <schema targetNamespace="...">
    <xsd:element name="getPrice" type="tns:getPriceType"/>
    <xsd:complexType name="getPriceType">
      <xsd:sequence>
        <xsd:element name="tickerSymbol" type="xsd:string"/>
      </xsd:sequence>
    </xsd:complexType>

    <xsd:element name="getPriceResponse"
        type="tns:getPriceResponseType"/>
    <xsd:complexType name="getPriceResponseType">
      <xsd:sequence>
        <xsd:element name="return" type="xsd:float"/>
      </xsd:sequence>
    </xsd:complexType>
  </schema>
</types>

<message name="getPrice">
  <part name="getPrice" element="tns:getPrice"/>
</message>

<message name="getPriceResponse">
  <part name="getPriceResponse" element="tns:getPriceResponse"/>
</message>

<portType name="StockQuoteProvider">
  <operation name="getPrice" parameterOrder="tickerSymbol">
    <input message="tns:getPrice"/>
    <output message="tns:getPriceResponse"/>
  </operation>
</portType>

<binding name="StockQuoteProviderBinding">
  <soap:binding
      transport="http://schemas.xmlsoap.org/soap/http" style="document"/>
  <operation name="getPrice" parameterOrder="tickerSymbol">
    <soap:operation/>
    <input message="tns:getPrice">
      <soap:body use="literal"/>
    </input>
    <output message="tns:getPriceResponse">
      <soap:body use="literal"/>
    </output>
  </operation>
</binding>

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

  <types>
  <schema targetNamespace="...">
    <xsd:element name="getPrice" type="tns:getPriceType"/>
    <xsd:complexType name="getPriceType">
      <xsd:sequence>
        <xsd:element form="unqualified" name="tickerSymbol"
            type="xsd:string"/>
      </xsd:sequence>
    </xsd:complexType>

    <xsd:element name="getPriceResponse"
        type="tns:getPriceResponseType"/>
    <xsd:complexType name="getPriceResponseType">
      <xsd:sequence>
        <xsd:element form="unqualified" name="return"
            type="xsd:float"/>
        </xsd:sequence>
    </xsd:complexType>
  </schema>
</types>

<message name="getPrice">
  <part name="tickerSymbol" type="xsd:string"/>
</message>

<message name="getPriceResponse">
  <part name="result" type="xsd:float"/>
</message>

<portType name="StockQuoteProvider">
  <operation name="getPrice">
    <input message="tns:getPrice"/>
    <output message="tns:getPriceResponse"/>
  </operation>
</portType>

<binding name="StockQuoteProviderBinding">
  <soap:binding
      transport="http://schemas.xmlsoap.org/soap/http" style="rpc"/>
  <operation name="getPrice">
    <soap:operation/>
    <input message="tns:getPrice">
      <soap:body use="literal"/>
    </input>
    <output message="tns:getPriceResponse">
      <soap:body use="literal"/>
    </output>
  </operation>
</binding>

  1
2
3

  <wsam:Addressing wsp:Optional="true">
  <wsp:Policy/>
</wsam:Addressing>

  1
2
3

  <wsam:Addressing>
  <wsp:Policy/>
</wsam:Addressing>

  1
2
3
4
5

  <wsam:Addressing wsp:Optional="true">
  <wsp:Policy>
    <wsam:NonAnonymousResponses/>
  </wsp:Policy>
</wsam:Addressing>

  1
2
3

  URL wsdlLocation = new URL("http://example.org/my.wsdl");
QName serviceName = new QName("http://example.org/sample", "MyService");
Service s = Service.create(wsdlLocation, serviceName);

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

  // Generated Service Class
@WebServiceClient(name="StockQuoteService",
                  targetNamespace="http://example.com/stocks",
                  wsdlLocation="http://example.com/stocks.wsdl")
public class StockQuoteService extends jakarta.xml.ws.Service {
    public StockQuoteService() {
        super(new URL("http://example.com/stocks.wsdl"),
              new QName("http://example.com/stocks", "StockQuoteService"));
    }

    public StockQuoteService(WebServiceFeature ... features) {
        super(new URL("http://example.com/stocks.wsdl"),
              new QName("http://example.com/stocks", "StockQuoteService"),
              features);
    }

    public StockQuoteService(URL wsdlLocation) {
        super(wsdlLocation,
              new QName("http://example.com/stocks", "StockQuoteService"));
    }

    public StockQuoteService(URL wsdlLocation, WebServiceFeature ... features) {
        super(wsdlLocation,
              new QName("http://example.com/stocks", "StockQuoteService"),
              features);
    }

    public StockQuoteService(URL wsdlLocation, QName serviceName) {
        super(wsdlLocation, serviceName);
    }

    public StockQuoteService(URL wsdlLocation, QName serviceName,
                             WebServiceFeature ... features) {
        super(wsdlLocation, serviceName, features);
    }

    ...
}

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

  public class Service {

    private ServiceDelegate delegate;

    protected Service(java.net.URL wsdlDocumentLocation,
                      QName serviceName) {
        delegate = Provider.provider()
                           .createServiceDelegate(wsdlDocumentLocation
                                                  serviceName,
                                                  this.getClass());
    }

    public static Service create(java.net.URL wsdlDocumentLocation,
                                 QName serviceName) {
        return new Service(wsdlDocumentLocation, serviceName);
    }

    // begin delegated methods
    public <T> T getPort(Class<T> serviceEndpointInterface) {
        return delegate.getPort(serviceEndpointInterface);
    }

    ...
}

  1
2
3
4
5
6
7

  jakarta.xml.ws.Service service = ...;
com.example.StockQuoteProvider proxy = service.getPort(portName,
    com.example.StockQuoteProvider.class)
jakarta.xml.ws.BindingProvider bp = (jakarta.xml.ws.BindingProvider) proxy;
Map<String,Object> context = bp.getRequestContext();
context.setProperty("jakarta.xml.ws.session.maintain", Boolean.TRUE);
proxy.getLastTradePrice("ACME");

  1
2
3
4
5

  Source reqMsg = ...;
Service service = ...;
Dispatch<Source> disp = service.createDispatch(portName,
    Source.class, PAYLOAD);
Source resMsg = disp.invoke(reqMsg);

  1
2
3
4
5

  SOAPMessage soapReqMsg = ...;
Service service = ...;
Dispatch<SOAPMessage> disp = service.createDispatch(portName,
    SOAPMessage.class, MESSAGE);
SOAPMessage soapResMsg = disp.invoke(soapReqMsg);

  1
2
3
4
5
6
7

  JAXBContext jc = JAXBContext.newInstance("primer.po");
Unmarshaller u = jc.createUnmarshaller();
PurchaseOrder po = (PurchaseOrder) u.unmarshal(
    new FileInputStream("po.xml"));
Service service = ...;
Dispatch<Object> disp = service.createDispatch(portName, jc, PAYLOAD);
OrderConfirmation conf = (OrderConfirmation) disp.invoke(po);

  1
2
3
4
5
6
7
8
9

  SOAPMessage soapReqMsg = ...;
Service service = ...;
Dispatch<SOAPMessage> disp = service.createDispatch(portName,
    SOAPMessage.class, MESSAGE);
Response<SOAPMessage> res = disp.invokeAsync(soapReqMsg);
while (!res.isDone()) {
    // do something while we wait
}
SOAPMessage soapResMsg = res.get();

  1
2
3
4
5
6
7
8
9
10
11
12
13
14

  class MyHandler implements AsyncHandler<Source> {
    ...
    public void handleResponse(Response<Source> res) {
        Source resMsg = res.get();
        // do something with the results
    }
}

Source reqMsg = ...;
Service service = ...;
Dispatch<Source> disp = service.createDispatch(portName,
    Source.class, PAYLOAD);
MyHandler handler = new MyHandler();
disp.invokeAsync(reqMsg, handler);

  1
2
3
4
5
6
7
8
9
10

  @WebServiceProvider
@ServiceMode(value=Service.Mode.MESSAGE)
public class MyService implements Provider<SOAPMessage> {
    public MyService() {
    }

    public SOAPMessage invoke(SOAPMessage request) {
        return request;
    }
}

  1
2
3
4
5
6
7
8
9
10
11
12
13
14

  @WebServiceProvider
@ServiceMode(value=Service.Mode.PAYLOAD)
public class MyService implements Provider<Source> {
    public MyService() {
    }

    public Source invoke(Source request) {
        Source requestPayload = request.getPayload();
        ...
        String replyElement = "<n:ack xmlns:n=’...’/>";
        StreamSource reply = new StreamSource(new StringReader(replyElement));
        return reply;
    }
}

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

  @WebServiceProvider
@ServiceMode(value=Service.Mode.PAYLOAD)
public class MyService implements Provider<Source> {
    public MyService() {
    }

    public Source invoke(Source request) {
        JAXBContent jc = JAXBContext.newInstance(...);
        Unmarshaller u = jc.createUnmarshaller();
        Object requestObj = u.unmarshall(request);
        ...
        Acknowledgement reply = new Acknowledgement(...);
        return new JAXBSource(jc, reply);
    }
}

  1
2
3

  // assume Test is an endpoint implementation class annotated with @WebService
Test test = new Test();
Endpoint e = Endpoint.publish("http://localhost:8080/test", test);

  1
2
3
4
5
6
7
8

  // assume Test is an endpoint implementation class annotated with @WebService
Test test = new Test();
HttpServer server = HttpServer.create(new InetSocketAddress(8080),10);
server.setExecutor(Executor.newFixedThreadPool(10));
server.start();
HttpContext context = server.createContext("/test");
Endpoint endpoint = Endpoint.create(SOAPBinding.SOAP11HTTP_BINDING, test);
endpoint.publish(context);

  1
2
3
4
5
6
7

  @WebService
public class Test {
    @Resource
    private WebServiceContext context;

    public String reverse(String inputString) { ... }
}

  1
2
3
4
5
6

  try {
    response = dispatch.invoke(request);
} catch (SOAPFaultException e) {
    QName soapFaultCode = e.getFault().getFaultCodeAsQName();
    ...
}

  1
2
3
4
5
6
7
8
9

  public void endpointOperation() {
    ...
    if (someProblem) {
        SOAPFault fault = soapBinding.getSOAPFactory().createFault(
            faultcode, faultstring, faultactor, detail);
        throw new SOAPFaultException(fault);
    }
    ...
}

  Container                               Jakarta XML Web Services runtime
  ---------                               --------------
  1. Creates Invoker1, ... InvokerN
  2. Provider.createEndpoint(...)     --> 3. creates Endpoint1
     configures Endpoint1
     ...
  4. Provider.createEndpoint(...)     --> 5. creates EndpointN
     configures EndpointN
  6. Creates EndpointContext with
     Endpoint1, ..., EndpointN
     and sets it on all endpoints.
  7. creates HttpContext1, ... HttpContextN
  8. Endpoint1.publish(HttpContext1)  --> 9. creates HttpHandler1
                                          HttpContext1.setHandler(HttpHandler1)
     ...
 10. EndpointN.publish(HttpContextN)  --> 11. creates HttpHandlerN
                                          HttpContextN.setHandler(HttpHandlerN)
  Container                               Jakarta XML Web Services runtime
  ---------                               --------------
  1. Creates a HttpExchange
  2. Gets handler from HttpContext
  3. HttpHandler.handle(HttpExchange) --> 4. reads request from HttpExchange
                                      <-- 5. Calls Invoker
  6. Invokes the actual instance
                                          7. Writes the response to HttpExchange
  Container                               Jakarta XML Web Services runtime
  ---------                               --------------
  1. @preDestroy on instances
  2. Endpoint1.stop()
  ...
  3. EndpointN.stop()
import jakarta.jws.WebService;
import jakarta.jws.WebMethod;

@WebService
public class HelloWorldService {
   @WebMethod
   public String helloWorld() {
     return "Hello World!";
   }
}
@Retention(value=RetentionPolicy.RUNTIME)
@Target({TYPE})
public @interface WebService {
  String name() default "";
  String targetNamespace() default "";
  String serviceName() default "";
  String portName() default "";
  String wsdlLocation() default "";
  String endpointInterface() default "";
};
/**
* Annotated Implementation Object
*/
@WebService(
  name = "EchoService",
  targetNamespace = "http://www.openuri.org/2004/04/HelloWorld"
)
public class EchoServiceImpl {
   @WebMethod
   public String echo(String input) {
      return input;
   }
}
@Retention(value=RetentionPolicy.RUNTIME)
@Target({METHOD})
public @interface WebMethod {
  String operationName() default "";
  String action() default "" ;
  boolean exclude() default false;
};
@WebService
public class MyWebService {
   @WebMethod(operationName = "echoString", action="urn:EchoString")
   public String echo(String input) {
      return input;
   }
}
<definitions>
   <portType name="MyWebService">
      <operation name="echoString"/>
         <input message="echoString"/>
         <output message="echoStringResponse"/>
      </operation>
   </portType>

   <binding name="PingServiceHttpSoap" type="MyWebService">
      <operation name="echoString">
         <soap:operation soapAction="urn:EchoString"/>
      </operation>
   </binding>
</definitions>
@Retention(value=RetentionPolicy.RUNTIME)
@Target({METHOD})
public @interface Oneway {
};
@WebService
public class PingService {

   @WebMethod
   @Oneway
   public void ping() {
   }
};
<definitions>
   <message name="ping"/>

   <portType name="PingService">
      <operation name="ping">
         <input message="ping"/>
      </operation>
   </portType>
</definitions>
@Retention(value=RetentionPolicy.RUNTIME)
@Target({PARAMETER})
public @interface WebParam {

   enum Mode {
      IN,
      OUT,
      INOUT
   };

   String name() default "";
   String partName() default "";
   String targetNamespace() default "";
   Mode mode() default Mode.IN;
   boolean header() default false;
};
@WebService(targetNamespace="http://www.openuri.org/jwsm/WebParamExample")
@SOAPBinding(style=SOAPBinding.Style.RPC)
public class PingService {

   @WebMethod(operationName = "PingOneWay")
   @Oneway
   public void ping(PingDocument ping) {
   }

   @WebMethod(operationName = "PingTwoWay")
   public void ping(
     @WebParam(mode=WebParam.Mode.INOUT)
        PingDocumentHolder ping) {
   }

   @WebMethod(operationName = "SecurePing")
   @Oneway
   public void ping(
      PingDocument ping,
      @WebParam(header=true)
         SecurityHeader secHeader) {
   }
};
<definitions
  xmlns="http://schemas.xmlsoap.org/wsdl/"
  xmlns:tns="http://www.openuri.org/jwsm/WebParamExample"
  xmlns:wsdl="http://www.openuri.org/jwsm/WebParamExample"
  xmlns:s="http://www.w3.org/2001/XMLSchema"
  xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
  targetNamespace="http://www.openuri.org/jwsm/WebParamExample">

  <types>
     <s:schema elementFormDefault="qualified"
targetNamespace="http://www.openuri.org/jwsm/WebParamExample">
        <s:complexType name="PingDocument">
           . . .
        </s:complexType>
        <s:complexType name="SecurityHeader">
           . . .
        </s:complexType>
        <s:element name="SecurityHeader" type="SecurityHeader"/>
     </s:schema>
  </types>

  <message name="PingOneWay">
     <part name="arg0" type="tns:PingDocument"/>
  </message>

  <message name="PingTwoWay">
     <part name="arg0" type="tns:PingDocument"/>
  </message>

  <message name="PingTwoWayResponse">
     <part name="arg0" type="tns:PingDocument"/>
  </message>

  <message name="SecurePing">
     <part name="arg0" type="tns:PingDocument"/>
     <part name="arg1" element="tns:SecurityHeader"/>
  </message>

  <portType name="PingService">
     <operation name="PingOneWay">
        <input message="tns:PingOneWay"/>
     </operation>

     <operation name="PingTwoWay">
        <input message="tns:PingTwoWay"/>
        <output message="tns:PingTwoWayResponse"/>
     </operation>

     <operation name="SecurePing">
        <input message="tns:SecurePing"/>
     </operation>
  </portType>

  <binding name="PingServiceHttpSoap" type="tns:PingService">
     <soap:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http" />
     <operation name="PingOneWay">
        <soap:operation soapAction="http://openuri.org/PingOneWay"/>
        <input>
           <soap:body parts="arg0" use="literal"/>
        </input>
     </operation>

     <operation name="PingTwoWay">
        <soap:operation soapAction="http://openuri.org/PingTwoWay"/>
        <input>
           <soap:body parts="arg0" use="literal"/>
        </input>
        <output>
           <soap:body parts="arg0" use="literal"/>
        </output>
     </operation>

     <operation name="SecurePing">
        <soap:operation soapAction="http://openuri.org/SecurePing"/>
        <input>
           <soap:body parts="arg0" use="literal"/>
           <soap:header message="SecurePing" part="arg1" use="literal"/>
        </input>
     </operation>
  </binding>
</definitions>
@Retention(value=RetentionPolicy.RUNTIME)
@Target({METHOD})
public @interface WebResult {
  String name() default "";
  String partName() default "";
  String targetNamespace() default "";
  boolean header() default false;
};
@WebService
public class CustomerService {

   @WebMethod
   @WebResult(name="CustomerRecord")
   public CustomerRecord locateCustomer(
      @WebParam(name="FirstName") String firstName,
      @WebParam(name="LastName") String lastName,
      @WebParam(name="Address") USAddress addr) {
   }
};
<definitions>
   <types>
      <complexType name="CustomerRecord">
         ...
      </complexType>

      <complexType name="USAddress">
         ...
      </complexType>

      <element name="locateCustomer">
        <complexType>
          <sequence>
            <element name="FirstName" type="xs:string"/>
            <element name="LastName" type="xs:string"/>
            <element name="Address" type="USAddress"/>
          </sequence>
        </complexType>
     </element>

     <element name="locateCustomerResponse">
       <complexType>
         <sequence>
            <element name="CustomerRecord" type="CustomerRecord"/>
         </sequence>
       </complexType>
     </element>
    </types>

    <message name="locateCustomer">
       <part name="parameters" element="tns:locateCustomer"/>
    </message>

    <message name="locateCustomerResponse">
       <part name="parameters" element="tns:locateCustomerResponse"/>
    </message>

    <portType name="CustomerService">
       <operation name="locateCustomer">
          <input message="tns:locateCustomer"/>
          <output message="tns:locateCustomerResponse"/>
       </operation>
    </portType>
</definitions>
@Retention(value=RetentionPolicy.RUNTIME)
@Target({TYPE, METHOD, FIELD})
public @interface HandlerChain {
  String file();
  String name() default "";
};
package com.jwsm.examples;

@WebService
@HandlerChain(file="config/ProjectHandlers.xml")
public class MyWebService {
};
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bindings
  wsdlLocation="http://localhost:8080/fromwsdl_handler/test?wsdl"
  xmlns="https://jakarta.ee/xml/ns/jaxws">

  <bindings node="ns1:definitions" xmlns:ns1="http://schemas.xmlsoap.org/wsdl/">
    <package name="fromwsdl.handler.client"/>
  </bindings>

  <bindings node="ns1:definitions/ns1:types/xs:schema[@targetNamespace='urn:test:types']"
      xmlns:xs="http://www.w3.org/2001/XMLSchema"
      xmlns:ns1="http://schemas.xmlsoap.org/wsdl/">
    <ns2:schemaBindings xmlns:ns2="https://jakarta.ee/xml/ns/jaxb">
       <ns2:package name="fromwsdl.handler.client"/>
    </ns2:schemaBindings>
  </bindings>

  <bindings>
    <handler-chains xmlns="https://jakarta.ee/xml/ns/jakartaee">
      <handler-chain>
        <handler>
          <handler-class>fromwsdl.handler.common.BaseLogicalHandler</handler-class>
          <init-param>
            <param-name>handlerName</param-name>
            <param-value>client0</param-value>
          </init-param>
        </handler>
      </handler-chain>
      <handler-chain>
        <port-name-pattern xmlns:ns2="urn:test">ns2:Report</port-name-pattern>
        <handler>
          <handler-class>fromwsdl.handler.common.BaseLogicalHandler</handler-class>
          <init-param>
            <param-name>handlerName</param-name>
            <param-value>client2</param-value>
          </init-param>
        </handler>
      </handler-chain>
      <handler-chain>
        <port-name-pattern xmlns:ns2="urn:test">ns2:ReportServicePort</port-name-pattern>
        <handler>
          <handler-class>fromwsdl.handler.common.BaseSOAPHandler</handler-class>
          <init-param>
            <param-name>handlerName</param-name>
            <param-value>client6</param-value>
          </init-param>
        </handler>
      </handler-chain>
      <handler-chain>
        <protocol-bindings>##SOAP11_HTTP</protocol-bindings>
        <handler>
          <handler-class>fromwsdl.handler.common.BaseSOAPHandler</handler-class>
          <init-param>
            <param-name>handlerName</param-name>
            <param-value>client7</param-value>
          </init-param>
          <soap-role>http://sun.com/client/role1</soap-role>
          <soap-role>http://sun.com/client/role2</soap-role>
        </handler>
      </handler-chain>
      <handler-chain>
        <protocol-bindings>##SOAP11_HTTP</protocol-bindings>
        <handler>
          <handler-class>fromwsdl.handler.common.BaseLogicalHandler</handler-class>
          <init-param>
            <param-name>handlerName</param-name>
            <param-value>client3</param-value>
          </init-param>
        </handler>
      </handler-chain>
    </handler-chains>
  </bindings>
</bindings
@Retention(value=RetentionPolicy.RUNTIME)
@Target({TYPE, METHOD})
public @interface SOAPBinding {
   enum Style {
      DOCUMENT,
      RPC
   };

   enum Use {
      LITERAL,
      ENCODED
   };

   enum ParameterStyle {
       BARE,
       WRAPPED
   }

   Style style() default Style.DOCUMENT;
   Use use() default Use.LITERAL;
   ParameterStyle parameterStyle() default ParameterStyle.WRAPPED;
}
@WebService(targetNamespace="http://www.openuri.org/jwsm/SoapBindingExample1")
@SOAPBinding(
    style = SOAPBinding.Style.RPC,
    use = SOAPBinding.Use.LITERAL)
public class ExampleService {
   @WebMethod
   public String concat(String first, String second, String third) {
      return first + second + third;
   }
}
<definitions
  xmlns="http://schemas.xmlsoap.org/wsdl/"
  xmlns:tns="http://www.openuri.org/jwsm/SoapBindingExample1"
  xmlns:s="http://www.w3.org/2001/XMLSchema"
  xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
  targetNamespace="http://www.openuri.org/jwsm/SoapBindingExample1">

  <message name="concat">
     <part name="first" type="xs:string"/>
     <part name="second" type="xs:string"/>
     <part name="third" type="xs:string"/>
  </message>

  <message name="concatResponse">
     <part name="return" type="xs:string"/>
  </message>

  <portType name="ExampleService">
     <operation name="concat">
       <input message="tns:concat"/>
       <output message="tns:concatResponse"/>
     </operation>
  </portType>

  <binding name="ExampleServiceHttpSoap" type="ExampleService">
    <soap:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http"/>
    <operation name="concat">
      <soap:operation soapAction="http://www.openuri.org/jwsm/SoapBindingExample1/concat"/>
      <input>
        <soap:body parts="first second third" use="literal"/>
      </input>
      <output>
        <soap:body parts="return" use="literal"/>
      </output>
    </operation>
   </binding>
</definitions>
@WebService(targetNamespace="http://www.openuri.org/jwsm/SoapBindingExample2")
@SOAPBinding(parameterStyle=SOAPBinding.ParameterStyle.BARE)
public class DocBareService {

   @WebMethod( operationName="SubmitPO" )
   public SubmitPOResponse submitPO(SubmitPORequest submitPORequest) {
   }
}
<definitions
  xmlns="http://schemas.xmlsoap.org/wsdl/"
  xmlns:tns="http://www.openuri.org/jwsm/SoapBindingExample2"
  xmlns:s="http://www.w3.org/2001/XMLSchema"
  xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
  targetNamespace="http://www.openuri.org/jwsm/SoapBindingExample2">

  <types>
     <s:schema elementFormDefault="qualified" targetNamespace="http://www.openuri.org/jwsm/SoapBindingExample2">
        <s:element name="SubmitPORequest">
            . . .
        </s:element>
        <s:element name="SubmitPOResponse">
            . . .
        </s:element>
     </s:schema>
  </types>

  <message name="SubmitPO">
     <part name="parameters" element="tns:SubmitPORequest"/>
  </message>

  <message name="SubmitPOResponse">
     <part name="parameters" element="tns:SubmitPOResponse"/>
  </message>

  <portType name="DocBareService">
     <operation name="SubmitPO">
        <input message="tns:SubmitPO"/>
        <output message="tns:SubmitPOResponse"/>
     </operation>
  </portType>

  <binding name="DocBareServiceHttpSoap" type="ExampleService">
     <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
     <operation name="SubmitPO">
        <soap:operation soapAction="http://www.openuri.org/jwsm/SoapBindingExample2/SubmitPO />
        <input>
           <soap:body parts="parameters" use="literal"/>
        </input>
        <output>
           <soap:body parts="parameters" use="literal"/>
        </output>
     </operation>
  </binding>
</definitions>
@WebService(targetNamespace="http://www.openuri.org/jwsm/SoapBindingExample3")
@SOAPBinding(
  style = SOAPBinding.Style.DOCUMENT,
  use = SOAPBinding.Use.LITERAL,
  parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
public class DocWrappedService {

   @WebMethod(operationName = "SubmitPO")
   @WebResult(name="PurchaseOrderAck")
   public PurchaseOrderAck submitPO(
       @WebParam(name="PurchaseOrder") PurchaseOrder purchaseOrder) {
   }
}
<definitions
  xmlns="http://schemas.xmlsoap.org/wsdl/"
  xmlns:tns="http://www.openuri.org/jwsm/SoapBindingExample3"
  xmlns:s="http://www.w3.org/2001/XMLSchema"
  xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
  targetNamespace="http://www.openuri.org/jwsm/SoapBindingExample3">

  <types>
    <s:schema elementFormDefault="qualified" targetNamespace="http://www.openuri.org/jwsm/SoapBindingExample3">
       <s:element name="SubmitPO">
         <complexType>
           <sequence>
             <element name="PurchaseOrder" type="tns:PurchaseOrder"/>
                . . .
       </s:element>

       <s:element name="SubmitPOResponse">
           . . .
       </s:element>

    </s:schema>
  </types>

  <message name="SubmitPO">
     <part name="parameters" element="tns:SubmitPO"/>
  </message>

  <message name="SubmitPOResponse">
     <part name="parameters" type="tns:SubmitPOResponse"/>
  </message>

  <portType name="DocWrappedService">
     <operation name="SubmitPO">
        <input message="tns:SubmitPO"/>
        <output message="tns:SubmitPOResponse"/>
     </operation
  </portType>

  <binding name="ExampleServiceHttpSoap" type="ExampleService">
    <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
    <operation name="SubmitPO">
      <soap:operation soapAction="http://www.openuri.org/jwsm/SoapBindingExample3/SubmitPO" />
      <input>
        <soap:body parts="parameters" use="literal"/>
      </input>
      <output>
        <soap:body parts="parameters" use="literal"/>
      </output>
    </operation>
  </binding>
</definitions>
import jakarta.jws.*;
import jakarta.jws.soap.*;

@WebService(
  name="ExampleWebService",
  targetNamespace="http://openuri.org/11/2003/ExampleWebService")
@SOAPBinding(style=SOAPBinding.Style.RPC, use=SOAPBinding.Use.LITERAL)
public class ExampleWebServiceImpl {

   @WebMethod(action="urn:login")
   @WebResult(name="Token")
   public LoginToken login(
      @WebParam(name="UserName") String username,
      @WebParam(name="Password") String password) {
     // ...
   }

   @WebMethod (action="urn:createCustomer")
   @WebResult(name="CustomerId")
   public String createCustomer(
      @WebParam(name="Customer") Customer customer,
      @WebParam(name="Token", header=true) LoginToken token) {
      // ...
   }

   @WebMethod(action="urn:notifyTransfer")
   @Oneway
   public void notifyTransfer(
      @WebParam(name="CustomerId") String customerId,
      @WebParam(name="TransferData") TransferDocument transferData,
      @WebParam(name="Token", header=true) LoginToken token) {
   }
};
<definitions
  name="ExampleWebServiceImplServiceDefinitions"
  targetNamespace="http://openuri.org/11/2003/ExampleWebService"
  xmlns="http://schemas.xmlsoap.org/wsdl/"
  xmlns:tns="http://openuri.org/11/2003/ExampleWebService"
  xmlns:xs="http://www.w3.org/2001/XMLSchema"
  xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/">

  <types>
    <xs:schema elementFormDefault="qualified"
       targetNamespace="http://openuri.org/11/2003/ExampleWebService">

      <xs:complexType name="LoginToken">
         ...
      </xs:complexType>

      <xs:complexType name="Customer">
         ...
      </xs:complexType>

      <xs:complexType name="TransferDocument">
         ...
      </xs:complexType>

      <xs:element name="Token" type="LoginToken"/>

    </xs:schema>
  </types>

  <message name="createCustomer">
    <part name="Customer" type="tns:Customer"/>
    <part element="tns:Token" name="token"/>
  </message>

  <message name="createCustomerResponse">
    <part name="CustomerId" type="xs:string"/>
  </message>

  <message name="notifyTransfer">
    <part name="CustomerId" type="xs:string"/>
    <part name="TransferData" type="tns:TransferDocument"/>
    <part name="token" element="tns:Token"/>
  </message>

  <message name="login">
    <part name="UserName" type="xs:string"/>
    <part name="Password" type="xs:string"/>
  </message>

  <message name="loginResponse">
    <part name="Token" type="tns:LoginToken"/>
  </message>

  <portType name="ExampleWebService">
    <operation name="createCustomer" parameterOrder="Customer token">
      <input message="tns:createCustomer"/>
      <output message="tns:createCustomerResponse"/>
    </operation>

    <operation name="notifyTransfer" parameterOrder="CustomerId TransferData token">
      <input message="tns:notifyTransfer"/>
    </operation>

    <operation name="login" parameterOrder="UserName Password">
      <input message="tns:login"/>
      <output message="tns:loginResponse"/>
    </operation>

  </portType>

  <binding name="ExampleWebServiceImplServiceSoapBinding"
      type="tns:ExampleWebService">
    <soap:binding style="rpc"
      transport="http://schemas.xmlsoap.org/soap/http"/>

    <operation name="createCustomer">
      <soap:operation soapAction="urn:createCustomer" style="rpc"/>
      <input>
        <soap:body
          namespace="http://openuri.org/11/2003/ExampleWebService"
          parts="Customer"
          use="literal"/>
        <soap:header
          message="tns:createCustomer"
          part="token"
          use="literal"/>
      </input>
      <output>
        <soap:body
          namespace="http://openuri.org/11/2003/ExampleWebService"
          parts="CustomerId"
          use="literal"/>
      </output>
    </operation>

    <operation name="notifyTransfer">
      <soap:operation soapAction="urn:notifyTransfer" style="rpc"/>
      <input>
        <soap:body
           namespace="http://openuri.org/11/2003/ExampleWebService"
           parts="CustomerId TransferData"
           use="literal"/>
        <soap:header
           message="tns:notifyTransfer"
           part="token"
           use="literal"/>
      </input>
    </operation>

    <operation name="login">
      <soap:operation soapAction="urn:login" style="rpc"/>
      <input>
        <soap:body
           namespace="http://openuri.org/11/2003/ExampleWebService"
           parts="UserName Password"
           use="literal"/>
      </input>
      <output>
        <soap:body
           namespace="http://openuri.org/11/2003/ExampleWebService"
           parts="Token"
           use="literal"/>
      </output>
    </operation>
  </binding>

  <service name="ExampleWebServiceImplService">
    <port
      binding="s1:ExampleWebServiceImplServiceSoapBinding"
      name="ExampleWebServiceSoapPort">
      <soap:address
        location="http://localhost:7001/ExampleWebServiceImpl/ExampleWebServiceImpl"/>
    </port>
  </service>
</definitions>
import jakarta.jws.*;
import jakarta.jws.soap.*;

@WebService(
  name="ExampleWebService",
  targetNamespace="http://openuri.org/11/2003/ExampleWebService")
@SOAPBinding(style=SOAPBinding.Style.DOCUMENT,
  use=SOAPBinding.Use.LITERAL)
public class ExampleWebServiceImpl {

   @WebMethod(action="urn:login")
   @WebResult(name="Token")
   public LoginToken login(
      @WebParam(name="UserName") String username,
      @WebParam(name="Password") String password) {
     // ...
   }

   @WebMethod (action="urn:createCustomer")
   @WebResult(name="CustomerId")
   public String createCustomer(
      @WebParam(name="Customer") Customer customer,
      @WebParam(name="Token", header=true) LoginToken token) {
      // ...
   }

   @WebMethod(action="urn:notifyTransfer")
   @Oneway
   public void notifyTransfer(
      @WebParam(name="CustomerId") String customerId,
      @WebParam(name="TransferData") TransferDocument transferData,
      @WebParam(name="Token", header=true) LoginToken token) {
   }

};
<?xml version='1.0' encoding='UTF-8'?>
<definitions
  name="ExampleWebServiceImplServiceDefinitions"
  targetNamespace="http://openuri.org/11/2003/ExampleWebService"
  xmlns="http://schemas.xmlsoap.org/wsdl/"
  xmlns:tns="http://openuri.org/11/2003/ExampleWebService"
  xmlns:xs="http://www.w3.org/2001/XMLSchema"
  xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/">

  <types>
    <xs:schema attributeFormDefault="unqualified"
        targetNamespace="http://openuri.org/11/2003/ExampleWebService">

      <xs:complexType name="LoginToken">
          ...
      </xs:complexType>

      <xs:complexType name="Customer">
          ...
      </xs:complexType>

      <xs:complexType name="TransferDocument">
          ...
      </xs:complexType>

      <xs:element name="Token" type="tns:LoginToken"/>

      <xs:element name="createCustomer">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="Customer" type="tns:Customer"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

      <xs:element name="createCustomerResponse">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="CustomerId" type="xs:string"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

      <xs:element name="notifyTransfer">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="CustomerId" type="xs:string"/>
            <xs:element name="TransferData" type="tns:TransferDocument"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

      <xs:element name="login">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="UserName" type="xs:string"/>
            <xs:element name="Password" type="xs:string"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

      <xs:element name="loginResponse">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="Token" type="tns:LoginToken"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:schema>
  </types>

  <message name="createCustomer">
    <part element="tns:createCustomer" name="parameters"/>
    <part element="tns:Token" name="token"/>
  </message>

  <message name="createCustomerResponse">
    <part element="tns:createCustomerResponse" name="parameters"/>
  </message>

  <message name="notifyTransfer">
    <part element="tns:notifyTransfer" name="parameters"/>
    <part element="tns:Token" name="token"/>
   </message>

  <message name="login">
    <part element="tns:login" name="parameters"/>
  </message>

  <message name="loginResponse">
    <part element="tns:loginResponse" name="parameters"/>
  </message>

  <portType name="ExampleWebService">
    <operation name="createCustomer" parameterOrder="parameters token">
      <input message="tns:createCustomer"/>
      <output message="tns:createCustomerResponse"/>
    </operation>

    <operation name="notifyTransfer" parameterOrder="token">
      <input message="tns:notifyTransfer"/>
    </operation>

    <operation name="login" parameterOrder="parameters">
      <input message="tns:login"/>
      <output message="tns:loginResponse"/>
    </operation>
  </portType>

  <binding name="ExampleWebServiceImplServiceSoapBinding" type="tns:ExampleWebService">
    <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
    <operation name="createCustomer">
      <soap:operation soapAction="urn:createCustomer" style="document"/>
      <input>
        <soap:body parts="parameters" use="literal"/>
        <soap:header message="tns:createCustomer" part="token" use="literal"/>
      </input>
      <output>
        <soap:body parts="parameters" use="literal"/>
      </output>
    </operation>

    <operation name="notifyTransfer">
      <soap:operation soapAction="urn:notifyTransfer" style="document"/>
      <input>
        <soap:body parts="parameters" use="literal"/>
        <soap:header message="tns:notifyTransfer" part="token" use="literal"/>
      </input>
    </operation>

    <operation name="login">
      <soap:operation soapAction="urn:login" style="document"/>
      <input>
        <soap:body parts="parameters" use="literal"/>
      </input>
      <output>
        <soap:body parts="parameters" use="literal"/>
      </output>
    </operation>
  </binding>

  <service name="ExampleWebServiceImplService">
    <port binding="tns:ExampleWebServiceImplServiceSoapBinding" name="ExampleWebServiceSoapPort">
      <soap:address
           location="http://localhost:7001/ExampleWebServiceImpl/ExampleWebServiceImpl"/>
    </port>
</service>
</definitions>

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

  <!-- WSDL extract -->
<wsdl:service name="StockQuoteService">
  <wsdl:port name="StockQuoteHTTPPort" binding="StockQuoteHTTPBinding"/>
  <wsdl:port name="StockQuoteSMTPPort" binding="StockQuoteSMTPBinding"/>
</wsdl:service>

// Generated Service Class
@WebServiceClient(name="StockQuoteService",
                  targetNamespace="...",
                  wsdlLocation="...")
public class StockQuoteService extends jakarta.xml.ws.Service {
    public StockQuoteService() {
        super(wsdlLocation_fromAnnotation, serviceName_fromAnnotation);
    }

    public StockQuoteService(String wsdlLocation, QName serviceName) {
        super(wsdlLocation, serviceName);
    }

    // Other StockQuoteService constructors
    ...

    @WebEndpoint(name="StockQuoteHTTPPort")
    public StockQuoteProvider getStockQuoteHTTPPort() {
        return super.gePort(portName, StockQuoteProvider.class);
    }

    @WebEndpoint(name="StockQuoteHTTPPort")
    public StockQuoteProvider getStockQuoteHTTPPort(WebServiceFeature... f) {
        return super.gePort(portName, StockQuoteProvider.class, f);
    }

    @WebEndpoint(name="StockQuoteSMTPPort")
    public StockQuoteProvider getStockQuoteSMTPPort() {
        return super.getPort(portName, StockQuoteProvider.class);
    }

    @WebEndpoint(name="StockQuoteSMTPPort")
    public StockQuoteProvider getStockQuoteSMTPPort(WebServiceFeature... f) {
        return super.getPort(portName, StockQuoteProvider.class, f);
    }
}

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

  // Generated Service Class

@WebServiceClient(name="StockQuoteService",
                  targetNamespace="...",
                  wsdlLocation="...")
public class StockQuoteService extends jakarta.xml.ws.Service {
    ...

    @WebEndpoint(name="StockQuoteHTTPPort")
    StockQuoteProvider getStockQuoteHTTPPort() { ... };

    @WebEndpoint(name="StockQuoteHTTPPort")
    StockQuoteProvider getStockQuoteHTTPPort(WebServiceFeature ... f) { ... };

    @WebEndpoint(name="StockQuoteSMTPPort")
    StockQuoteProvider getStockQuoteSMTPPort() { ... };

    @WebEndpoint(name="StockQuoteSMTPPort")
    StockQuoteProvider getStockQuoteSMTPPort(WebServiceFeature ... f) { ... };
}

// Generated SEI

@WebService(name="StockQuoteProvider",
            targetNamespace="...")
public interface StockQuoteProvider {
    Double getStockQuote(String ticker);
}

// Sample client code

@Stateless
public class ClientComponent {

    // WebServiceRef using the generated service interface type
    @WebServiceRef
    public StockQuoteService stockQuoteService;

    // WebServiceRef using the SEI type
    // stockQuoteProvider proxy is configured with MTOM feature
    @MTOM
    @WebServiceRef(StockQuoteService.class)
    private StockQuoteProvider stockQuoteProvider;

    // other methods go here...
}

  1
2
3
4
5
6
7
8
9
10

  @WebServiceRefs({@WebServiceRef(name="accounting"
                                type=AccountingPortType.class,
                                value=AccountingService.class),
                 @WebServiceRef(name="payroll",
                                type=PayrollService.class)})
@Stateless
public MyComponent {

    // methods using the declared resources go here...
}

  1
2
3
4
5
6
7
8
9

  @Target({TYPE})
public @interface WebService {
    String name() default "";
    String targetNamespace() default "";
    String serviceName() default "";
    String wsdlLocation() default "";
    String endpointInterface() default "";
    String portName() default "";
};

  1
2
3
4
5
6

  @Target({METHOD})
public @interface WebMethod {
    String operationName() default "";
    String action() default "" ;
    boolean exclude() default false;
};

  1
2
3

  @Target({METHOD})
public @interface Oneway {
};

  1
2
3
4
5
6
7
8
9
10

  @Target({PARAMETER})
public @interface WebParam {
    enum Mode { IN, OUT, INOUT };

    String name() default "";
    String targetNamespace() default "";
    Mode mode() default Mode.IN;
    boolean header() default false;
    String partName() default "";
};

  1
2
3
4
5
6
7

  @Target({METHOD})
public @interface WebResult {
    String name() default "return";
    String targetNamespace() default "";
    boolean header() default false;
    String partName() default "";
};

  1
2
3
4
5
6
7
8
9
10
11
12

  @Target({TYPE, METHOD})
public @interface SOAPBinding {
    enum Style { DOCUMENT, RPC }

    enum Use { LITERAL, ENCODED }

    enum ParameterStyle { BARE, WRAPPED }

    Style style() default Style.DOCUMENT;
    Use use() default Use.LITERAL;
    ParameterStyle parameterStyle() default ParameterStyle.WRAPPED;
}

  1
2
3
4
5

  @Target({TYPE})
public @interface HandlerChain {
    String file();
    String name() default "";
}

  1
2
3
4
5
6
7
8
9
10
11
12
13
14

  @WebServiceFeatureAnnotation(id=AddressingFeature.ID,
                             bean=AddressingFeature.class)
public @interface Addressing {
    /**
     * Specifies if this feature is enabled or disabled.
     */
    boolean enabled() default true;

    /**
     * Property to determine whether WS-Addressing
     * headers MUST be present on incoming messages.
     */
    boolean required() default false;
}

  1
2
3
4
5

  <jaxws:bindings wsdlLocation="xs:anyURI"?
                node="xs:string"?
                version="string"?>
  ...binding declarations...
</jaxws:bindings>

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

  <wsdl:definitions targetNamespace="..." xmlns:tns=..." xmlns:stns="...">
  <wsdl:types>
    <xs:schema targetNamespace="http://example.org/bar">
      <xs:annotation>
        <xs:appinfo>
          <jaxb:bindings>
            ...some Jakarta XML Binding binding declarations...
          </jaxb:bindings>
        </xs:appinfo>
      </xs:annotation>
      <xs:element name="setLastTradePrice">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="tickerSymbol" type="xs:string"/>
            <xs:element name="lastTradePrice" type="xs:float"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="setLastTradePriceResponse">
        <xs:complexType>
          <xs:sequence/>
        </xs:complexType>
      </xs:element>
    </xs:schema>
  </wsdl:types>

  <wsdl:message name="setLastTradePrice">
    <wsdl:part name="setPrice" element="stns:setLastTradePrice"/>
  </wsdl:message>

  <wsdl:message name="setLastTradePriceResponse">
    <wsdl:part name="setPriceResponse" type="stns:setLastTradePriceResponse"/>
  </wsdl:message>

  <wsdl:portType name="StockQuoteUpdater">
    <wsdl:operation name="setLastTradePrice">
      <wsdl:input message="tns:setLastTradePrice"/>
      <wsdl:output message="tns:setLastTradePriceResponse"/>
      <jaxws:bindings>
        <jaxws:method name="updatePrice"/>
      </jaxws:bindings>
    </wsdl:operation>
    <jaxws:bindings>
      <jaxws:enableAsyncMapping>true</jaxws:enableAsyncMapping>
    </jaxws:bindings>
  </wsdl:portType>

  <jaxws:bindings>
    <jaxws:package name="com.acme.foo"/>
      ...additional binding declarations...
  </jaxws:bindings>
</wsdl:definitions>

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

  <jaxws:bindings wsdlLocation="http://example.org/foo.wsdl">
  <jaxws:package name="com.acme.foo"/>
  <jaxws:bindings
      node="wsdl:types/xs:schema[targetNamespace=’http://example.org/bar’]">
    <jaxb:bindings>
        ...some Jakarta XML Binding binding declarations...
    </jaxb:bindings>
  </jaxws:bindings>
  <jaxws:bindings node="wsdl:portType[@name=’StockQuoteUpdater’]">
    <jaxws:enableAsyncMapping>true</jaxws:enableAsyncMapping>
    <jaxws:bindings node="wsdl:operation[@name=’setLastTradePrice’]">
      <jaxws:method name="updatePrice"/>
    </jaxws:bindings>
  </jaxws:bindings>
  ...additional binding declarations....
</jaxws:bindings>

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

  <wsdl:definitions targetNamespace="..." xmlns:tns="..." xmlns:stns="...">
  <wsdl:types>
    <xs:schema targetNamespace="http://example.org/bar">
      <xs:element name="setLastTradePrice">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="tickerSymbol" type="xs:string"/>
            <xs:element name="lastTradePrice" type="xs:float"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="setLastTradePriceResponse">
        <xs:complexType>
          <xs:sequence/>
        </xs:complexType>
      </xs:element>
    </xs:schema>
  </wsdl:types>

  <wsdl:message name="setLastTradePrice">
    <wsdl:part name="setPrice" element="stns:setLastTradePrice"/>
  </wsdl:message>

  <wsdl:message name="setLastTradePriceResponse">
    <wsdl:part name="setPriceResponse"
        type="stns:setLastTradePriceResponse"/>
  </wsdl:message>

  <wsdl:portType name="StockQuoteUpdater">
    <wsdl:operation name="setLastTradePrice">
      <wsdl:input message="tns:setLastTradePrice"/>
      <wsdl:output message="tns:setLastTradePriceResponse"/>
    </wsdl:operation>
  </wsdl:portType>
</wsdl:definitions>

  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

  <jaxws:package name="xs:string">?
  <jaxws:javadoc>xs:string</jaxws:javadoc>?
</jaxws:package>

<jaxws:enableWrapperStyle>?
  xs:boolean
</jaxws:enableWrapperStyle>

<jaxws:enableAsyncMapping>?
  xs:boolean
</jaxws:enableAsyncMapping>

<jaxws:enableMIMEContent>?
  xs:boolean
</jaxws:enableMIMEContent>

  <jaxws:class name="xs:string">?
  <jaxws:javadoc>xs:string</jaxws:javadoc>?
</jaxws:class>

<jaxws:enableWrapperStyle>?
  xs:boolean
</jaxws:enableWrapperStyle>

<jaxws:enableAsyncMapping>xs:boolean</jaxws:enableAsyncMapping>?

  <jaxws:method name="xs:string">?
  <jaxws:javadoc>xs:string</jaxws:javadoc>?
</jaxws:method>

<jaxws:enableWrapperStyle>?
  xs:boolean
</jaxws:enableWrapperStyle>

<jaxws:enableAsyncMapping>?
  xs:boolean
</jaxws:enableAsyncMapping>

<jaxws:parameter part="xs:string"
                 childElementName="xs:QName"?
                 name="xs:string"/>*

  1
2
3

  <jaxws:class name="xs:string">?
  <jaxws:javadoc>xs:string</jaxws:javadoc>?
</jaxws:class>

  1
2
3

  <jaxws:enableMIMEContent>?
  xs:boolean
</jaxws:enableMIMEContent>

<jaxws:parameter part="xs:string"
                 childElementName="xs:QName"?
                 name="xs:string"/>*

<jaxws:exception part="xs:string">*
  <jaxws:class name="xs:string">?
    <jaxws:javadoc>xs:string</jaxws:javadoc>?
  </jaxws:class>
</jaxws:exception>

  1
2
3

  <jaxws:class name="xs:string">?
  <jaxws:javadoc>xs:string</jaxws:javadoc>?
</jaxws:class>

  <jaxws:method name="xs:string">?
  <jaxws:javadoc>xs:string</jaxws:javadoc>?
</jaxws:method>

<jaxws:provider/>?

  1
2
3
4
5

  @WebService
@HandlerChain(file="sample_chain.xml")
public class MyService {
    ...
}

@Target({TYPE, METHOD})
public @interface HttpGetBinding {
   String location() default "";
}
@WebService
@HttpGetBinding(location="MyWebServices")
public class MyWebServiceImpl {
   @WebMethod
   @HttpGetBinding(location="ExampleOperation")
   public void myOperation() {
   }
};

Prefix	Namespace	Notes
env	http://www.w3.org/2003/05/soap-envelope	A normative XML Schema[24][25] document for the http://www.w3.org/2003/05/soap-envelope namespace can be found at http://www.w3.org/2003/05/soap-envelope.
xsd	http://www.w3.org/2001/XMLSchema	The namespace of the XML schema[24][25] specification
wsdl	http://schemas.xmlsoap.org/wsdl/	The namespace of the WSDL schema[5]
soap	http://schemas.xmlsoap.org/wsdl/soap/	The namespace of the WSDL SOAP binding schema[24][25]
jaxb	https://jakarta.ee/xml/ns/jaxb	The namespace of the Jakarta XML Binding[9] specification
jaxws	https://jakarta.ee/xml/ns/jaxws	The namespace of the Jakarta XML Web Services specification
wsa	http://www.w3.org/2005/08/addressing	The namespace of the WS-Addressing 1.0[26] schema
wsam	http://www.w3.org/2007/05/addressing/metadata	The namespace of the WS-Addressing 1.0 - Metadata[27] schema
wsp	http://www.w3.org/ns/ws-policy	The namespace of the Web Services Policy 1.5 - Framework[28] schema

Name	Type	Mandatory	Description
`jakarta.xml.ws.service.endpoint`
.address	String	Y	The address of the service endpoint as a protocol specific URI. The URI scheme must match the protocol binding in use.
`jakarta.xml.ws.security.auth`
.username	String	Y	Username for HTTP basic authentication.
.password	String	Y	Password for HTTP basic authentication.
`jakarta.xml.ws.session`
.maintain	Boolean	Y	Used by a client to indicate whether it is prepared to participate in a service endpoint initiated session. The default value is `false`.
`jakarta.xml.ws.soap.http.soapaction`
.use	Boolean	N	Controls whether the `SOAPAction` HTTP header is used in SOAP/HTTP requests. Default value is `false`.
.uri	String	N	The value of the `SOAPAction` HTTP header if the `jakarta.xml.ws.soap.http.soapaction.use` property is set to `true` . Default value is an empty string.

Name	Type	Description
`jakarta.xml.ws.wsdl`
`.service`	QName	Specifies the qualified name of the service.
`.port`	QName	Specifies the qualified name of the port.

Property	Description	Default
`name`	The local name of the element	””
`targetNamespace`	The namespace name of the element	””
`faultBean`	The fully qualified name of the fault bean class	””
`messageName`	The name of the wsdl:message	””

Property	Description	Default
`localName`	The local name of the element	””
`targetNamespace`	The namespace name of the element	””
`className`	The name of the wrapper class	””
`partName`	The name of the wsdl:part	””

Property	Description	Default
`name`	The local name of the service	””
`targetNamespace`	The namespace name of the service	””
`wsdlLocation`	The URL for the WSDL description of the service	””

Property	Description	Default
`wsdlLocation`	The URL for the WSDL description	””
`serviceName`	The name of the service	””
`portName`	The name of the port	””
`targetNamespace`	The target namespace for the service	””

Property	Description	Default
`name`	The name identifying the Web service reference.	””
`wsdlLocation`	A URL pointing to the location of the WSDL document for the service being referred to.	””
`type`	The resource type as a Java class object	`Object.class`
`value`	The service type as a Java class object	`Service.class`
`mappedName`	A product specific name that this resource should be mapped to.	””
`lookup`	A portable JNDI lookup name that resolves to the target web service reference.	””

Property	Description	Default
`fault`	Array of `FaultAction` for the `wsdl:fault` s of the operation	””
`input`	Action for the `wsdl:input` of the operation	””
`output`	Action for the `wsdl:output` of the operation	””

Property	Description	Default
`value`	Action for the `wsdl:fault` of the operation	””
`output`	Name of the exception class	no defaults required property

Property	Description	Default
`id`	Unique identifier for the `WebServiceFeature` represented by the annotated annotation.	No defaults required property
`bean`	The class name of a derived `WebServiceFeature` class associated with the annotated annotation.	No defaults required property

Property	Description	Default
`enabled`	Specifies if WS-Addressing is enabled or not.	true
`required`	Specifies Adddressing headers MUST be present on incoming messages.	false
`responses`	If addressing is enabled, this property determines if endpoint requires the use of anonymous responses, or non-anonymous responses, or all.	`Responses.ALL`

Property	Description	Default
`enabled`	Specifies if MTOM is enabled or not.	true
`threshold`	Specifies the size in bytes that binary data SHOULD be before being sent as an attachment.	0

Message Direction	Term	Handler
Inbound	Next	H_i-1
Inbound	Previous	H_i+1
Outbound	Next	H_i+1
Outbound	Previous	H_i-1

Name	Type	Mandatory	Description
`jakarta.xml.ws.handler.message`
`.outbound`	`Boolean`	Y	Specifies the message direction: `true` for outbound messages, `false` for inbound messages.
`jakarta.xml.ws.binding.attachments`
`.inbound`	`Map<String,DataHandler>`	Y	A map of attachments to an inbound message. The key is a unique identifier for the attachment. The value is a `DataHandler` for the attachment data. Bindings describe how to carry attachments with messages.
`.outbound`	`Map<String,DataHandler>`	Y	A map of attachments to an outbound message. The key is a unique identifier for the attachment. The value is a `DataHandler` for the attachment data. Bindings describe how to carry attachments with messages.
`jakarta.xml.ws.reference`
`.parameters`	`List<Element>`	Y	A list of WS Addressing reference parameters. The list MUST include all SOAP headers marked with the `wsa:IsReferenceParameter="true"` attribute.
`jakarta.xml.ws.wsdl`
`.description`	`URI`	N	A resolvable URI that may be used to obtain access to the WSDL for the endpoint.
`.service`	`QName`	N	The name of the service being invoked in the WSDL.
`.port`	`QName`	N	The name of the port over which the current message was received in the WSDL.
`.interface`	`QName`	N	The name of the port type to which the current message belongs.
`.operation`	`QName`	N	The name of the WSDL operation to which the current message belongs. The namespace is the target namespace of the WSDL definitions element.

Name	Type	Mandatory	Description
`jakarta.xml.ws.http.request`
`.headers`	`Map<String,List<String>>`	Y	A map of the HTTP headers for the request message. The key is the header name. The value is a list of values for that header.
`.method`	`String`	Y	The HTTP method for the request message.
`.querystring`	`String`	Y	The HTTP query string for the request message, or `null` if the request does not have any. If the address specified using the jakarta.xml.ws.service.endpoint.address in the BindingProvider contains a query string and if the querystring property is set by the client it will override the existing query string in the jakarta.xml.ws.service.endpoint.address property. The value of the property does not include the leading "?" of the query string in it. This property is only used with HTTP binding.
`.pathinfo`	`String`	Y	Extra path information associated with the URL the client sent when it made this request. The extra path information follows the base url path but precedes the query string and will start with a "/" character.
`jakarta.xml.ws.http.response`
`.headers`	`Map<String,List<String>>`	Y	A map of the HTTP headers for the response message. The key is the header name. The value is a list of values for that header.
`.code`	`Integer`	Y	The HTTP response status code.

Name	Type	Mandatory	Description
`jakarta.xml.ws.servlet`
`.context`	`jakarta.servlet.ServletContex`t	Y	The `ServletContext` object belonging to the web application that contains the endpoint.
`.request`	`jakarta.servlet.http.HttpServletRequest`	Y	The `HttpServletRequest` object associated with the request currently being served.
`.response`	`jakarta.servlet.http.HttpServletResponse`	Y	The `HttpServletResponse` object associated with the request currently being served.

Jakarta XML Web Services

Eclipse Foundation Specification License

Disclaimers

Scope

1. Introduction

1.1. Goals

1.2. Non-Goals

1.3. Requirements

1.3.1. Relationship To Jakarta XML Binding

1.3.2. Standardized WSDL Mapping

1.3.3. Customizable WSDL Mapping

1.3.4. Standardized Protocol Bindings

1.3.5. Standardized Transport Bindings

1.3.6. Standardized Handler Framework

1.3.7. Versioning and Evolution

1.3.8. Standardized Synchronous and Asynchronous Invocation

1.3.9. Session Management

1.4. Use Cases

1.4.1. Handler Framework

1.4.1.1. Reliable Messaging Support

1.4.1.2. Message Logging

1.4.1.3. WS-I Conformance Checking

1.5. Conventions

1.6. Expert Group Members

1.6.1. JWS Expert Group Members

1.7. Acknowledgements

2. WSDL 1.1 to Java Mapping

2.1. Definitions

2.1.1. Extensibility

2.2. Port Type

2.3. Operation

2.3.1. Message and Part

2.3.1.1. Non-wrapper Style

2.3.1.2. Wrapper Style

2.3.1.3. Example

2.3.2. Parameter Order and Return Type

2.3.3. Holder Class

2.3.4. Asynchrony

2.3.4.1. Standard Asynchronous Interfaces

2.3.4.2. Operation

2.3.4.3. Message and Part

2.3.4.4. Response Bean

2.3.4.5. Faults

2.3.4.6. Mapping Examples

2.3.4.7. Usage Examples

2.4. Types

2.4.1. W3CEndpointReference

2.5. Fault

2.5.1. Example

2.6. Binding

2.6.1. General Considerations

2.6.2. SOAP Binding

2.6.2.1. Header Binding Extension

2.6.3. MIME Binding

2.6.3.1. mime:content

2.7. Service and Port

2.7.1. Example

2.8. XML Names

2.8.1. Name Collisions

3. Java to WSDL 1.1 Mapping

3.1. Java Names

3.1.1. Name Collisions

3.2. Package

3.3. Class

3.4. Interface

3.4.1. Inheritance

3.5. Method

3.5.1. One Way Operations

3.5.2. wsam:Action Computation Algorithm

3.6. Method Parameters and Return Type

3.6.1. Parameter and Return Type Classification

3.6.2. Use of Jakarta XML Binding

3.6.2.1. Document Wrapped

3.6.2.2. Document Bare

3.6.2.3. RPC

3.7. Service Specific Exception

3.8. Bindings

3.8.1. Interface

3.8.2. Method and Parameters

3.9. Generics

2.6.3.1. `mime:content`

5.2.5.3. Use of `@WebService(wsdlLocation)` and Metadata