Package com.softwareag.entirex.aci

Class BrokerException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.softwareag.entirex.aci.BrokerException

All Implemented Interfaces:

Serializable

public class BrokerException
extends Exception

Exception class thrown by EntireX Java ACI/RPC classes.
Use toString() to retrieve the error message including the error class and error code.
Use getMessage() to retrieve the error message only.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
int	getErrorClass()	Returns the error class part of the Broker error.
int	getErrorCode()	Returns the error code part of the Broker error.
String	getErrorDetail()	Gets the error detail text.
String	getErrorInfo()	Returns additional information from the Broker call which caused the error.
String	toString()	Overrides the toString method.

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

Method Details

getErrorClass

public int getErrorClass()

Returns the error class part of the Broker error.

Returns:

Broker error class as int.

getErrorCode

public int getErrorCode()

Returns the error code part of the Broker error.

Returns:

Broker error code as int.

getErrorInfo

public String getErrorInfo()

Returns additional information from the Broker call which caused the error.
If this is an error returned from EntireX Broker, the trace information for the Broker call and its result values are returned. This information is available only when tracing is enabled. Errors which are detected by Java ACI return null.

Returns:

Trace information (if tracing is enabled) for the Broker call which caused the error.

toString

public String toString()

Overrides the toString method.

Overrides:

toString in class Throwable

Returns:

A complete error message including error class and error code.

getErrorDetail

public String getErrorDetail()

Gets the error detail text.

Returns:

the error detail text.