Package org.cdlib.mrt.utility

Class TRuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.cdlib.mrt.utility.TRuntimeException

All Implemented Interfaces:

Serializable, StateInf

Direct Known Subclasses:

TRuntimeException.CONCURRENT_UPDATE, TRuntimeException.EXTERNAL_SERVICE_UNAVAILABLE, TRuntimeException.FIXITY_CHECK_FAILS, TRuntimeException.GENERAL_EXCEPTION, TRuntimeException.INVALID_ARCHITECTURE, TRuntimeException.INVALID_CONFIGURATION, TRuntimeException.INVALID_DATA_FORMAT, TRuntimeException.INVALID_OR_MISSING_PARM, TRuntimeException.LOCKING_ERROR, TRuntimeException.REQUEST_ELEMENT_UNSUPPORTED, TRuntimeException.REQUEST_INVALID, TRuntimeException.REQUEST_ITEM_EXISTS, TRuntimeException.REQUESTED_ITEM_NOT_FOUND, TRuntimeException.SQL_EXCEPTION, TRuntimeException.UNIMPLEMENTED_CODE, TRuntimeException.USER_NOT_AUTHENTICATED, TRuntimeException.USER_NOT_AUTHORIZED

public class TRuntimeException
extends RuntimeException
implements StateInf

mrt Exception

Author:

dloy

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TRuntimeException.CONCURRENT_UPDATE	CONCURRENT_UPDATE subclass See TExceptionEnum value for description
static class	TRuntimeException.EXTERNAL_SERVICE_UNAVAILABLE	EXTERNAL_SERVICE_UNAVAILABLE subclass See TExceptionEnum value for description
static class	TRuntimeException.FIXITY_CHECK_FAILS	FIXITY_CHECK_FAILS subclass See TExceptionEnum value for description
static class	TRuntimeException.GENERAL_EXCEPTION	GENERAL_EXCEPTION subclass See TExceptionEnum value for description
static class	TRuntimeException.INVALID_ARCHITECTURE	INVALID_ARCHITECTURE subclass See TExceptionEnum value for description
static class	TRuntimeException.INVALID_CONFIGURATION	INVALID_CONFIGURATION subclass See TExceptionEnum value for description
static class	TRuntimeException.INVALID_DATA_FORMAT	INVALID_DATA_FORMAT subclass See TExceptionEnum value for description
static class	TRuntimeException.INVALID_OR_MISSING_PARM	INVALID_OR_MISSING_PARM subclass See TExceptionEnum value for description
static class	TRuntimeException.LOCKING_ERROR	LOCKING_ERROR subclass See TExceptionEnum value for description
static class	TRuntimeException.REQUEST_ELEMENT_UNSUPPORTED	REQUEST_ELEMENT_UNSUPPORTED subclass See TExceptionEnum value for description
static class	TRuntimeException.REQUEST_INVALID	REQUEST_INVALID subclass See TExceptionEnum value for description
static class	TRuntimeException.REQUEST_ITEM_EXISTS	REQUEST_ITEM_EXISTS subclass See TExceptionEnum value for description
static class	TRuntimeException.REQUESTED_ITEM_NOT_FOUND	REQUESTED_ITEM_NOT_FOUND subclass See TExceptionEnum value for description
static class	TRuntimeException.SQL_EXCEPTION	SQL_EXCEPTION subclass See TExceptionEnum value for description
static class	TRuntimeException.UNIMPLEMENTED_CODE	UNIMPLEMENTED_CODE subclass See TExceptionEnum value for description
static class	TRuntimeException.USER_NOT_AUTHENTICATED	USER_NOT_AUTHENTICATED subclass See TExceptionEnum value for description
static class	TRuntimeException.USER_NOT_AUTHORIZED	USER_NOT_AUTHORIZED subclass See TExceptionEnum value for description

Field Summary

Fields

Modifier and Type	Field	Description
protected String	detail
protected Exception	remoteException
protected TExceptionEnum	status

Constructor Summary

Constructors

Constructor	Description
TRuntimeException(TExceptionEnum status, Exception ex)	The constructor set the status code and no message
TRuntimeException(TExceptionEnum status, String msg)	This constuctor sets the message and status code associated with this exception.
TRuntimeException(TExceptionEnum status, String msg, Exception ex)	The constructor set the status code and no message

Method Summary

Modifier and Type	Method	Description
protected String	dump(String header)
String	getClassName()	Return name of class where this exception occurred
String	getDescription()	get a String message associated with the MExceptionEnum.-- non-static version
static String	getDescription(TExceptionEnum mnemonic)	get a String message associated with an integer mnemonic code
String	getDetail()	get the String detail message, more information on an error
String	getError()	return the description
int	getHTTPResponse()	return the status description
int	getLineNumber()	program code line number for this exception
String	getLocation()	location of exception
String	getMethodName()	Return name of method where exception occurred
Exception	getRemoteException()	Return any remote exception stored as part of creating TException
TExceptionEnum	getStatus()	return the status code
String	getStatusDescription()	return the status description
String	getStatusName()	value of status
String	getTrace()	return the stack trace
void	setDetail(String detail)	set the String detail message to give more information on an error
protected void	setTException(TExceptionEnum status, String msg, Exception ex)
String	toString()	toString returns this exception as a string

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

status

protected TExceptionEnum status

remoteException

protected Exception remoteException

detail

protected String detail

Constructor Details

TRuntimeException

public TRuntimeException(TExceptionEnum status,
 Exception ex)

The constructor set the status code and no message

Parameters:

status - - the int status code associated with this exception

TRuntimeException

public TRuntimeException(TExceptionEnum status,
 String msg)

This constuctor sets the message and status code associated with this exception.

Parameters:

status - - the int status code

msg - - the String message

TRuntimeException

public TRuntimeException(TExceptionEnum status,
 String msg,
 Exception ex)

The constructor set the status code and no message

Parameters:

msg - - the String message

status - - the int status code associated with this exception

Method Details

setTException

protected void setTException(TExceptionEnum status,
 String msg,
 Exception ex)

getStatus

public TExceptionEnum getStatus()

return the status code

getRemoteException

public Exception getRemoteException()

Return any remote exception stored as part of creating TException

Returns:

remote exception

getClassName

public String getClassName()

Return name of class where this exception occurred

Returns:

exception originating exception

getMethodName

public String getMethodName()

Return name of method where exception occurred

Returns:

originating name of method for this exception

getLineNumber

public int getLineNumber()

program code line number for this exception

Returns:

program line number

getStatusName

public String getStatusName()

value of status

getStatusDescription

public String getStatusDescription()

return the status description

getHTTPResponse

public int getHTTPResponse()

return the status description

getError

public String getError()

return the description

getTrace

public String getTrace()

return the stack trace

getLocation

public String getLocation()

location of exception

Returns:

exception location

toString

public String toString()

toString returns this exception as a string

Overrides:

toString in class Throwable

Returns:

the status and message

getDescription

public static String getDescription(TExceptionEnum mnemonic)

get a String message associated with an integer mnemonic code

Parameters:

int - mnemonic integer associated with exception

Returns:

String message from messages Hashtable

getDescription

public String getDescription()

get a String message associated with the MExceptionEnum.-- non-static version

Returns:

String message from messages Hashtable

setDetail

public void setDetail(String detail)

set the String detail message to give more information on an error

Parameters:

String - detail message

getDetail

public String getDetail()

get the String detail message, more information on an error

Returns:

String detail message

dump

protected String dump(String header)