com.helger.phase4.soap

Enum ESoapVersion

java.lang.Object

java.lang.Enum<ESoapVersion>

com.helger.phase4.soap.ESoapVersion

All Implemented Interfaces:

Serializable, Comparable<ESoapVersion>

public enum ESoapVersion
extends Enum<ESoapVersion>

Enumeration with all known and supported SOAP versions.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
SOAP_11
SOAP_12

Field Summary

Fields

Modifier and Type	Field and Description
static ESoapVersion	AS4_DEFAULT According to spec 2.1.

Method Summary

Modifier and Type	Method and Description
String	getBodyElementName()
static ESoapVersion	getFromMimeTypeOrNull(com.helger.commons.mime.IMimeType aMimeType)
static ESoapVersion	getFromNamespaceURIOrNull(String sNamespaceURI)
static ESoapVersion	getFromVersionOrDefault(String sVersion, ESoapVersion eDefault)
static ESoapVersion	getFromVersionOrNull(String sVersion)
String	getHeaderElementName()
com.helger.commons.mime.IMimeType	getMimeType()
com.helger.commons.mime.MimeType	getMimeType(Charset aCharset) Get the mime type of this SOAP version with the passed charset.
String	getMustUnderstandValue(boolean bMustUnderstand) Get the must understand value contained in SOAP instances of this version.
String	getNamespacePrefix()
String	getNamespaceURI()
String	getVersion()
boolean	isAS4Default()
static ESoapVersion	valueOf(String name) Returns the enum constant of this type with the specified name.
static ESoapVersion[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SOAP_11

public static final ESoapVersion SOAP_11

SOAP_12

public static final ESoapVersion SOAP_12

Field Detail

AS4_DEFAULT

public static final ESoapVersion AS4_DEFAULT

According to spec 2.1. Feature Set

Method Detail

values

public static ESoapVersion[] 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 (ESoapVersion c : ESoapVersion.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ESoapVersion 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

getNamespaceURI

@Nonnull
 @Nonempty
public String getNamespaceURI()

Returns:

The namespace URI for this SOAP version. Neither null nor empty.

getNamespacePrefix

@Nonnull
 @Nonempty
public String getNamespacePrefix()

Returns:

The default namespace prefix to be used. Neither null nor empty.

getMimeType

@Nonnull
public com.helger.commons.mime.IMimeType getMimeType()

Returns:

The mime type of this SOAP version. Never null.

getMimeType

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.mime.MimeType getMimeType(@Nonnull
                                                                                    Charset aCharset)

Get the mime type of this SOAP version with the passed charset.

Parameters:

aCharset - The charset to be used. May not be null.

Returns:

Never null.

getVersion

@Nonnull
 @Nonempty
public String getVersion()

Returns:

The human readable version string. Neither null nor empty.

getMustUnderstandValue

@Nonnull
 @Nonempty
public String getMustUnderstandValue(boolean bMustUnderstand)

Get the must understand value contained in SOAP instances of this version.

Parameters:

bMustUnderstand - must understand value

Returns:

A non-null non-empty string.

getHeaderElementName

@Nonnull
public String getHeaderElementName()

Returns:

The XML element local name of the SOAP header element.

getBodyElementName

@Nonnull
public String getBodyElementName()

Returns:

The XML element local name of the SOAP body element.

isAS4Default

public boolean isAS4Default()

Returns:

true if this SOAP version is the AS4 default version.

See Also:

AS4_DEFAULT

getFromVersionOrNull

@Nullable
public static ESoapVersion getFromVersionOrNull(@Nullable
                                                           String sVersion)

getFromVersionOrDefault

@Nullable
public static ESoapVersion getFromVersionOrDefault(@Nullable
                                                              String sVersion,
                                                              @Nullable
                                                              ESoapVersion eDefault)

getFromNamespaceURIOrNull

@Nullable
public static ESoapVersion getFromNamespaceURIOrNull(@Nullable
                                                                String sNamespaceURI)

getFromMimeTypeOrNull

@Nullable
public static ESoapVersion getFromMimeTypeOrNull(@Nullable
                                                            com.helger.commons.mime.IMimeType aMimeType)