javax.jws
Annotation Type WebParam


@Retention(value=RUNTIME)
@Target(value=PARAMETER)
public @interface WebParam

Customizes the mapping of an individual parameter to a Web Service message part and XML element.


Optional Element Summary
 boolean header
          If true, the parameter is pulled from a message header rather then the message body.
 WebParam.Mode mode
          The direction in which the parameter is flowing.
 String name
          Name of the parameter as it appears in the WSDL.
 String targetNamespace
          The XML namespace for the parameter.
 

name

public abstract String name
Name of the parameter as it appears in the WSDL. For RPC bindings, this is name of the wsdl:part representing the parameter. For document bindings, this is the local name of the XML element representing the parameter. Defaults to the name of the parameter as it appears in the argument list.

Default:
""

targetNamespace

public abstract String targetNamespace
The XML namespace for the parameter. Only used with document bindings, where the parameter maps to an XML element. Defaults to the targetNamespace for the Web Service.

Default:
""

mode

public abstract WebParam.Mode mode
The direction in which the parameter is flowing. One of IN, OUT, or INOUT. The OUT and INOUT modes may only be specified for parameter types that conform to the JAX-RPC definition of Holder types. See JAX-RPC 1.1, section 4.3.5. OUT and INOUT modes are only supported for RPC bindings or for parameters that map to headers.

Default:
IN

header

public abstract boolean header
If true, the parameter is pulled from a message header rather then the message body.

Default:
false