oracle.jdbc.driver
Class OracleLog

java.lang.Object
  |
  +--oracle.jdbc.driver.OracleLog

public class OracleLog

extends java.lang.Object

Oracle Jdbc logging facility.

The Oracle Jdbc logging facility allows users to enable/disable logging and control log volume during run-time. If you are using the client-side drivers (ie. the JDBC OCI and JDBC Thin drivers), this facility is available only when running with the debug jar files. On the other hand, if you are using the server-side drivers, this facility is built in.

Field Summary

static int	CATEGORY_ALL
static int	CATEGORY_HIGH_VOL
static int	CATEGORY_LOW_VOL
static int	CATEGORY_MED_VOL
static int	CATEGORY_TOTAL
static java.lang.String[]	CategoryName
static int	DEBUG1
static int	DEBUG2
static int	ERROR
static int	FIELD_ALL
static int	FIELD_CATEGORY
static int	FIELD_DEFAULT
static int	FIELD_MODULE
static int	FIELD_NONE
static int	FIELD_NUMBER
static int	FIELD_OBJECT
static int	FIELD_SUBMOD
static int	FIELD_THREAD
static int	FIELD_TIME
static int	FUNCTION
static int	MASK_ALL_SET
static int	MAX_MODULES
static int	MAX_VECTOR_BITS
static int	MODULE_ALL
static int	MODULE_DATUM
static int	MODULE_DBACCESS
static int	MODULE_DBCONV
static int	MODULE_DRIVER
static int	MODULE_JOCI
static int	MODULE_JOLT
static int	MODULE_JPUB
static int	MODULE_JTTC
static int	MODULE_KPRB
static int	MODULE_PICKLE
static int	MODULE_SQLJ
static int	MODULE_TOTAL
static int	MODULE_XA
static java.lang.String[]	ModuleName
static boolean	PRIVATE_TRACE
static int	PROG_ERROR
static int	SQL_STR
static int	SUBMOD_ALL
static int	SUBMOD_DBAC_DATA
static int	SUBMOD_DEFAULT
static int	SUBMOD_DRVR_CONN
static int	SUBMOD_DRVR_ERR
static int	SUBMOD_DRVR_LOG
static int	SUBMOD_DRVR_POOL
static int	SUBMOD_DRVR_RSET
static int	SUBMOD_DRVR_RWST
static int	SUBMOD_DRVR_SCCH
static int	SUBMOD_DRVR_SQL
static int	SUBMOD_DRVR_STMT
static int	SUBMOD_DRVR_UTIL
static int	SUBMOD_JOCI_ACCS
static int	SUBMOD_JOCI_DSET
static int	SUBMOD_JOCI_ENV
static int	SUBMOD_JOCI_ITEM
static int	SUBMOD_JOCI_STMT
static int	SUBMOD_JOCI_TYPE
static int	SUBMOD_JOLT_BASE
static int	SUBMOD_JOLT_COMM
static int	SUBMOD_JOLT_JDBC
static int	SUBMOD_JPUB_RUNTIME
static int	SUBMOD_JTTC_ADTS
static int	SUBMOD_JTTC_BASE
static int	SUBMOD_JTTC_COMM
static int	SUBMOD_JTTC_CONN
static int	SUBMOD_JTTC_DBAC
static int	SUBMOD_JTTC_LOBS
static int	SUBMOD_JTTC_MARS
static int	SUBMOD_JTTC_RX
static int	SUBMOD_JTTC_TX
static int	SUBMOD_JTTC_UNMA
static int	SUBMOD_KPRB_CONN
static int	SUBMOD_KPRB_CONV
static int	SUBMOD_KPRB_DATA
static int	SUBMOD_KPRB_ERR
static int	SUBMOD_KPRB_RSET
static int	SUBMOD_KPRB_SQL
static int	SUBMOD_KPRB_STMT
static int	SUBMOD_KPRB_UTIL
static int	SUBMOD_PCKL_CONV
static int	SUBMOD_PCKL_DESC
static int	SUBMOD_PCKL_INIT
static int	SUBMOD_PCKL_PARS
static int	SUBMOD_PCKL_PCKL
static int	SUBMOD_PCKL_SERL
static int	SUBMOD_PCKL_TYPE
static int	SUBMOD_PCKL_UNPK
static int	SUBMOD_SQLJ_RUN
static int	SUBMOD_XA_ARGS
static int	SUBMOD_XA_CONN
static int	SUBMOD_XA_DSRC
static int	SUBMOD_XA_EXC
static int	SUBMOD_XA_HCCB
static int	SUBMOD_XA_HCON
static int	SUBMOD_XA_HRSC
static int	SUBMOD_XA_RSRC
static int	SUBMOD_XA_XID
static boolean	TRACE
static int	USER_OPER
static int	WARNING

Constructor Summary

OracleLog()

Method Summary

static void	enableWarning(boolean enable) Enable/disable warning messages.
static java.io.PrintStream	getLogStream() Get the logging PrintStream.
static java.io.PrintWriter	getLogWriter() Get the logging PrintWriter.
static boolean	isDebugZip() Check if the Oracle Jdbc zip/jar file being used has the logging facility avaliable.
static boolean	isEnabled() Check if logging is enabled.
static void	print(java.lang.Object thisObject, int module, int category, java.lang.String message)
static void	setLogStream(java.io.PrintStream out) Set the logging PrintStream.
static void	setLogVolume(int level) Set the logging volume level.
static void	setLogWriter(java.io.PrintWriter out) Set the logging PrintWriter.
static void	setPrivateTrace(boolean enable) Set the private tracing enable variable.
static void	setupFromSystemProperties() This method uses System.getProperty() to read properties to control logging.
static void	startLogging() Enable tracing.
static void	stopLogging() Disable tracing.

Methods inherited from class java.lang.Object

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

Field Detail

MASK_ALL_SET

public static final int MASK_ALL_SET

MAX_VECTOR_BITS

public static final int MAX_VECTOR_BITS

MAX_MODULES

public static final int MAX_MODULES

MODULE_ALL

public static final int MODULE_ALL

MODULE_DRIVER

public static final int MODULE_DRIVER

MODULE_DBACCESS

public static final int MODULE_DBACCESS

MODULE_DBCONV

public static final int MODULE_DBCONV

MODULE_JOLT

public static final int MODULE_JOLT

MODULE_PICKLE

public static final int MODULE_PICKLE

MODULE_JTTC

public static final int MODULE_JTTC

MODULE_DATUM

public static final int MODULE_DATUM

MODULE_KPRB

public static final int MODULE_KPRB

MODULE_XA

public static final int MODULE_XA

MODULE_SQLJ

public static final int MODULE_SQLJ

MODULE_JOCI

public static final int MODULE_JOCI

MODULE_JPUB

public static final int MODULE_JPUB

MODULE_TOTAL

public static final int MODULE_TOTAL

ModuleName

public static final java.lang.String[] ModuleName

SUBMOD_ALL

public static final int SUBMOD_ALL

SUBMOD_DEFAULT

public static final int SUBMOD_DEFAULT

SUBMOD_DRVR_LOG

public static final int SUBMOD_DRVR_LOG

SUBMOD_DRVR_ERR

public static final int SUBMOD_DRVR_ERR

SUBMOD_DRVR_CONN

public static final int SUBMOD_DRVR_CONN

SUBMOD_DRVR_STMT

public static final int SUBMOD_DRVR_STMT

SUBMOD_DRVR_RSET

public static final int SUBMOD_DRVR_RSET

SUBMOD_DRVR_UTIL

public static final int SUBMOD_DRVR_UTIL

SUBMOD_DRVR_SQL

public static final int SUBMOD_DRVR_SQL

SUBMOD_DRVR_RWST

public static final int SUBMOD_DRVR_RWST

SUBMOD_DRVR_POOL

public static final int SUBMOD_DRVR_POOL

SUBMOD_DRVR_SCCH

public static final int SUBMOD_DRVR_SCCH

SUBMOD_DBAC_DATA

public static final int SUBMOD_DBAC_DATA

SUBMOD_PCKL_INIT

public static final int SUBMOD_PCKL_INIT

SUBMOD_PCKL_TYPE

public static final int SUBMOD_PCKL_TYPE

SUBMOD_PCKL_PCKL

public static final int SUBMOD_PCKL_PCKL

SUBMOD_PCKL_UNPK

public static final int SUBMOD_PCKL_UNPK

SUBMOD_PCKL_CONV

public static final int SUBMOD_PCKL_CONV

SUBMOD_PCKL_DESC

public static final int SUBMOD_PCKL_DESC

SUBMOD_PCKL_PARS

public static final int SUBMOD_PCKL_PARS

SUBMOD_PCKL_SERL

public static final int SUBMOD_PCKL_SERL

SUBMOD_JOLT_COMM

public static final int SUBMOD_JOLT_COMM

SUBMOD_JOLT_BASE

public static final int SUBMOD_JOLT_BASE

SUBMOD_JOLT_JDBC

public static final int SUBMOD_JOLT_JDBC

SUBMOD_JTTC_BASE

public static final int SUBMOD_JTTC_BASE

SUBMOD_JTTC_TX

public static final int SUBMOD_JTTC_TX

SUBMOD_JTTC_RX

public static final int SUBMOD_JTTC_RX

SUBMOD_JTTC_MARS

public static final int SUBMOD_JTTC_MARS

SUBMOD_JTTC_UNMA

public static final int SUBMOD_JTTC_UNMA

SUBMOD_JTTC_CONN

public static final int SUBMOD_JTTC_CONN

SUBMOD_JTTC_COMM

public static final int SUBMOD_JTTC_COMM

SUBMOD_JTTC_DBAC

public static final int SUBMOD_JTTC_DBAC

SUBMOD_JTTC_LOBS

public static final int SUBMOD_JTTC_LOBS

SUBMOD_JTTC_ADTS

public static final int SUBMOD_JTTC_ADTS

SUBMOD_KPRB_ERR

public static final int SUBMOD_KPRB_ERR

SUBMOD_KPRB_CONN

public static final int SUBMOD_KPRB_CONN

SUBMOD_KPRB_STMT

public static final int SUBMOD_KPRB_STMT

SUBMOD_KPRB_RSET

public static final int SUBMOD_KPRB_RSET

SUBMOD_KPRB_UTIL

public static final int SUBMOD_KPRB_UTIL

SUBMOD_KPRB_SQL

public static final int SUBMOD_KPRB_SQL

SUBMOD_KPRB_DATA

public static final int SUBMOD_KPRB_DATA

SUBMOD_KPRB_CONV

public static final int SUBMOD_KPRB_CONV

SUBMOD_XA_DSRC

public static final int SUBMOD_XA_DSRC

SUBMOD_XA_CONN

public static final int SUBMOD_XA_CONN

SUBMOD_XA_RSRC

public static final int SUBMOD_XA_RSRC

SUBMOD_XA_ARGS

public static final int SUBMOD_XA_ARGS

SUBMOD_XA_EXC

public static final int SUBMOD_XA_EXC

SUBMOD_XA_XID

public static final int SUBMOD_XA_XID

SUBMOD_XA_HCON

public static final int SUBMOD_XA_HCON

SUBMOD_XA_HCCB

public static final int SUBMOD_XA_HCCB

SUBMOD_XA_HRSC

public static final int SUBMOD_XA_HRSC

SUBMOD_SQLJ_RUN

public static final int SUBMOD_SQLJ_RUN

SUBMOD_JOCI_ACCS

public static final int SUBMOD_JOCI_ACCS

SUBMOD_JOCI_DSET

public static final int SUBMOD_JOCI_DSET

SUBMOD_JOCI_ITEM

public static final int SUBMOD_JOCI_ITEM

SUBMOD_JOCI_STMT

public static final int SUBMOD_JOCI_STMT

SUBMOD_JOCI_TYPE

public static final int SUBMOD_JOCI_TYPE

SUBMOD_JOCI_ENV

public static final int SUBMOD_JOCI_ENV

SUBMOD_JPUB_RUNTIME

public static final int SUBMOD_JPUB_RUNTIME

CATEGORY_ALL

public static final int CATEGORY_ALL

USER_OPER

public static final int USER_OPER

PROG_ERROR

public static final int PROG_ERROR

ERROR

public static final int ERROR

WARNING

public static final int WARNING

FUNCTION

public static final int FUNCTION

DEBUG1

public static final int DEBUG1

DEBUG2

public static final int DEBUG2

SQL_STR

public static final int SQL_STR

CATEGORY_TOTAL

public static final int CATEGORY_TOTAL

CategoryName

public static final java.lang.String[] CategoryName

CATEGORY_LOW_VOL

public static final int CATEGORY_LOW_VOL

CATEGORY_MED_VOL

public static final int CATEGORY_MED_VOL

CATEGORY_HIGH_VOL

public static final int CATEGORY_HIGH_VOL

FIELD_NONE

public static final int FIELD_NONE

FIELD_ALL

public static final int FIELD_ALL

FIELD_NUMBER

public static final int FIELD_NUMBER

FIELD_TIME

public static final int FIELD_TIME

FIELD_MODULE

public static final int FIELD_MODULE

FIELD_SUBMOD

public static final int FIELD_SUBMOD

FIELD_CATEGORY

public static final int FIELD_CATEGORY

FIELD_OBJECT

public static final int FIELD_OBJECT

FIELD_THREAD

public static final int FIELD_THREAD

FIELD_DEFAULT

public static final int FIELD_DEFAULT

TRACE

public static boolean TRACE

PRIVATE_TRACE

public static boolean PRIVATE_TRACE

Constructor Detail

OracleLog

public OracleLog()

Method Detail

isDebugZip

public static boolean isDebugZip()

Check if the Oracle Jdbc zip/jar file being used has the logging facility avaliable. Note that the logging facility is only available in the debug zip/jar files.

Returns:

true if a debug zip/jar file is being used, or false if not.

isEnabled

public static boolean isEnabled()

Check if logging is enabled.

Returns:

true if logging is enabled, or false if not.

setLogWriter

public static void setLogWriter(java.io.PrintWriter out)

Set the logging PrintWriter.

This method is also used to enable and disable logging. Logging can only be enabled if a debug zip/jar file is being used.

Parameters:

out - PrintWriter object (use null to disable logging).

getLogWriter

public static java.io.PrintWriter getLogWriter()

Get the logging PrintWriter.

Returns:

the logging PrintWriter, or null if logging is disabled.

setLogStream

public static void setLogStream(java.io.PrintStream out)

Set the logging PrintStream. This method is also used to enable and disable logging.

Parameters:

out - PrintStream (use null to disable logging).

getLogStream

public static java.io.PrintStream getLogStream()

Get the logging PrintStream.

Returns:

the logging PrintStream, or null if logging is disabled.

enableWarning

public static void enableWarning(boolean enable)

Enable/disable warning messages.

Parameters:

enable - use 'true' to enable warning messages, or 'false' to disable. The default is 'true'.

setLogVolume

public static void setLogVolume(int level)

Set the logging volume level. This method is used to control the amount of information beging logged when tracing is enabled.

Parameters:

level - specifies one of the volume levels: 1 - low, 2 - medium, 3 - high.

startLogging

public static void startLogging()

Enable tracing. Tracing information is sent to System.out.

Since:

9.0

stopLogging

public static void stopLogging()

Disable tracing.

Since:

9.0

setPrivateTrace

public static void setPrivateTrace(boolean enable)

Set the private tracing enable variable.

setupFromSystemProperties

public static void setupFromSystemProperties()

This method uses System.getProperty() to read properties to control logging. Properties are not available in an applet environment or whenver security setting prevent it.

print

public static void print(java.lang.Object thisObject,
                         int module,
                         int category,
                         java.lang.String message)