Package jakarta.xml.ws.soap
Interface SOAPBinding
- All Superinterfaces:
Binding
The
SOAPBinding
interface is an abstraction for
the SOAP binding.- Since:
- 1.6, JAX-WS 2.0
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
A constant representing the identity of the SOAP 1.1 over HTTP binding.static final String
A constant representing the identity of the SOAP 1.1 over HTTP binding with MTOM enabled by default.static final String
A constant representing the identity of the SOAP 1.2 over HTTP binding.static final String
A constant representing the identity of the SOAP 1.2 over HTTP binding with MTOM enabled by default. -
Method Summary
Modifier and TypeMethodDescriptionGets the Jakarta SOAP with Attachments'MessageFactory
instance used by this SOAP binding.getRoles()
Gets the roles played by the SOAP binding instance.Gets the Jakarta SOAP with Attachments'SOAPFactory
instance used by this SOAP binding.boolean
Returnstrue
if the use of MTOM is enabled.void
setMTOMEnabled
(boolean flag) Enables or disables use of MTOM.void
Sets the roles played by the SOAP binding instance.Methods inherited from interface jakarta.xml.ws.Binding
getBindingID, getHandlerChain, setHandlerChain
-
Field Details
-
SOAP11HTTP_BINDING
A constant representing the identity of the SOAP 1.1 over HTTP binding.- See Also:
-
SOAP12HTTP_BINDING
A constant representing the identity of the SOAP 1.2 over HTTP binding.- See Also:
-
SOAP11HTTP_MTOM_BINDING
A constant representing the identity of the SOAP 1.1 over HTTP binding with MTOM enabled by default.- See Also:
-
SOAP12HTTP_MTOM_BINDING
A constant representing the identity of the SOAP 1.2 over HTTP binding with MTOM enabled by default.- See Also:
-
-
Method Details
-
getRoles
Gets the roles played by the SOAP binding instance.- Returns:
Set<String>
The set of roles played by the binding instance.
-
setRoles
Sets the roles played by the SOAP binding instance.- Parameters:
roles
- The set of roles played by the binding instance.- Throws:
WebServiceException
- On an error in the configuration of the list of roles.
-
isMTOMEnabled
boolean isMTOMEnabled()Returnstrue
if the use of MTOM is enabled.- Returns:
true
if and only if the use of MTOM is enabled.
-
setMTOMEnabled
void setMTOMEnabled(boolean flag) Enables or disables use of MTOM.- Parameters:
flag
- Aboolean
specifying whether the use of MTOM should be enabled or disabled.- Throws:
WebServiceException
- If the specified setting is not supported by this binding instance.
-
getSOAPFactory
SOAPFactory getSOAPFactory()Gets the Jakarta SOAP with Attachments'SOAPFactory
instance used by this SOAP binding.- Returns:
- SOAPFactory instance used by this SOAP binding.
-
getMessageFactory
MessageFactory getMessageFactory()Gets the Jakarta SOAP with Attachments'MessageFactory
instance used by this SOAP binding.- Returns:
- MessageFactory instance used by this SOAP binding.
-