Class SoapFaultDefinition

java.lang.Object

org.springframework.ws.soap.server.endpoint.SoapFaultDefinition

public class SoapFaultDefinition
extends Object

Defines properties for a SOAP Fault. Used by the SoapFaultDefinitionEditor and the SoapFaultMappingExceptionResolver.

Since:

1.0.0

See Also:

• SoapFaultDefinitionEditor
• SoapFaultMappingExceptionResolver

Field Summary

Fields

Modifier and Type	Field	Description
static final QName	CLIENT	Constant QName used to indicate that a Client fault must be created.
static final QName	RECEIVER	Constant QName used to indicate that a Receiver fault must be created.
static final QName	SENDER	Constant QName used to indicate that a Sender fault must be created.
static final QName	SERVER	Constant QName used to indicate that a Server fault must be created.

Constructor Summary

Constructors

Constructor	Description
SoapFaultDefinition()

Method Summary

Modifier and Type	Method	Description
QName	getFaultCode()	Returns the fault code.
@Nullable String	getFaultStringOrReason()	Returns the fault string or reason text.
Locale	getLocale()	Gets the fault string locale.
void	setFaultCode(QName faultCode)	Sets the fault code.
void	setFaultStringOrReason(String faultStringOrReason)	Sets the fault string or reason text.
void	setLocale(Locale locale)	Sets the fault string locale.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CLIENT

public static final QName CLIENT

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

See Also:

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

RECEIVER

public static final QName 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 QName 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 QName SERVER

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

See Also:

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

Constructor Details

SoapFaultDefinition

public SoapFaultDefinition()

Method Details

getFaultCode

public QName getFaultCode()

Returns the fault code.

setFaultCode

public void setFaultCode(QName faultCode)

Sets the fault code.

getFaultStringOrReason

public @Nullable String getFaultStringOrReason()

Returns the fault string or reason text. By default, it is set to the exception message.

setFaultStringOrReason

public void setFaultStringOrReason(String faultStringOrReason)

Sets the fault string or reason text. By default, it is set to the exception message.

getLocale

public Locale getLocale()

Gets the fault string locale. By default, it is English.

See Also:

• Locale.ENGLISH

setLocale

public void setLocale(Locale locale)

Sets the fault string locale. By default, it is English.

See Also:

• Locale.ENGLISH