SoapFault (Apache CXF JavaDoc 3.1.0 API)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - java.lang.RuntimeException
    - - org.apache.cxf.common.i18n.UncheckedException
      - org.apache.cxf.interceptor.Fault
        
        org.apache.cxf.binding.soap.SoapFault

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

WSEventingFault
```
public class SoapFault
extends Fault
```
See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static QName ATTACHMENT_IO
- Fields inherited from class org.apache.cxf.interceptor.Fault
  FAULT_CODE_CLIENT, FAULT_CODE_SERVER, STACKTRACE, STACKTRACE_NAMESPACE
- Fields inherited from class org.apache.cxf.common.i18n.UncheckedException
  message

Fields
Modifier and Type	Field and Description
`static QName`	`ATTACHMENT_IO`

Constructor Summary

Constructors
Constructor and Description
`SoapFault(Message message, QName faultCode)`
`SoapFault(Message message, Throwable throwable, QName faultCode)`
`SoapFault(String message, QName faultCode)`
`SoapFault(String message, ResourceBundle bundle, QName faultCode)`
`SoapFault(String message, ResourceBundle bundle, QName faultCode, Object... params)`
`SoapFault(String message, ResourceBundle bundle, Throwable t, QName faultCode)`
`SoapFault(String message, Throwable t, QName faultCode)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addSubCode(QName subCode)` Appends the SubCode to the SubCode list.
`static SoapFault`	`createFault(Fault f, SoapVersion v)`
`String`	`getCodeString(String prefix, String defaultPrefix)`
`Map<String,String>`	`getNamespaces()`
`String`	`getNode()`
`String`	`getReason()`
`String`	`getRole()` Returns the fault actor.
`QName`	`getSubCode()` Returns the SubCode for the Fault Code.
`List<QName>`	`getSubCodes()` Returns the SubCode list for the Fault Code.
`String`	`getSubCodeString(String prefix, String defaultPrefix)`
`void`	`setNamespaces(Map<String,String> namespaces)`
`void`	`setNode(String n)`
`void`	`setRole(String actor)` Sets the fault actor.
`void`	`setSubCode(QName subCode)` Sets the SubCode for the Fault Code.
`void`	`setSubCodes(List<QName> subCodes)` Sets the SubCode list for the Fault Code.

Methods inherited from class org.apache.cxf.interceptor.Fault
getDetail, getFaultCode, getLang, getMessage, getOrCreateDetail, getStatusCode, hasDetails, setDetail, setFaultCode, setLang, setMessage, setStatusCode

Methods inherited from class org.apache.cxf.common.i18n.UncheckedException
getCode

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ATTACHMENT_IO

public static final QName ATTACHMENT_IO

Constructor Detail

SoapFault

public SoapFault(Message message,
         Throwable throwable,
         QName faultCode)

SoapFault

public SoapFault(Message message,
         QName faultCode)

SoapFault

public SoapFault(String message,
         QName faultCode)

SoapFault

public SoapFault(String message,
         ResourceBundle bundle,
         QName faultCode)

SoapFault

public SoapFault(String message,
         ResourceBundle bundle,
         Throwable t,
         QName faultCode)

SoapFault

public SoapFault(String message,
         ResourceBundle bundle,
         QName faultCode,
         Object... params)

SoapFault

public SoapFault(String message,
         Throwable t,
         QName faultCode)

Method Detail
- getCodeString
```
public String getCodeString(String prefix,
                   String defaultPrefix)
```
- getSubCodeString
```
public String getSubCodeString(String prefix,
                      String defaultPrefix)
```
- getReason
```
public String getReason()
```
- getRole
```
public String getRole()
```
  Returns the fault actor.
  
  Returns:
  the fault actor.
- setRole
```
public void setRole(String actor)
```
  Sets the fault actor.
  
  Parameters:
  actor - the actor.
- getNode
```
public String getNode()
```
- setNode
```
public void setNode(String n)
```
- getSubCode
```
public QName getSubCode()
```
  Returns the SubCode for the Fault Code. If there are more than one Subcode entries in this fault, the first Subcode is returned.
  
  Returns:
  The SubCode element as detailed by the SOAP 1.2 spec.
- getSubCodes
```
public List<QName> getSubCodes()
```
  Returns the SubCode list for the Fault Code.
  
  Returns:
  The SubCode element list as detailed by the SOAP 1.2 spec.
- setSubCode
```
public void setSubCode(QName subCode)
```
  Sets the SubCode for the Fault Code. If there are more than one Subcode entries in this fault, the first Subcode is set while the other entries are removed.
  
  Parameters:
  subCode - The SubCode element as detailed by the SOAP 1.2 spec.
- setSubCodes
```
public void setSubCodes(List<QName> subCodes)
```
  Sets the SubCode list for the Fault Code.
  
  Parameters:
  subCode - The SubCode element list as detailed by the SOAP 1.2 spec.
- addSubCode
```
public void addSubCode(QName subCode)
```
  Appends the SubCode to the SubCode list.
  
  Parameters:
  subCode - The SubCode element as detailed by the SOAP 1.2 spec.
- getNamespaces
```
public Map<String,String> getNamespaces()
```
- setNamespaces
```
public void setNamespaces(Map<String,String> namespaces)
```
- createFault
```
public static SoapFault createFault(Fault f,
                    SoapVersion v)
```

Class SoapFault

Field Summary

Fields inherited from class org.apache.cxf.interceptor.Fault

Fields inherited from class org.apache.cxf.common.i18n.UncheckedException

Constructor Summary

Method Summary

Methods inherited from class org.apache.cxf.interceptor.Fault

Methods inherited from class org.apache.cxf.common.i18n.UncheckedException

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Field Detail

ATTACHMENT_IO

Constructor Detail

SoapFault

SoapFault

SoapFault

SoapFault

SoapFault

SoapFault

SoapFault

Method Detail

getCodeString

getSubCodeString

getReason

getRole

setRole

getNode

setNode

getSubCode

getSubCodes

setSubCode

setSubCodes

addSubCode

getNamespaces

setNamespaces

createFault