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

Annotation Type SoapFault

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @Inherited
public @interface SoapFault

Marks an exception class with the fault elements that should be returned whenever this exception is thrown.

Since:

1.0.0

Author:

Arjen Poutsma

See Also:

SoapFaultAnnotationExceptionResolver

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
FaultCode	faultCode The fault code.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	customFaultCode The custom fault code, to be used if faultCode() is set to FaultCode.CUSTOM.
String	faultStringOrReason The fault string or reason text.
String	locale The fault string locale.

Element Detail

faultCode

public abstract FaultCode faultCode

The fault code.

customFaultCode

public abstract String customFaultCode

The custom fault code, to be used if faultCode() is set to FaultCode.CUSTOM.

The format used is that of QName.toString(), i.e. "{" + Namespace URI + "}" + local part, where the namespace is optional.

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

Default:

""

faultStringOrReason

public abstract String faultStringOrReason

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

Default:

""

locale

public abstract String locale

The fault string locale. By default, it is English.

Default:

"en"