|
IBM DB2 Information Integrator Java API Reference for Developing Wrappers |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.db2.wrapper.WrapperUtilities
The WrapperUtilities class is a container for several static utility functions. Do not instantiate or subclass the WrapperUtilities class.
Field Summary | |
static int |
EXT_WRAPPERS_TRACE_COMPONENT
Trace component ID for wrappers not provided by IBM. |
Method Summary | |
static int |
getAppCBStatus()
Retrieve the status of the application control block. |
static java.lang.String |
getAuthid()
Retrieve the authorization ID for the current database. |
static int |
getCodepage()
Retrieve the current database code page. |
static java.lang.String |
getDB2InstallPath()
Retrieve the DB2 Universal Database installation path. |
static java.lang.String |
getDB2InstancePath()
Retrieve the DB2 Universal Database instance path. |
static int |
getDB2Release()
Get the DB2 Universal Database release and the fix pack that this wrapper is currently running under. |
static int |
getDoubleByteDBCodepage()
Retrieve the double-byte database code page. |
static int |
getIsolationLevel()
Retrieve the isolation level for the current database. |
static int |
getSingleByteDBCodepage()
Retrieve the single-byte database code page. |
static void |
reportWarning(int sqlCode,
java.lang.String funcName,
java.lang.String[] tokens)
Report a warning to the DB2 Information Integrator user. |
static boolean |
traceEnabled()
Verify whether the DB2 Information Integrator tracing is enabled. |
static void |
traceError(int funcID,
java.lang.String funcName,
int probe,
java.lang.String errorData)
Trace an error message. |
static void |
traceException(int funcID,
java.lang.String funcName,
int probe,
java.lang.Throwable exception)
Trace an exception and its call stack. |
static void |
traceFunctionData(int funcID,
java.lang.String funcName,
int probe,
java.lang.String data)
Trace function data using a single data trace parameter. |
static void |
traceFunctionData(int funcID,
java.lang.String funcName,
int probe,
java.lang.String data1,
java.lang.String data2)
Trace function data using two data trace parameters. |
static void |
traceFunctionData(int funcID,
java.lang.String funcName,
int probe,
java.lang.String data1,
java.lang.String data2,
java.lang.String data3)
Trace function data using three data trace parameters. |
static void |
traceFunctionEntry(int funcID,
java.lang.String funcName)
Trace a function entry. |
static void |
traceFunctionReturnCode(int funcID,
java.lang.String funcName,
int returnCode)
Trace a function return code. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int EXT_WRAPPERS_TRACE_COMPONENT
Method Detail |
public static final int getAppCBStatus()
public static final java.lang.String getAuthid() throws WrapperException
WrapperException
- if the operation fails.public static final int getCodepage()
public static final java.lang.String getDB2InstallPath() throws WrapperException
WrapperException
- if the operation fails.public static final java.lang.String getDB2InstancePath() throws WrapperException
WrapperException
- if the operation fails.public static final int getDB2Release()
public static final int getDoubleByteDBCodepage()
public static final int getIsolationLevel()
public static final int getSingleByteDBCodepage()
public static final void reportWarning(int sqlCode, java.lang.String funcName, java.lang.String[] tokens) throws WrapperException
sqlCode
- The predefined SQL code of the warning that is reported.funcName
- The name of the function that reports the warning.
The string cannot be greater than five characters.
The client program can access this string value through the
SQLERRP field of the SQLCA. The string value is in uppercase
letters with a prefix of SQL.tokens
- The substitution tokens for the message.
WrapperException
- if the operation fails.public static final boolean traceEnabled()
public static final void traceError(int funcID, java.lang.String funcName, int probe, java.lang.String errorData)
funcID
- The trace ID of the caller function.funcName
- The name of the caller function.probe
- The probe ID.errorData
- The error data to trace.public static final void traceException(int funcID, java.lang.String funcName, int probe, java.lang.Throwable exception)
funcID
- The trace ID of the caller function.funcName
- The name of the caller function.probe
- The probe ID.exception
- The exception to trace.public static final void traceFunctionData(int funcID, java.lang.String funcName, int probe, java.lang.String data)
funcID
- The trace ID of the caller function.funcName
- The name of the caller function.probe
- The probe ID.data
- The data to trace.public static final void traceFunctionData(int funcID, java.lang.String funcName, int probe, java.lang.String data1, java.lang.String data2)
funcID
- The trace ID of the caller function.funcName
- The name of the caller function.probe
- The probe ID.data1
- The first data to trace.data2
- The second data to trace.public static final void traceFunctionData(int funcID, java.lang.String funcName, int probe, java.lang.String data1, java.lang.String data2, java.lang.String data3)
funcID
- The trace ID of the caller function.funcName
- The name of the caller function.probe
- The probe ID.data1
- The first data to trace.data2
- The second data to trace.data3
- The third data to trace.public static final void traceFunctionEntry(int funcID, java.lang.String funcName)
funcID
- The trace ID of the caller function.funcName
- The name of the caller function.public static final void traceFunctionReturnCode(int funcID, java.lang.String funcName, int returnCode)
funcID
- The trace ID of the caller function.funcName
- The name of the caller function.returnCode
- The return code.
|
IBM DB2 Information Integrator Java API Reference for Developing Wrappers |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
(C)Copyright IBM Corp. 2002. All rights reserved.
Links on this page are made available for your convenience and may take you to non-IBM sites. IBM does not warrant any sample code provided on these sites.