uCosminexus Application Server, Web Service Development Guide

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

16.2.1 List of annotations

The following table describes the annotations that can be used for customization and the auto-generated annotations. For details about the annotations, see the JAX-WS 2.2 specifications.

Table 16-11 List of annotations of JAX-WS used for customization

No. Annotations Description Definition
Annotation name Element name
1 com.sun.xml.ws.developer.StreamingAttachment dir This is a name of the directory that generates a temporary file when you want to output the MIME body that is included in the SOAP message containing the received attachments as temporary files. Y
parseEagerly Sets whether to perform the detailed parsing for the SOAP message that contains the received attachments. Y
memoryThreshold This is the threshold to decide whether to extract the MIME body that is included in the SOAP message containing the received attachments, in the memory. Y
2 javax.jws.HandlerChain file URL and relative path indicating the location of the handler chain file. Y
3 javax.jws.Oneway -- Annotation to be specified when using the one-way operation in Web Services Y
4 javax.jws.soap.SOAPBinding parameterStyle The style of the method parameters (Document wrapped or Document Bare style). Y
style The encoding style of the message. In the Cosminexus JAX-WS functionality, only document can be specified. Y
use The format style of the message. In the Cosminexus JAX-WS functionality, only literal can be specified. Y
5 javax.jws.WebMethod action String that determines the SOAP action. Y
exclude Specifies whether the Web method can be made public. Y
operationName The wsdl:operation element name matching with the method. Y
6 javax.jws.WebParam header Indicates whether the parameter is obtained from the message header. Y
mode Direction of the flow of parameters (in, inout, and out). Y
name Local name of the XML element indicating the parameter. Y
partName The wsdl:part element name indicating the parameter. Y
targetNamespace XML name space name. Y
7 javax.jws.WebResult header Indicates whether to obtain the return value from the message header. Y
name Local name of the XML element indicating the return value. Y
partName The wsdl:part element name indicating the return value. Y
targetNamespace XML name space name. Y
8 javax.jws.WebService endpointInterface The fully qualified name of SEI that defines the abstract Web Service contract of the Web Service. Y
name The wsdl:portType element name indicating the Web Service name. Y
portName The wsdl:port element name indicating the Web Service port name. Y
serviceName The wsdl:service element name indicating the service name of the Web Service. Y
targetNamespace The name space name of the Web Service. Y
wsdlLocation URL indicating WSDL of the Web Service. Y#1,#3
9 javax.xml.ws.Action fault This is a value of the wsa:Action element of the addressing header. This element is required, when the Web Service sends a fault message Y
input This is a value of the wsa:Action element of the addressing header. This element is required, when the Web Service receives a request message. Y
output This is a value of the wsa:Action element of the addressing header. This element is required, when the Web Service sends a response message. Y
10 javax.xml.ws.BindingType value Binding used for making SEI public. Y
11 javax.xml.ws.FaultAction className This is an exception class name. Y
value This is a value of the wsa:Action element of the addressing header. This element is required, when sending the fault message corresponding to the exception class name that is specified in className from the Web Service. Y
12 javax.xml.ws.RequestWrapper className The request bean class name. Y
localName The local name of the target element. Y
targetNamespace The name space name of the target element. Y
partName The part name of the input message that references the request wrapper element. Y
13 javax.xml.ws.ResponseWrapper className The response bean class name. Y
localName The local name of the target element. Y
targetNamespace The name space name of the target element. Y
partName The part name of the output message that references the response wrapper element. Y
14 javax.xml.ws.ServiceMode value This is the service mode. Y
15 javax.xml.ws.soap.Addressing enabled Specifies whether to enable the addressing functionality. Y
required Specifies whether the addressing header is required, when invoking the Web Service.
response Sets whether to make the anonymous or non-anonymous response mandatory for the endpoint.
16 javax.xml.ws.soap.MTOM enabled Sets whether to use the attachments with the MTOM/XOP specification format. Y
threshold Sets the threshold for sending the binary data as attachments with the MTOM/XOP specification format. Y
17 javax.xml.ws.WebFault faultBean The fault bean class name. Y
name The local name of the target element. Y
targetNamespace The name space name of the target element. Y
messageName The fault message name. Y
18 javax.xml.ws.WebServiceProvider targetNamespace This is the name space name of the Web Service. Y
portName This is the port name of the Web Service. Y
serviceName This is the service name of the Web Service. Y
wsdlLocation This is the URL indicating the WSDL of the Web Service. Y#3
19 javax.xml.ws.RespectBinding#1 enabled Indicates whether the contents of the wsdl:binding element are enabled. Y#1
20 javax.xml.ws.WebEndpoint#2 name The local name of port. N#1
21 javax.xml.ws.WebServiceClient#2 name The local name of Web Service. N#2
targetNamespace The name space name of the Web Service. N#2
wsdlLocation URL indicating WSDL of the Web Service. N#2,#3

Legend:
--: Indicates that the annotation does not have any element
Y: Indicates that you can specify an annotation and an element.
N: Indicates that you cannot specify an annotation and an element (not supported).

#1
The specified value is ignored (the warning message is not displayed).

#2
Cannot be specified since the annotation is automatically given to the class generated from WSDL.

#3
The annotations do not support mapping in the catalog functionality.

The following is the list of the JAXB annotations that can be defined with the Web Services of Cosminexus. For details on each annotation, see Standard specifications of JAXB.

Of the annotations in the JSR-181 specifications and JAX-WS 2.2 specifications, you cannot use the annotations indicated in the following table. If the following annotations are specified, the operations might not function properly.

Table 16-12 List of un-supported annotations

No. Annotations Remarks
1 javax.xml.ws.WebServiceRefs The functionality related to JSR109 specifications is not supported.
2 javax.xml.ws.spi.WebServiceFeatureAnnotation The API (method that takes the features in the parameter) for using this annotation is not supported.
3 javax.jws.soap.InitParam Not recommended in JSR181 specifications (will be removed).
4 javax.jws.soap.SOAPMessageHandler Not recommended in JSR181 specifications (will be removed).
5 javax.jws.soap.SOAPMessageHandlers Not recommended in JSR181 specifications (will be removed).