Interface SOAPBinding

  • All Superinterfaces:
    Binding

    public interface SOAPBinding
    extends Binding
    The SOAPBinding interface is an abstraction for the SOAP binding.
    Since:
    1.6, JAX-WS 2.0
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String SOAP11HTTP_BINDING
      A constant representing the identity of the SOAP 1.1 over HTTP binding.
      static java.lang.String SOAP11HTTP_MTOM_BINDING
      A constant representing the identity of the SOAP 1.1 over HTTP binding with MTOM enabled by default.
      static java.lang.String SOAP12HTTP_BINDING
      A constant representing the identity of the SOAP 1.2 over HTTP binding.
      static java.lang.String SOAP12HTTP_MTOM_BINDING
      A constant representing the identity of the SOAP 1.2 over HTTP binding with MTOM enabled by default.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      jakarta.xml.soap.MessageFactory getMessageFactory()
      Gets the Jakarta SOAP with Attachments' MessageFactory instance used by this SOAP binding.
      java.util.Set<java.lang.String> getRoles()
      Gets the roles played by the SOAP binding instance.
      jakarta.xml.soap.SOAPFactory getSOAPFactory()
      Gets the Jakarta SOAP with Attachments' SOAPFactory instance used by this SOAP binding.
      boolean isMTOMEnabled()
      Returns true if the use of MTOM is enabled.
      void setMTOMEnabled​(boolean flag)
      Enables or disables use of MTOM.
      void setRoles​(java.util.Set<java.lang.String> roles)
      Sets the roles played by the SOAP binding instance.
    • Field Detail

      • SOAP11HTTP_BINDING

        static final java.lang.String SOAP11HTTP_BINDING
        A constant representing the identity of the SOAP 1.1 over HTTP binding.
        See Also:
        Constant Field Values
      • SOAP12HTTP_BINDING

        static final java.lang.String SOAP12HTTP_BINDING
        A constant representing the identity of the SOAP 1.2 over HTTP binding.
        See Also:
        Constant Field Values
      • SOAP11HTTP_MTOM_BINDING

        static final java.lang.String SOAP11HTTP_MTOM_BINDING
        A constant representing the identity of the SOAP 1.1 over HTTP binding with MTOM enabled by default.
        See Also:
        Constant Field Values
      • SOAP12HTTP_MTOM_BINDING

        static final java.lang.String SOAP12HTTP_MTOM_BINDING
        A constant representing the identity of the SOAP 1.2 over HTTP binding with MTOM enabled by default.
        See Also:
        Constant Field Values
    • Method Detail

      • getRoles

        java.util.Set<java.lang.String> getRoles()
        Gets the roles played by the SOAP binding instance.
        Returns:
        Set<String> The set of roles played by the binding instance.
      • setRoles

        void setRoles​(java.util.Set<java.lang.String> roles)
        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()
        Returns true 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 - A boolean 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

        jakarta.xml.soap.SOAPFactory getSOAPFactory()
        Gets the Jakarta SOAP with Attachments' SOAPFactory instance used by this SOAP binding.
        Returns:
        SOAPFactory instance used by this SOAP binding.
      • getMessageFactory

        jakarta.xml.soap.MessageFactory getMessageFactory()
        Gets the Jakarta SOAP with Attachments' MessageFactory instance used by this SOAP binding.
        Returns:
        MessageFactory instance used by this SOAP binding.