com.collabnet.core.ws.exception
Class WSException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.io.IOException
              java.rmi.RemoteException
                  org.apache.axis.AxisFault
                      com.collabnet.core.ws.exception.WSException

All Implemented Interfaces:

java.io.Serializable

public class WSException
extends org.apache.axis.AxisFault
implements java.io.Serializable

WSException is a generic exception thrown by webservices if an error occurs. This exception class provides information about the underlying cause, permitting client code to determine what remedy if any to take. Server webservices should construct WSExceptions using the com.collabnet.core.ws.util.WSUtil utility class.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.rmi.RemoteException

detail

Constructor Summary

WSException()

WSException(java.lang.String causeExceptionType, java.lang.String stackTraceString, java.lang.String errorMessage, int code)

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getCauseExceptionType() Gets the causeExceptionType value for this WSException.
int	getCode() Gets the code value for this WSException.
static org.apache.axis.encoding.Deserializer	getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Get Custom Deserializer
java.lang.String	getErrorMessage() Gets the errorMessage value for this WSException.
static org.apache.axis.encoding.Serializer	getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Get Custom Serializer
java.lang.String	getStackTraceString() Gets the stackTraceString value for this WSException.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setCauseExceptionType(java.lang.String causeExceptionType) Sets the causeExceptionType value for this WSException.
void	setCode(int code) Sets the code value for this WSException.
void	setErrorMessage(java.lang.String errorMessage) Sets the errorMessage value for this WSException.
void	setStackTraceString(java.lang.String stackTraceString) Sets the stackTraceString value for this WSException.
void	writeDetails(javax.xml.namespace.QName qname, org.apache.axis.encoding.SerializationContext context) Writes the exception data to the faultDetails

Methods inherited from class org.apache.axis.AxisFault

addFaultDetail, addFaultDetail, addFaultDetailString, addFaultSubCode, addFaultSubCodeAsString, addHeader, addHostname, addHostnameIfNeeded, clearFaultDetails, clearFaultSubCodes, clearHeaders, dump, dumpToString, getFaultActor, getFaultCode, getFaultDetails, getFaultNode, getFaultReason, getFaultRole, getFaultString, getFaultSubCodes, getHeaders, lookupFaultDetail, makeFault, output, printStackTrace, printStackTrace, removeFaultDetail, removeHostname, setFaultActor, setFaultCode, setFaultCode, setFaultCodeAsString, setFaultDetail, setFaultDetailString, setFaultNode, setFaultReason, setFaultRole, setFaultString, toString

Methods inherited from class java.rmi.RemoteException

getCause, getMessage

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WSException

public WSException()

WSException

public WSException(java.lang.String causeExceptionType,
                   java.lang.String stackTraceString,
                   java.lang.String errorMessage,
                   int code)

Method Detail

getCauseExceptionType

public java.lang.String getCauseExceptionType()

Gets the causeExceptionType value for this WSException.

Returns:

causeExceptionType * The fully qualified classname (Java) of the underlying exception.

setCauseExceptionType

public void setCauseExceptionType(java.lang.String causeExceptionType)

Sets the causeExceptionType value for this WSException.

Parameters:

causeExceptionType - * The fully qualified classname (Java) of the underlying exception.

getStackTraceString

public java.lang.String getStackTraceString()

Gets the stackTraceString value for this WSException.

Returns:

stackTraceString * The stacktrace as string. Useful for debugging.

setStackTraceString

public void setStackTraceString(java.lang.String stackTraceString)

Sets the stackTraceString value for this WSException.

Parameters:

stackTraceString - * The stacktrace as string. Useful for debugging.

getErrorMessage

public java.lang.String getErrorMessage()

Gets the errorMessage value for this WSException.

Returns:

errorMessage * The error message.

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)

Sets the errorMessage value for this WSException.

Parameters:

errorMessage - * The error message.

getCode

public int getCode()

Gets the code value for this WSException.

Returns:

code * The error code.

setCode

public void setCode(int code)

Sets the code value for this WSException.

Parameters:

code - * The error code.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType,
                                                                java.lang.Class _javaType,
                                                                javax.xml.namespace.QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType,
                                                                    java.lang.Class _javaType,
                                                                    javax.xml.namespace.QName _xmlType)

Get Custom Deserializer

writeDetails

public void writeDetails(javax.xml.namespace.QName qname,
                         org.apache.axis.encoding.SerializationContext context)
                  throws java.io.IOException

Writes the exception data to the faultDetails

Overrides:

writeDetails in class org.apache.axis.AxisFault

Throws:

java.io.IOException