Package jakarta.jws

Annotation Interface WebResult

@Retention(RUNTIME) @Target(METHOD) public @interface WebResult
Customizes the mapping of the return value to a WSDL part and XML element.
Since:
1.6

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    header
    If true, the result is pulled from a message header rather then the message body.
    String
    name
    Name of return value.
    String
    partName
    The name of the wsdl:part representing this return value.
    String
    targetNamespace
    The XML namespace for the return value.

  • Element Details

    • name

      String name
      Name of return value.

      If the operation is rpc style and @WebResult.partName has not been specified, this is the name of the wsdl:part representing the return value.
      If the operation is document style or the return value maps to a header, this is the local name of the XML element representing the return value.

      Returns:
      the name of return value
      Default:
      ""

    • partName

      String partName
      The name of the wsdl:part representing this return value.

      This is only used if the operation is rpc style, or if the operation is document style and the parameter style is BARE.

      Returns:
      the name of the wsdl:part
      Since:
      2.0
      Default:
      ""

    • targetNamespace

      String targetNamespace
      The XML namespace for the return value.

      Only used if the operation is document style or the return value maps to a header. If the target namespace is set to ��, this represents the empty namespace.

      Returns:
      the XML namespace
      Default:
      ""

    • header

      boolean header
      If true, the result is pulled from a message header rather then the message body.
      Returns:
      value of true to pull the parameter from a message header rather then the message body or false otherwise
      Since:
      2.0
      Default:
      false