Package com.tietoenator.trip.jxp
Class TdbException
java.lang.Object
java.lang.Throwable
java.lang.Exception
com.tietoenator.trip.jxp.TdbException
- All Implemented Interfaces:
Serializable
All exceptions thrown by this class library conform to this type. An exception
may well have one or more other exceptions contained within it.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Communications failure talking to the serverstatic final int
When iterating through a collection, the end of the collection has been reached.static final int
Unspecified error in operation.static final int
Programmer error, invalid arguments provided to a method call.static final int
TRIPjxp is not licensed for use.static final int
No user has logged in to the session yet.static final int
The method or property is not supported for the class on which it was invoked.static final int
XML structure errorstatic final int
The functionality or data being accessed is no longer available due to timeout.static final int
Xml transaction was cancelled.static final int
The server sent back an XML response of an unexpected typestatic final int
The system is in an unexpected state, potentially due to an error in the serverstatic final int
Attempt to use an object with a session of an incompatible type, for example attempting to use grid objects on a TRIPnet connectionstatic final int
Provided data could not be validated. -
Constructor Summary
ConstructorsConstructorDescriptionTdbException
(int code) ConstructorTdbException
(int code, String msg) ConstructorTdbException
(int code, Throwable cause) ConstructorTdbException
(int code, Throwable cause, String arg) ConstructorTdbException
(int code, Throwable cause, String msg, String logexcerpt) ConstructorTdbException
(String msg) ConstructorTdbException
(String msg, Throwable cause) Constructor -
Method Summary
Modifier and TypeMethodDescriptionint
getCode()
Retrieve the error code from the exceptionRetrieve a fully decorated error string; this contains the call stack and all embedded exceptions (and their call stacks).TRIPsystem API log excerpt related to the thrown exception.Default message preparationRetrieve an undecorated error string, i.e.Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
Field Details
-
UNEXPECTED_STATE
public static final int UNEXPECTED_STATEThe system is in an unexpected state, potentially due to an error in the server- See Also:
-
COMMUNICATIONS_ERROR
public static final int COMMUNICATIONS_ERRORCommunications failure talking to the server- See Also:
-
UNEXPECTED_RESPONSE
public static final int UNEXPECTED_RESPONSEThe server sent back an XML response of an unexpected type- See Also:
-
PARSER_ERROR
public static final int PARSER_ERRORXML structure error- See Also:
-
UNUSABLE_SESSION
public static final int UNUSABLE_SESSIONAttempt to use an object with a session of an incompatible type, for example attempting to use grid objects on a TRIPnet connection- See Also:
-
INVALID_ARGS
public static final int INVALID_ARGSProgrammer error, invalid arguments provided to a method call.- See Also:
-
END_OF_DATA
public static final int END_OF_DATAWhen iterating through a collection, the end of the collection has been reached.- See Also:
-
VALIDATION_ERROR
public static final int VALIDATION_ERRORProvided data could not be validated.- See Also:
-
NO_LICENSE
public static final int NO_LICENSETRIPjxp is not licensed for use.- See Also:
-
NOT_SUPPORTED
public static final int NOT_SUPPORTEDThe method or property is not supported for the class on which it was invoked.- See Also:
-
TIMEOUT
public static final int TIMEOUTThe functionality or data being accessed is no longer available due to timeout.- See Also:
-
NOT_LOGGED_IN
public static final int NOT_LOGGED_INNo user has logged in to the session yet.- See Also:
-
TRANSACTION_CANCELLED
public static final int TRANSACTION_CANCELLEDXml transaction was cancelled.- See Also:
-
GENERAL_ERROR
public static final int GENERAL_ERRORUnspecified error in operation.- See Also:
-
-
Constructor Details
-
TdbException
public TdbException(int code) Constructor- Parameters:
code
- Error code
-
TdbException
Constructor- Parameters:
code
- Error codecause
- Embedded exception, i.e. the exception that caused this TdbException to be thrown
-
TdbException
Constructor- Parameters:
code
- Error codecause
- Embedded exception, i.e. the exception that caused this TdbException to be thrownarg
- Optional argument, e.g. location data
-
TdbException
Constructor- Parameters:
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 exception
-
TdbException
Constructor- Parameters:
code
- Error codemsg
- Message to accompany error, typically TRIP-generated
-
TdbException
Constructor- Parameters:
msg
- Error message
-
TdbException
Constructor- Parameters:
msg
- Error messagecause
- Embedded exception, i.e. the exception that caused this TdbException to be thrown
-
-
Method Details
-
getCode
public int getCode()Retrieve the error code from the exception- Returns:
- The error code
-
getSimpleMessage
Retrieve an undecorated error string, i.e. no call stacks.- Returns:
- The undecorated error string.
-
getDebugMessage
Retrieve a fully decorated error string; this contains the call stack and all embedded exceptions (and their call stacks). This is useful for producing a string for transmission to clients in a single call.- Returns:
- The fully decorated error string
-
getMessage
Default message preparation- Overrides:
getMessage
in classThrowable
- Returns:
- An undecorated error string
-
getLogExcerpt
TRIPsystem API log excerpt related to the thrown exception.If session-specific server-side API logging is enabled this property will contain an excerpt from the TRIPsystem API for the associated TRIPjxp call.
- Returns:
- API log excerpt, or an empty string if none is available.
-