|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Throwable
java.lang.Exception
org.codehaus.xfire.XFireException
org.codehaus.xfire.fault.XFireFault
public class XFireFault
In XFire, applications throw their own declared exceptions which are then turned into faults. The
XFireFault
class wraps these exceptions extracting out the details for the fault message.
Field Summary | |
---|---|
static java.lang.String |
DATA_ENCODING_UNKNOWN
|
static java.lang.String |
MUST_UNDERSTAND
|
static java.lang.String |
RECEIVER
A SOAP 1.2 only fault code. |
static java.lang.String |
SENDER
"The message was incorrectly formed or did not contain the appropriate information in order to succeed." -- SOAP 1.2 Spec |
static java.lang.String |
VERSION_MISMATCH
Fault codes. |
Constructor Summary | |
---|---|
protected |
XFireFault()
|
|
XFireFault(java.lang.String message,
java.lang.String code)
Create an exception wih the specified fault message and faultCode. |
|
XFireFault(java.lang.String message,
java.lang.Throwable cause,
java.lang.String code)
Create a fault. |
|
XFireFault(java.lang.Throwable throwable)
Create a fault for the specified exception. |
|
XFireFault(java.lang.Throwable throwable,
java.lang.String code)
Create a fault with the specified faultCode. |
Method Summary | |
---|---|
void |
addNamespace(java.lang.String prefix,
java.lang.String ns)
Adds a namespace with prefix to this fault. |
static XFireFault |
createFault(java.lang.Throwable throwable)
Creates a XFireFault from the given throwable. |
java.lang.Throwable |
getCause()
Returns the cause of this throwable or null if the cause is nonexistent or unknown. |
org.codehaus.yom.Element |
getDetail()
Returns the detail node. |
java.lang.String |
getFaultCode()
Returns the fault code of this fault. |
java.lang.String |
getMessage()
Returns the detail message string of this fault. |
java.util.Map |
getNamespaces()
User defined namespaces which will be written out on the resultant SOAP Fault (for use easy with SubCodes and Detail) elements. |
java.lang.String |
getReason()
|
java.lang.String |
getRole()
Returns the fault actor. |
java.lang.String |
getSubCode()
Returns the SubCode for the Fault Code. |
boolean |
hasDetails()
Indicates whether this fault has a detail message. |
void |
printStackTrace(java.io.PrintStream s)
Prints this throwable and its backtrace to the specified print stream. |
void |
printStackTrace(java.io.PrintWriter w)
Prints this throwable and its backtrace to the specified print writer. |
void |
setDetail(org.codehaus.yom.Element details)
Sets a details Node on this fault. |
void |
setFaultCode(java.lang.String faultCode)
Sets the fault code of this fault. |
void |
setMessage(java.lang.String message)
|
void |
setRole(java.lang.String actor)
Sets the fault actor. |
void |
setSubCode(java.lang.String subCode)
Sets the SubCode for the Fault Code. |
Methods inherited from class java.lang.Throwable |
---|
fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, printStackTrace, setStackTrace, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String VERSION_MISMATCH
public static final java.lang.String MUST_UNDERSTAND
public static final java.lang.String DATA_ENCODING_UNKNOWN
public static final java.lang.String SENDER
public static final java.lang.String RECEIVER
Constructor Detail |
---|
protected XFireFault()
public XFireFault(java.lang.Throwable throwable)
throwable
- public XFireFault(java.lang.Throwable throwable, java.lang.String code)
throwable
- The exception that caused this fault.code
- The fault code. See XFireFault's static fields.public XFireFault(java.lang.String message, java.lang.String code)
message
- The fault message.code
- The fault code. See XFireFault's static fields.public XFireFault(java.lang.String message, java.lang.Throwable cause, java.lang.String code)
cause
- The exception which caused this fault.code
- The fault code. See XFireFault's static fields.Method Detail |
---|
public static XFireFault createFault(java.lang.Throwable throwable)
XFireFault
from the given throwable. If the throwable is a XFireFault
, it is
not wrapped.
throwable
- the throwable
public void addNamespace(java.lang.String prefix, java.lang.String ns)
prefix
- the prefixns
- the namespace.public void printStackTrace(java.io.PrintStream s)
printStackTrace
in class java.lang.Throwable
s
- PrintStream
to use for outputpublic void printStackTrace(java.io.PrintWriter w)
printStackTrace
in class java.lang.Throwable
w
- PrintWriter
to use for outputpublic java.lang.Throwable getCause()
null
if the cause is nonexistent or unknown.
getCause
in class java.lang.Throwable
public org.codehaus.yom.Element getDetail()
<detail>
is created.
public void setDetail(org.codehaus.yom.Element details)
Node
on this fault.
details
- the detail node.public java.lang.String getFaultCode()
public void setFaultCode(java.lang.String faultCode)
faultCode
- the fault code.public java.lang.String getMessage()
getMessage
in class java.lang.Throwable
XfireFault
(which may be null
)public void setMessage(java.lang.String message)
message
- The message to set.public java.util.Map getNamespaces()
public java.lang.String getReason()
public java.lang.String getRole()
public void setRole(java.lang.String actor)
actor
- the actor.public java.lang.String getSubCode()
public void setSubCode(java.lang.String subCode)
subCode
- The SubCode element as detailed by the SOAP 1.2 spec.public boolean hasDetails()
true
if this fault has a detail message; false
otherwise.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |