Package PLOG

package name : PLOG

See : http://log4plsql.sourceforge.net

Objectif : Generic tool of log in a Oracle database same prototype and functionality that log4j. http://jakarta.apache.org/log4j


for exemple and documentation See: http://log4plsql.sourceforge.net/docs/UserGuide.html Default table of log level 1 The OFF has the highest possible rank and is intended to turn off logging.
2 The FATAL level designates very severe error events that will presumably lead the application to abort.
3 The ERROR level designates error events that might still allow the application to continue running.
4 The WARN level designates potentially harmful situations.
5 The INFO level designates informational messages that highlight the progress of the application at coarse-grained level.
6 The DEBUG Level designates fine-grained informational events that are most useful to debug an application.
7 The ALL has the lowest possible rank and is intended to turn on all logging.




All data is store in TLOG table
ID number,
LDate DATE default sysdate,
LHSECS number,
LLEVEL number,
LSECTION varchar2(2000),
LTEXTE varchar2(2000),
LUSER VARCHAR2(30),
CONSTRAINT pk_TLOG PRIMARY KEY (id)

NOLEVEL

  public NUMBER NOLEVEL

-----------------------------------------------------------------

DEFAULTEXTMESS

  public VARCHAR2(20) DEFAULTEXTMESS

LOFF

  public NUMBER LOFF

The OFF has the highest possible rank and is intended to turn off logging.

LFATAL

  public NUMBER LFATAL

The FATAL level designates very severe error events that will presumably lead the application to abort.

LERROR

  public NUMBER LERROR

The ERROR level designates error events that might still allow the application to continue running.

LWARN

  public NUMBER LWARN

The WARN level designates potentially harmful situations.

LINFO

  public NUMBER LINFO

The INFO level designates informational messages that highlight the progress of the application at coarse-grained level.

LDEBUG

  public NUMBER LDEBUG

The DEBUG Level designates fine-grained informational events that are most useful to debug an application.

LALL

  public NUMBER LALL

The ALL has the lowest possible rank and is intended to turn on all logging.

ERR_CODE_DBMS_PIPE

  public NUMBER ERR_CODE_DBMS_PIPE

raise constante

MES_CODE_DBMS_PIPE

  public VARCHAR2(100) MES_CODE_DBMS_PIPE

DEBUG

  public  DEBUG(ptexte TLOG.LTEXTE%TYPE)

For use a log debug level

DEBUG

  public  DEBUG(pctx LOG_CTX, 
                     ptexte TLOG.LTEXTE%TYPE)

INFO

  public  INFO(ptexte TLOG.LTEXTE%TYPE)

For use a log info level

INFO

  public  INFO(pctx LOG_CTX, 
                     ptexte TLOG.LTEXTE%TYPE)

WARN

  public  WARN(ptexte TLOG.LTEXTE%TYPE)

For use a log warning level

WARN

  public  WARN(pctx LOG_CTX, 
                     ptexte TLOG.LTEXTE%TYPE)

ERROR

  public  ERROR(ptexte TLOG.LTEXTE%TYPE)

For use a log error level new V3 call without argument or only with one context, SQLCODE - SQLERRM is log.

ERROR

  public  ERROR(pctx LOG_CTX, 
                     ptexte TLOG.LTEXTE%TYPE)

FATAL

  public  FATAL(ptexte TLOG.LTEXTE%TYPE)

For use a log fatal level

FATAL

  public  FATAL(pctx LOG_CTX, 
                     ptexte TLOG.LTEXTE%TYPE)

LOG

  public  LOG(pctx LOG_CTX, 
                     plevel TLOG.LLEVEL%TYPE, 
                     ptexte TLOG.LTEXTE%TYPE)

Generique procedure (use only for define your application level DEFINE_APPLICATION_LEVEL=TRUE)

LOG

  public  LOG(pctx LOG_CTX, 
                     plevel TLOGLEVEL.LCODE%TYPE, 
                     ptexte TLOG.LTEXTE%TYPE)

LOG

  public  LOG(plevel TLOG.LLEVEL%TYPE, 
                     ptexte TLOG.LTEXTE%TYPE)

LOG

  public  LOG(plevel TLOGLEVEL.LCODE%TYPE, 
                     ptexte TLOG.LTEXTE%TYPE)

INIT

  public LOG_CTX INIT(psection TLOG.LSECTION%TYPE, 
                     plevel TLOG.LLEVEL%TYPE, 
                     plog4j BOOLEAN, 
                     plogtable BOOLEAN, 
                     pout_trans BOOLEAN, 
                     palert BOOLEAN, 
                     ptrace BOOLEAN, 
                     pdbms_output BOOLEAN, 
                     pdbms_pipe_name VARCHAR2)

context initialisation

Parameters:

psection - default = NULL => PLSQL CALL STACK

plevel - default = PLOGPARAM.DEFAULT_LEVEL -> LDEBUG

plog4j - default = PLOGPARAM.DEFAULT_USE_LOG4J -> FALSE (If true backgroun process is require)

plogtable - default = PLOGPARAM.DEFAULT_LOG_TABLE -> TRUE

pout_trans - default = PLOGPARAM.DEFAULT_LOG_OUT_TRANS -> TRUE

palert - default = PLOGPARAM.DEFAULT_LOG_ALERT -> FALSE

ptrace - default = PLOGPARAM.DEFAULT_LOG_TRACE -> FALSE

pdbms_output - default = PLOGPARAM.DEFAULT_DBMS_OUTPUT -> FALSE

Returns:

new context LOG_CTX

SETBEGINSECTION

  public  SETBEGINSECTION(pctx LOG_CTX, 
                     psection TLOG.LSECTION%TYPE)

Sections management : init a new section

GETSECTION

  public TLOG.LSECTION%TYPE GETSECTION(pctx LOG_CTX)

Sections management : get a current section

Returns:

current section

GETSECTION

  public TLOG.LSECTION%TYPE GETSECTION()

Sections management : get a default section

Returns:

current section

SETENDSECTION

  public  SETENDSECTION(pctx LOG_CTX, 
                     psection TLOG.LSECTION%TYPE)

Sections management : close a Section
without pSECTION : clean all section

SETLEVEL

  public  SETLEVEL(pctx LOG_CTX, 
                     plevel TLOG.LLEVEL%TYPE)

Levels Management : increase level
it is possible to dynamically update with setLevell the level of log
call of setLevel without paramettre repositions the levels has that specifier
in the package
erreur possible : -20501, 'Set Level not in LOG predefine constantes'

SETLEVEL

  public  SETLEVEL(pctx LOG_CTX, 
                     plevel TLOGLEVEL.LCODE%TYPE)

GETLEVEL

  public TLOG.LLEVEL%TYPE GETLEVEL(pctx LOG_CTX)

Levels Management : Get a current level

GETLEVEL

  public TLOG.LLEVEL%TYPE GETLEVEL()

Levels Management : Get a default level

ISDEBUGENABLED

  public BOOLEAN ISDEBUGENABLED(pctx LOG_CTX)

Levels Management : return true if current level is Debug

ISDEBUGENABLED

  public BOOLEAN ISDEBUGENABLED()

Levels Management : return true if default level is Debug

ISINFOENABLED

  public BOOLEAN ISINFOENABLED(pctx LOG_CTX)

Levels Management : return true if current level is Info

ISINFOENABLED

  public BOOLEAN ISINFOENABLED()

Levels Management : return true if default level is Info

ISWARNENABLED

  public BOOLEAN ISWARNENABLED(pctx LOG_CTX)

Levels Management : return true if current level is Warn

ISWARNENABLED

  public BOOLEAN ISWARNENABLED()

Levels Management : return true if default level is Warn

ISERRORENABLED

  public BOOLEAN ISERRORENABLED(pctx LOG_CTX)

Levels Management : return true if current level is Error

ISERRORENABLED

  public BOOLEAN ISERRORENABLED()

Levels Management : return true if default level is Error

ISFATALENABLED

  public BOOLEAN ISFATALENABLED(pctx LOG_CTX)

Levels Management : return true if current level is Fatal

ISFATALENABLED

  public BOOLEAN ISFATALENABLED()

Levels Management : return true if default level is Fatal

SETTRANSACTIONMODE

  public  SETTRANSACTIONMODE(pctx LOG_CTX, 
                     intransaction BOOLEAN)

Transactional management : define a transaction mode
parameter transactional mode
TRUE => Log in transaction
FALSE => Log out off transaction

