org.springframework.ws.soap.server.endpoint.annotation

Enum FaultCode

java.lang.Object

java.lang.Enum<FaultCode>

org.springframework.ws.soap.server.endpoint.annotation.FaultCode

All Implemented Interfaces:

Serializable, Comparable<FaultCode>

public enum FaultCode
extends Enum<FaultCode>

Enumeration that represents the standard SOAP Fault codes for use with the JDK 1.5+ SoapFault annotation.

Since:

1.0.0

Author:

Arjen Poutsma

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLIENT Constant used to indicate that a Client fault must be created.
CUSTOM Constant used to indicate that a fault must be created with a custom fault code.
RECEIVER Constant QName used to indicate that a Receiver fault must be created.
SENDER Constant QName used to indicate that a Sender fault must be created.
SERVER Constant QName used to indicate that a Server fault must be created.

Method Summary

Modifier and Type	Method and Description
QName	value()
static FaultCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static FaultCode[]	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

CUSTOM

public static final FaultCode CUSTOM

Constant used to indicate that a fault must be created with a custom fault code. When this value is used, the customFaultCode string property must be used on SoapFault.

Note that custom Fault Codes are only supported on SOAP 1.1.

See Also:

SoapFault.customFaultCode(), Soap11Body.addFault(javax.xml.namespace.QName,String,java.util.Locale)

CLIENT

public static final FaultCode CLIENT

Constant used to indicate that a Client fault must be created.

See Also:

SoapBody.addClientOrSenderFault(String,java.util.Locale)

RECEIVER

public static final FaultCode RECEIVER

Constant QName used to indicate that a Receiver fault must be created.

See Also:

SoapBody.addServerOrReceiverFault(String,java.util.Locale)

SENDER

public static final FaultCode SENDER

Constant QName used to indicate that a Sender fault must be created.

See Also:

SoapBody.addServerOrReceiverFault(String,java.util.Locale)

SERVER

public static final FaultCode SERVER

Constant QName used to indicate that a Server fault must be created.

See Also:

SoapBody.addClientOrSenderFault(String,java.util.Locale)

Method Detail

values

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

Returns:

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

valueOf

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

value

public QName value()