Spring Web Services Framework

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
 FaultCode faultCode
          The fault code.
 
Optional Element Summary
 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"

Spring Web Services Framework

Copyright © 2005-2013 The Spring Web Services Framework. All Rights Reserved.