GETTRANSACTIONMODE

  public BOOLEAN GETTRANSACTIONMODE(pctx LOG_CTX)

Transactional management : retun a transaction mode
TRUE => Log in transaction
FALSE => Log out off transaction

GETTRANSACTIONMODE

  public BOOLEAN GETTRANSACTIONMODE()

Transactional management : retun a default transaction mode
TRUE => Log in transaction
FALSE => Log out off transaction

SETUSE_LOG4JMODE

  public  SETUSE_LOG4JMODE(pctx LOG_CTX, 
                     inuse_log4j BOOLEAN)

USE_LOG4J management : define a USE_LOG4J destination mode
TRUE => Log is send to log4j
FALSE => Log is not send to log4j

GETUSE_LOG4JMODE

  public BOOLEAN GETUSE_LOG4JMODE(pctx LOG_CTX)

USE_LOG4J management : retun a USE_LOG4J mode
TRUE => Log is send to USE_LOG4J
FALSE => Log is not send to USE_LOG4J

GETUSE_LOG4JMODE

  public BOOLEAN GETUSE_LOG4JMODE()

USE_LOG4J management : retun a USE_LOG4J mode
TRUE => Log is send to USE_LOG4J
FALSE => Log is not send to USE_LOG4J

SETLOG_TABLEMODE

  public  SETLOG_TABLEMODE(pctx LOG_CTX, 
                     inlog_table BOOLEAN)

LOG_TABLE management : define a LOG_TABLE destination mode
TRUE => Log is send to LOG_TABLE
FALSE => Log is not send to LOG_TABLE

GETLOG_TABLEMODE

  public BOOLEAN GETLOG_TABLEMODE(pctx LOG_CTX)

LOG_TABLE management : retun a LOG_TABLE mode
TRUE => Log is send to LOG_TABLE
FALSE => Log is not send to LOG_TABLE

GETLOG_TABLEMODE

  public BOOLEAN GETLOG_TABLEMODE()

LOG_TABLE management : retun a LOG_TABLE mode
TRUE => Log is send to LOG_TABLE
FALSE => Log is not send to LOG_TABLE

SETLOG_ALERTMODE

  public  SETLOG_ALERTMODE(pctx LOG_CTX, 
                     inlog_alert BOOLEAN)

LOG_ALERT management : define a LOG_ALERT destination mode
TRUE => Log is send to LOG_ALERT
FALSE => Log is not send to LOG_ALERT

GETLOG_ALERTMODE

  public BOOLEAN GETLOG_ALERTMODE(pctx LOG_CTX)

LOG_ALERT management : retun a LOG_ALERT mode
TRUE => Log is send to LOG_ALERT
FALSE => Log is not send to LOG_ALERT

GETLOG_ALERTMODE

  public BOOLEAN GETLOG_ALERTMODE()

LOG_ALERT management : retun a LOG_ALERT mode
TRUE => Log is send to LOG_ALERT
FALSE => Log is not send to LOG_ALERT

SETLOG_TRACEMODE

  public  SETLOG_TRACEMODE(pctx LOG_CTX, 
                     inlog_trace BOOLEAN)

LOG_TRACE management : define a LOG_TRACE destination mode
TRUE => Log is send to LOG_TRACE
FALSE => Log is not send to LOG_TRACE

GETLOG_TRACEMODE

  public BOOLEAN GETLOG_TRACEMODE(pctx LOG_CTX)

LOG_TRACE management : retun a LOG_TRACE mode
TRUE => Log is send to LOG_TRACE
FALSE => Log is not send to LOG_TRACE

GETLOG_TRACEMODE

  public BOOLEAN GETLOG_TRACEMODE()

LOG_TRACE management : retun a LOG_TRACE mode
TRUE => Log is send to LOG_TRACE
FALSE => Log is not send to LOG_TRACE

SETDBMS_OUTPUTMODE

  public  SETDBMS_OUTPUTMODE(pctx LOG_CTX, 
                     indbms_output BOOLEAN)

DBMS_OUTPUT management : define a DBMS_OUTPUT destination mode
TRUE => Log is send to DBMS_OUTPUT
FALSE => Log is not send to DBMS_OUTPUT

GETDBMS_OUTPUTMODE

  public BOOLEAN GETDBMS_OUTPUTMODE(pctx LOG_CTX)

