uCosminexus Application Server, Web Service Development Guide

[Contents][Glossary][Index][Back][Next]

16.2.7 javax.jws.WebParam annotation

The javax.jws.WebParam annotation can be used to customize the mapping of arguments.

The following figure shows an example of customization with the javax.jws.WebParam annotation:

Figure 16-15 Example of customization with the javax.jws.WebParam annotation

[Figure]

Organization of this subsection
(1) header element (javax.jws.WebParam)
(2) name element (javax.jws.WebParam)
(3) partName element (javax.jws.WebParam)
(4) mode element (javax.jws.WebParam)
(5) targetNamespace element (javax.jws.WebParam)

(1) header element (javax.jws.WebParam)

To map an argument as a header parameter, specify true in the element value of the header element.

You can specify the header element in the non-wrapper style. If specified in the wrapper style, an error message is output to the standard error output and logs (KDJW61037-E).

(2) name element (javax.jws.WebParam)

The name element is used to customize the child element name of the wrapper element that is mapped from the argument in the wrapper style. For the non-wrapper style, the name element is used to customize the local name of the global element that is mapped from the argument. If the partName element is not specified in the non-wrapper style, you can also customize the part name by specifying the element value of the name element.

The precautions for specifying the name element are as follows:

(3) partName element (javax.jws.WebParam)

You specify the partName element to customize the mapping of the part names.

The precautions for specifying the partName element are as follows:

(4) mode element (javax.jws.WebParam)

In the mode element, you specify the value indicating the direction of the flow of parameters. The values that can be specified are as follows:

(5) targetNamespace element (javax.jws.WebParam)

Use the targetNamespace element to customize the name space of the global element that is mapped from the argument.

In the targetNamespace element, the http:// or urn: protocol is specified as a name space. The following name space formats and strings can be specified: