Package com.sun.xml.ws.api

Enum SOAPVersion

  • All Implemented Interfaces:
    Serializable, Comparable<SOAPVersion>
    public enum SOAPVersion
extends Enum<SOAPVersion>
    Version of SOAP (1.1 and 1.2).

    This class defines various constants for SOAP 1.1 and SOAP 1.2, and also defines convenience methods to simplify the processing of multiple SOAP versions.

    This constant alows you to do: 

     SOAPVersion version = ...;
 version.someOp(...);
    As opposed to: 
     if(binding is SOAP11) {
   doSomeOp11(...);
 } else {
   doSomeOp12(...);
 }
    Author:
    Kohsuke Kawaguchi

    • Field Detail

      • httpBindingId

        public final String httpBindingId
        Binding ID for SOAP/HTTP binding of this SOAP version.

        Either SOAPBinding.SOAP11HTTP_BINDING or SOAPBinding.SOAP12HTTP_BINDING

      • nsUri

        public final String nsUri
        SOAP envelope namespace URI.

      • contentType

        public final String contentType
        Content-type. Either "text/xml" or "application/soap+xml".

      • faultCodeMustUnderstand

        public final QName faultCodeMustUnderstand
        SOAP MustUnderstand FaultCode for this SOAP version

      • saajMessageFactory

        public final jakarta.xml.soap.MessageFactory saajMessageFactory
        Deprecated.
        SAAJ MessageFactory for this SOAP version.

      • saajSoapFactory

        public final jakarta.xml.soap.SOAPFactory saajSoapFactory
        Deprecated.
        SAAJ SOAPFactory for this SOAP version.

      • implicitRole

        public final String implicitRole
        If the actor/role attribute is absent, this SOAP version assumes this value.

      • requiredRoles

        public final Set<String> requiredRoles
        This represents the roles required to be assumed by SOAP binding implementation.

      • roleAttributeName

        public final String roleAttributeName
        "role" (SOAP 1.2) or "actor" (SOAP 1.1)

      • faultCodeClient

        public final QName faultCodeClient
        "{nsUri}Client" or "{nsUri}Sender"

      • faultCodeServer

        public final QName faultCodeServer
        "{nsUri}Server" or "{nsUri}Receiver"

    • Method Detail

      • values

        public static SOAPVersion[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (SOAPVersion c : SOAPVersion.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static SOAPVersion valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getSOAPFactory

        public jakarta.xml.soap.SOAPFactory getSOAPFactory()

      • getMessageFactory

        public jakarta.xml.soap.MessageFactory getMessageFactory()

      • fromHttpBinding

        public static SOAPVersion fromHttpBinding​(String binding)
        Returns SOAPVersion whose httpBindingId equals to the given string. This method does not perform input string validation.
        Parameters:
        binding - for historical reason, we treat null as SOAP_11, but you really shouldn't be passing null.
        Returns:
        always non-null.

      • fromNsUri

        public static SOAPVersion fromNsUri​(String nsUri)
        Returns SOAPVersion whose nsUri equals to the given string. This method does not perform input string validation.
        Parameters:
        nsUri - must not be null.
        Returns:
        always non-null.