DBMS_OUTPUT management : retun a DBMS_OUTPUT mode
TRUE => Log is send to DBMS_OUTPUT
FALSE => Log is not send to DBMS_OUTPUT

GETDBMS_OUTPUTMODE

  public BOOLEAN GETDBMS_OUTPUTMODE()

DBMS_OUTPUT management : retun a DBMS_OUTPUT mode
TRUE => Log is send to DBMS_OUTPUT
FALSE => Log is not send to DBMS_OUTPUT

ASSERT

  public  ASSERT(pcondition BOOLEAN, 
                     plogerrormessageiffalse VARCHAR2, 
                     plogerrorcodeiffalse NUMBER, 
                     praiseexceptioniffalse BOOLEAN, 
                     plogerrorreplaceerror BOOLEAN)

assert log a messge is pCondition is FALSE if pRaiseExceptionIfFALSE = TRUE the message is raise

Parameters:

pcondition - IN BOOLEAN -> error condition

plogerrormessageiffalse - IN VARCHAR2 default 'assert condition error' -> message if pCondition is true

plogerrorcodeiffalse - IN NUMBER default -20000 -> error code is pCondition is true range -20000 .. -20999

praiseexceptioniffalse - IN BOOLEAN default FALSE -> if true raise pException_in if pCondition is true

plogerrorreplaceerror - IN BOOLEAN default FALSE -> TRUE, the error is placed on the stack of previous errors. If FALSE (the default), the error replaces all previous errors (see Oracle Documentation RAISE_APPLICATION_ERROR)

ASSERT

  public  ASSERT(pctx LOG_CTX, 
                     pcondition BOOLEAN, 
                     plogerrormessageiffalse VARCHAR2, 
                     plogerrorcodeiffalse NUMBER, 
                     praiseexceptioniffalse BOOLEAN, 
                     plogerrorreplaceerror BOOLEAN)

assert log a messge is pCondition is FALSE if pRaiseExceptionIfFALSE = TRUE the message is raise

Parameters:

pctx - IN OUT NOCOPY LOG_CTX -> Context

pcondition - IN BOOLEAN -> error condition

plogerrormessageiffalse - IN VARCHAR2 default 'assert condition error' -> message if pCondition is true

plogerrorcodeiffalse - IN NUMBER default -20000 -> error code is pCondition is true range -20000 .. -20999

praiseexceptioniffalse - IN BOOLEAN default FALSE -> if true raise pException_in if pCondition is true

plogerrorreplaceerror - IN BOOLEAN default FALSE -> TRUE, the error is placed on the stack of previous errors. If FALSE (the default), the error replaces all previous errors (see Oracle Documentation RAISE_APPLICATION_ERROR)

FULL_CALL_STACK

  public  FULL_CALL_STACK()

full_call_stack log result of dbms_utility.format_call_stack
some time is necessary for debug code.

FULL_CALL_STACK

  public  FULL_CALL_STACK(pctx LOG_CTX)

GETLOG4PLSQVERSION

  public VARCHAR2 GETLOG4PLSQVERSION()

getLOG4PLSQVersion return a string with a current version

GETLEVELINTEXT

  public VARCHAR2 GETLEVELINTEXT(plevel TLOG.LLEVEL%TYPE)

getLevelInText return a string with a level in send in parameter

GETTEXTINLEVEL

  public TLOG.LLEVEL%TYPE GETTEXTINLEVEL(pcode TLOGLEVEL.LCODE%TYPE)

getTextInLevel return a level with a String in send in parameter

GETDBMS_PIPE_NAME

  public VARCHAR2 GETDBMS_PIPE_NAME(pctx LOG_CTX)

DBMS_PIPE_NAME management

GETDBMS_PIPE_NAME

  public VARCHAR2 GETDBMS_PIPE_NAME()

SETDBMS_PIPE_NAME

  public  SETDBMS_PIPE_NAME(pctx LOG_CTX, 
                     indbms_pipe_name VARCHAR2)

PURGE

  public  PURGE()

admin functionality : delete rows in table TLOG and commit

PURGE

  public  PURGE(pctx LOG_CTX)

PURGE

  public  PURGE(pctx LOG_CTX, 
                     datemax DATE)

admin functionality : delete rows in table TLOG with date max and commit