uCosminexus Application Server, Web Service Development Guide
This subsection describes the support range of the core APIs.
The following table describes the support range of the com.sun.xml.ws.developer.StreamingAttachmentFeature class.
Table 19-13 Support range of the com.sun.xml.ws.developer.StreamingAttachmentFeature class
| No. | Return value type | Method name | Support | |
|---|---|---|---|---|
| 1 | -- | StreamingAttachmentFeature() | N | |
| 2 | -- | StreamingAttachmentFeature(String dir,boolean parseEagerly,long memoryThreshold) | Y | |
| Explanation | Creates StreamingAttachmentFeature. | |||
| Argument |
|
|||
| 3 | java.lang.String | getID() | Y | |
| Explanation | Obtains a unique identifier for StreamingAttachmentFeature. | |||
| 4 | org.jvnet.mimepull.MIMEConfig | getConfig() | Y | |
| Explanation | Obtains the MIMEConfig instance indicating the streaming settings. If you invoke this method once, you cannot change the streaming settings by using the following setter methods:
|
|||
| 5 | void | setDir(String dir) | Y | |
| Explanation | Specifies the directory to be used to output the MIME body, which is included in the SOAP message containing the received attachment, as a temporary file, when streaming is enabled. If this method is invoked multiple times, the value specified last is valid. If you invoke the getConfig() method, you cannot reset the values using this method. | |||
| Argument |
|
|||
| 6 | void | setParseEagerly(boolean parseEagerly) | Y | |
| Explanation | Specifies whether the SOAP message containing the received attachment will be parsed in detail, when streaming is enabled. If this method is invoked multiple times, the value specified last is valid. If you invoke the getConfig() method, you cannot reset the values using this method. | |||
| Argument |
|
|||
| 7 | void | setMemoryThreshold(int memoryThreshold) | Y | |
| Explanation | Specifies the threshold value for determining whether the MIME body included in the SOAP message will be expanded in the memory when a SOAP message containing an attachment is received, when streaming is enabled. If this method is invoked multiple times, the value specified last is valid. If you invoke the getConfig() method, you cannot reset the values using this method. | |||
| Argument |
|
|||
The following table describes the support range of the com.sun.xml.ws.developer.StreamingDataHandler class.
Table 19-14 Support range of the com.sun.xml.ws.developer.StreamingDataHandler class
| No. | Return value type | Method name | Support | |
|---|---|---|---|---|
| 1 | -- | StreamingDataHandler(Object o, String s) | N | |
| 2 | -- | StreamingDataHandler(URL url) | N | |
| 3 | -- | StreamingDataHandler(DataSource dataSource) | N | |
| 4 | java.io.InputStream | readOnce() | Y | |
| Explanation | Obtains java.io.InputStream of this object. | |||
| Exception |
|
|||
| 5 | void | moveTo(File file) | Y | |
| Explanation | Moves the attachment indicated by this object to the specified file.
|
|||
| Argument |
|
|||
| Exception |
|
|||
| 6 | void | close() | Y | |
| Explanation | Releases the resources of the attachment indicated by this object. | |||
| Exception |
|
|||
The following table describes the support range of the org.jvnet.mimepull.MIMEConfig class.
Table 19-15 Support range of the org.jvnet.mimepull.MIMEConfig class
| No. | Return value type | Method name | Support | |
|---|---|---|---|---|
| 1 | -- | MIMEConfig() | N | |
| 2 | void | setParseEagerly(boolean parseEagerly) | Y | |
| Explanation | Specifies whether the SOAP message containing the received attachment will be parsed in detail, when streaming is enabled. If this method is invoked multiple times, the value specified last is valid. | |||
| Argument |
|
|||
| 3 | void | setMemoryThreshold(long memoryThreshold) | Y | |
| Explanation | Specifies the threshold value for determining whether the MIME body included in the SOAP message will be expanded in the memory when a SOAP message containing an attachment is received, when streaming is enabled. If this method is invoked multiple times, the value specified last is valid. | |||
| Argument |
|
|||
| 4 | void | setDir(String dir) | Y | |
| Explanation | Specifies the directory to be used to output the MIME body, which is included in the SOAP message containing the received attachment, as a temporary file, when streaming is enabled. If this method is invoked multiple times, the value other than null or null character ("") and the one specified first is valid. | |||
| Argument |
|
|||
| 5 | void | validate() | Y | |
| Explanation | Validates whether a temporary file can be created. If the temporary file cannot be created, specify settings to expand the attachment in the memory. If a non-existent directory, a directory without access permissions, or an existing file name is specified using the setDir(String dir) method and not validated using this method, org.jvnet.mimepull.MIMEParsingException occurs when a temporary file is output by streaming. |
|||
The following table describes the support range of the javax.xml.ws.Binding interface. For details, see the JAX-WS 2.2 specifications.
Table 19-16 Support range of the javax.xml.ws.Binding interface
| No. | Return value type | Method name and Description | Support | |
|---|---|---|---|---|
| 1 | java.lang.String | getBindingID() | N | |
| 2 | java.util.List<Handler> | getHandlerChain() | Y | |
| Description | Acquires a copy of the handler chain of the protocol binding instance. | |||
| 3 | void | setHandlerChain (java.util.List<Handler> chain) | Y | |
| Description | Specifies the handler chain of the protocol binding instance. | |||
| Argument |
|
|||
| Exception |
|
|||
The following table describes the support range of the javax.xml.ws.handler.Handler<C extends MessageContext> interface. For details, see the JAX-WS 2.2 specifications.
Table 19-17 Support range of the javax.xml.ws.handler.Handler<C extends MessageContext> interface
| No. | Return value type | Method name/ Explanation | Support | |
|---|---|---|---|---|
| 1 | MessageContext.Scope | close(MessageContext context) | Y | |
| Explanation | This method is invoked just before the JAX-WS runtime dispatches a message, fault, or exception, when the message exchange is completed. | |||
| 2 | boolean | handleFault(C context) | Y | |
| Explanation | This method is invoked to process a fault message. | |||
| 3 | boolean | handleMessage(C context) | Y | |
| Explanation | This method is invoked to perform normal processing for the inbound and outbound messages. | |||
The following table describes the support range of the javax.xml.ws.handler.HandlerResolver interface. For details, see the JAX-WS 2.2 specifications.
Table 19-18 Support range of the javax.xml.ws.handler.HandlerResolver interface
| No. | Return value type | Method name/ Explanation | Support | |
|---|---|---|---|---|
| 1 | java.util.List<Handler> | getHandlerChain(PortInfo portInfo) | Y | |
| Explanation | Obtains the handler chain of the specified port. This method must not return null. | |||
| Argument |
|
|||
The following table describes the support range of the javax.xml.ws.handler.LogicalMessageContext interface. For details, see the JAX-WS 2.2 specifications.
Table 19-19 Support range of the javax.xml.ws.handler.LogicalMessageContext interface
| No. | Return value type | Method name/ Explanation | Support | |
|---|---|---|---|---|
| 1 | LogicalMessage | getMessage() | Y | |
| Explanation | Obtains the messages from this message context. | |||
The following table describes the support range of the javax.xml.ws.handler.MessageContext interface. For details, see the JAX-WS 2.2 specifications.
Table 19-20 Support range of the javax.xml.ws.handler.MessageContext interface
| No. | Return value type | Method name/ Explanation | Support | |
|---|---|---|---|---|
| 1 | MessageContext.Scope | getScope(java.lang.String name) | Y#1 | |
| Explanation | Obtains the scope of the property. | |||
| Exception |
|
|||
| 2 | void | setScope(java.lang.String name, MessageContext.Scope scope) | Y#2 | |
| Description | Specifies scope of the property. | |||
| Exception |
|
|||
The following table describes the support range of the javax.xml.ws.handler.PortInfo interface. For details, see the JAX-WS 2.2 specifications.
Table 19-21 Support range of the javax.xml.ws.handler.PortInfo interface
| No. | Return value type | Method name/ Explanation | Support | |
|---|---|---|---|---|
| 1 | java.lang.String | getBindingID() | Y | |
| Explanation | Obtains the URI that identifies the binding, used by the port to be accessed. | |||
| 2 | javax.xml.namespace.QName | getPortName() | Y | |
| Explanation | Obtains QName from the WSDL port to be accessed. | |||
| 3 | javax.xml.namespace.QName | getServiceName() | Y | |
| Explanation | Obtains QName of the WSDL service that includes the port to be accessed. | |||
The following table describes the support range of the javax.xml.ws.handler.soap.SOAPHandler<T extends SOAPMessageContext> interface. For details, see the JAX-WS 2.2 specifications.
Table 19-22 Support range of the javax.xml.ws.handler.soap.SOAPHandler<T extends SOAPMessageContext> interface
| No. | Return value type | Method name/ Explanation | Support | |
|---|---|---|---|---|
| 1 | java.util.Set<javax.xml.namespace.QName> | getHeaders() | Y | |
| Explanation | Obtains the headers that can be processed with this handler instance. | |||
The following table describes the support range of the javax.xml.ws.handler.soap.SOAPMessageContext interface. For details, see the JAX-WS 2.2 specifications.
Table 19-23 Support range of the javax.xml.ws.handler.soap.SOAPMessageContext interface
| No. | Return value type | Method name/ Explanation | Support | |
|---|---|---|---|---|
| 1 | java.lang.Object[] | getHeaders(javax.xml.namespace.QName header, javax.xml.bind.JAXBContext context, boolean allRoles) | Y | |
| Explanation | Obtains a header with a specific QName from the messages of this message context. If this message context does not have messages or if a header that matches with QName specified in header does not exist, this method returns an empty array. | |||
| Exception |
|
|||
| 2 | javax.xml.soap.SOAPMessage | getMessage() | Y | |
| Explanation | Obtains the SOAP message from this message context. | |||
| 3 | java.util.Set<java.lang.String> | getRoles() | Y | |
| Explanation | Obtains the SOAP actor and role associated with the execution of the handler chain. | |||
| 4 | void | setMessage(javax.xml.soap.SOAPMessage message) | N | |
The following table describes the support range of the javax.xml.ws.Holder<T> class. For details, see the JAX-WS 2.2 specifications.
Table 19-24 Support range of the javax.xml.ws.Holder<T> class
| No. | Return value type | Method name/ Explanation | Support | |
|---|---|---|---|---|
| 1 | -- | Holder() | Y | |
| Explanation | Creates a new holder containing a null value. | |||
| 2 | -- | Holder(T value) | Y | |
| Explanation | Creates a new holder containing the specified value. | |||
The following table describes the support range of the javax.xml.ws.LogicalMessage interface.
Table 19-25 Support range of the javax.xml.ws.LogicalMessage interface
| No. | Return value type | Method name/ Explanation | Support | |
|---|---|---|---|---|
| 1 | javax.xml.transform.Source | getPayload() | Y | |
| Explanation | Obtains the message payload as an XML source. | |||
| 2 | java.lang.Object | getPayload(javax.xml.bind.JAXBContext context) | Y | |
| Explanation | Obtains the message payload as a JAXB object. | |||
| 3 | void | setPayload(java.lang.Object payload, javax.xml.bind.JAXBContext context) | N | |
| 4 | void | setPayload(javax.xml.transform.Source payload) | N | |
The following table describes the support range of the javax.xml.ws.ProtocolException class. For details, see the JAX-WS 2.2 specifications.
Table 19-26 Support range of the javax.xml.ws.ProtocolException class
| No. | Return value type | Method name/ Explanation | Support | |
|---|---|---|---|---|
| 1 | -- | ProtocolException() | Y | |
| Explanation | Sets up a new exception where the detailed message is null. | |||
| 2 | -- | ProtocolException(java.lang.String message) | Y | |
| Explanation | Sets up a new exception containing the specified detailed message. | |||
| 3 | -- | ProtocolException(java.lang.String message, java.lang.Throwable cause) | Y | |
| Explanation | Sets up a new exception using the specified detailed message and cause. | |||
| 4 | -- | ProtocolException(java.lang.Throwable cause) | Y | |
| Explanation | Sets up a new exception containing the specified cause and detailed message. | |||
The following table describes the support range of the javax.xml.ws.soap.AddressingFeature class. For details, see the JAX-WS 2.2 specifications.
Table 19-27 Support range of the javax.xml.ws.soap.AddressingFeature class
| No. | Return value type | Method name | Support | |
|---|---|---|---|---|
| 1 | -- | AddressingFeature() | Y | |
| Explanation | Creates AddressingFeature. | |||
| 2 | -- | AddressingFeature(boolean enabled) | Y | |
| Explanation | Creates AddressingFeature. | |||
| Argument |
|
|||
| 3 | -- | AddressingFeature(boolean enabled, boolean required) | Y | |
| Explanation | Creates AddressingFeature. | |||
| Argument |
|
|||
| 4 | -- | AddressingFeature(boolean enabled, boolean required, AddressingFeature.Responses responses) |
Y | |
| Explanation | Creates AddressingFeature. | |||
| Argument |
|
|||
| 5 | java.lang.String | getID() | Y | |
| Explanation | Obtains a unique identifier for AddressingFeature. | |||
| 6 | AddressingFeature.Responses | getResponses() | Y | |
| Explanation | Obtains the type of response endpoint to be requested. | |||
| 7 | Boolean | isRequired() | Y | |
| Explanation | Obtains information about whether the use of AddressingFeature will be requested. | |||
The following table describes the support range of the javax.xml.ws.soap.MTOMFeature class. For details, see the JAX-WS 2.2 specifications.
Table 19-28 Support range of the javax.xml.ws.soap.MTOMFeature class
| No. | Return value type | Method name | Support | |
|---|---|---|---|---|
| 1 | -- | MTOMFeature() | Y | |
| Explanation | Creates MTOMFeature. | |||
| 2 | -- | MTOMFeature(boolean enabled) | Y | |
| Explanation | Creates MTOMFeature. | |||
| Argument |
|
|||
| 3 | -- | MTOMFeature(boolean enabled, int threshold) | Y | |
| Explanation | Creates MTOMFeature. | |||
| Argument |
|
|||
| 4 | -- | MTOMFeature(int threshold) | Y | |
| Explanation | Creates MTOMFeature. | |||
| Argument |
|
|||
| 5 | java.lang.String | getID() | Y | |
| Explanation | Obtains the unique identifier of MTOMFeature. | |||
| 6 | int | getThreshold() | Y | |
| Explanation | Obtains the threshold value to determine whether to send the binary data as an attachment in the MTOM/XOP specification format. | |||
The following table describes the support range of the javax.xml.ws.soap.SOAPBinding interface. For details, see the JAX-WS 2.2 specifications.
Table 19-29 Support range of the javax.xml.ws.soap.SOAPBinding interface
| No. | Return value type | Method name | Support | |
|---|---|---|---|---|
| 1 | javax.xml.soap.MessageFactory | getMessageFactory() | N | |
| 2 | java.util.Set<java.lang.String> | getRoles() | N | |
| 3 | javax.xml.soap.SOAPFactory | getSOAPFactory() | N | |
| 4 | boolean | isMTOMEnabled() | Y | |
| Explanation | Returns true if attachments in the MTOM/XOP specification format are enabled. | |||
| 5 | void | setMTOMEnabled(boolean flag) | Y | |
| Explanation | Enables or disables attachments in the MTOM/XOP specification format. If the enabling or disabling of attachments in the MTOM/XOP specification format is not set up by using MTOMFeature or this method, you can specify the settings with this method. If the enabling or disabling of attachments in the MTOM/XOP specification format is already set up, you cannot respecify the settings using this method. |
|||
| Argument |
|
|||
| 6 | void | setRoles(java.util.Set<java.lang.String> roles) | N | |
The following table describes the support range of the javax.xml.ws.soap.SOAPFaultException class. For details, see the JAX-WS 2.2 specifications.
Table 19-30 Support range of the javax.xml.ws.soap.SOAPFaultException class
| No. | Return value type | Method name/ Explanation | Support | |
|---|---|---|---|---|
| 1 | -- | SOAPFaultException (javax.xml.soap.SOAPFault fault) | Y | |
| Explanation | Sets up a new exception of SOAPFaultException. | |||
| 2 | javax.xml.soap.SOAPFault | getFault() | Y | |
| Explanation | Obtains the embedded SOAPFault instance. | |||
The following table describes the support range of the javax.xml.ws.WebServiceException class. For details, see the JAX-WS 2.2 specifications.
Table 19-31 Support range of the javax.xml.ws.WebServiceException class
| No. | Return value type | Method name/ Explanation | Support | |
|---|---|---|---|---|
| 1 | -- | WebServiceException() | Y | |
| Explanation | Sets up a new exception where the detailed message is null. | |||
| 2 | -- | WebServiceException (java.lang.String message) | Y | |
| Explanation | Sets up a new exception containing the specified detailed message. | |||
| 3 | -- | WebServiceException(java.lang.String message, java.lang.Throwable cause) | Y | |
| Explanation | Sets up a new exception containing the specified detailed message and cause. | |||
| 4 | -- | WebServiceException (java.lang.Throwable cause) | Y | |
| Explanation | Sets up a new exception containing the specified cause and detailed message. | |||
All Rights Reserved. Copyright (C) 2013, Hitachi, Ltd.