public class TdbException
extends java.lang.Exception
Modifier and Type | Field and Description |
---|---|
static int |
COMMUNICATIONS_ERROR
Communications failure talking to the server
|
static int |
END_OF_DATA
When iterating through a collection, the end of the collection has been reached.
|
static int |
GENERAL_ERROR
Unspecified error in operation.
|
static int |
INVALID_ARGS
Programmer error, invalid arguments provided to a method call.
|
static int |
NO_LICENSE
TRIPjxp is not licensed for use.
|
static int |
NOT_LOGGED_IN
No user has logged in to the session yet.
|
static int |
NOT_SUPPORTED
The method or property is not supported for the class on which it was invoked.
|
static int |
PARSER_ERROR
XML structure error
|
static int |
TIMEOUT
The functionality or data being accessed is no longer available due to timeout.
|
static int |
TRANSACTION_CANCELLED
Xml transaction was cancelled.
|
static int |
UNEXPECTED_RESPONSE
The server sent back an XML response of an unexpected type
|
static int |
UNEXPECTED_STATE
The system is in an unexpected state, potentially due to an error in the server
|
static int |
UNUSABLE_SESSION
Attempt to use an object with a session of an incompatible type, for example
attempting to use grid objects on a TRIPnet connection
|
static int |
VALIDATION_ERROR
Provided data could not be validated.
|
Constructor and Description |
---|
TdbException(int code)
Constructor
|
TdbException(int code,
java.lang.String msg)
Constructor
|
TdbException(int code,
java.lang.Throwable cause)
Constructor
|
TdbException(int code,
java.lang.Throwable cause,
java.lang.String arg)
Constructor
|
TdbException(int code,
java.lang.Throwable cause,
java.lang.String msg,
java.lang.String logexcerpt)
Constructor
|
TdbException(java.lang.String msg)
Constructor
|
TdbException(java.lang.String msg,
java.lang.Throwable cause)
Constructor
|
Modifier and Type | Method and Description |
---|---|
int |
getCode()
Retrieve the error code from the exception
|
java.lang.String |
getDebugMessage()
Retrieve a fully decorated error string; this contains the call stack
and all embedded exceptions (and their call stacks).
|
java.lang.String |
getLogExcerpt()
TRIPsystem API log excerpt related to the thrown exception.
|
java.lang.String |
getMessage()
Default message preparation
|
java.lang.String |
getSimpleMessage()
Retrieve an undecorated error string, i.e.
|
public static final int UNEXPECTED_STATE
public static final int COMMUNICATIONS_ERROR
public static final int UNEXPECTED_RESPONSE
public static final int PARSER_ERROR
public static final int UNUSABLE_SESSION
public static final int INVALID_ARGS
public static final int END_OF_DATA
public static final int VALIDATION_ERROR
public static final int NO_LICENSE
public static final int NOT_SUPPORTED
public static final int TIMEOUT
public static final int NOT_LOGGED_IN
public static final int TRANSACTION_CANCELLED
public static final int GENERAL_ERROR
public TdbException(int code)
code
- Error codepublic TdbException(int code, java.lang.Throwable cause)
code
- Error codecause
- Embedded exception, i.e. the exception that caused this
TdbException to be thrownpublic TdbException(int code, java.lang.Throwable cause, java.lang.String arg)
code
- Error codecause
- Embedded exception, i.e. the exception that caused this
TdbException to be thrownarg
- Optional argument, e.g. location datapublic TdbException(int code, java.lang.Throwable cause, java.lang.String msg, java.lang.String logexcerpt)
code
- Error codecause
- Embedded exception, i.e. the exception that caused this
TdbException to be thrownmsg
- Message to accompany error, typically TRIP-generatedlogexcerpt
- API log excerpt from TRIPsystem related to the thrown exceptionpublic TdbException(int code, java.lang.String msg)
code
- Error codemsg
- Message to accompany error, typically TRIP-generatedpublic TdbException(java.lang.String msg)
msg
- Error messagepublic TdbException(java.lang.String msg, java.lang.Throwable cause)
msg
- Error messagecause
- Embedded exception, i.e. the exception that caused this
TdbException to be thrownpublic int getCode()
public java.lang.String getSimpleMessage()
public java.lang.String getDebugMessage()
public java.lang.String getMessage()
getMessage
in class java.lang.Throwable
public java.lang.String getLogExcerpt()
If session-specific server-side API logging is enabled this property will contain an excerpt from the TRIPsystem API for the associated TRIPjxp call.