oracle.ifs.fdk

Class FdkExceptionMapper

java.lang.Object

oracle.ifs.fdk.FdkExceptionMapper

public class FdkExceptionMapper
extends Object

Utility class that maps any Throwable to an FdkException.

Constructor Summary

Constructors

Constructor and Description
FdkExceptionMapper(Throwable cause) Constructor.

Method Summary

Modifier and Type	Method and Description
Throwable	getCause() Returns the cause exception.
String	getDetailedErrorCode() Returns the mapped error code.
FdkExceptionEntry[]	getEntries() Returns the exception entries if the cause exception was an aggregate exception.
String	getErrorCode() Returns the mapped error code.
Map	getInfo() Returns the additional information extracted from the cause exception.
Throwable	getMappedException() Returns the actual Throwable that the error code was mapped from.
boolean	isSevere() Returns true if the mapper decides the cause is a severe error from which the client cannot recover.
static String	toMainErrorCode(String detailedErrorCode) Maps a detailed error code to a main error code.

Methods inherited from class java.lang.Object

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

Constructor Detail

FdkExceptionMapper

public FdkExceptionMapper(Throwable cause)

Constructor.

Parameters:

cause - The Throwable to map.

Method Detail

toMainErrorCode

public static String toMainErrorCode(String detailedErrorCode)

Maps a detailed error code to a main error code.

Parameters:

detailedErrorCode - The detailed error code to map to a main error code.

getErrorCode

public String getErrorCode()

Returns the mapped error code.

Returns:

the error code

getDetailedErrorCode

public String getDetailedErrorCode()

Returns the mapped error code.

Returns:

the detailed error code

getCause

public Throwable getCause()

Returns the cause exception. In general the return value is the cause exception passed in the constructors, but there may be cases where another nested exception could be more useful to be considered the cause exception.

getMappedException

public Throwable getMappedException()

Returns the actual Throwable that the error code was mapped from. This is useful when the mapper uses any nested exceptions to determine an error code. IfsException is one common occurence.

getInfo

public Map getInfo()

Returns the additional information extracted from the cause exception. Can return null.

getEntries

public FdkExceptionEntry[] getEntries()

Returns the exception entries if the cause exception was an aggregate exception.

isSevere

public boolean isSevere()

Returns true if the mapper decides the cause is a severe error from which the client cannot recover. An example of a severe error is "Database Down". On the other hand "Permission Denied" is not a severe error.