com.sap.caf.rt.util

Class CAFPublicLogger

java.lang.Object
  extended by com.sap.caf.rt.util.CAFPublicLogger

public final class CAFPublicLogger
extends Object

This class wraps the standard SAP Exception Framework and extends it with CAF specific logging, tracing and application monitoring. Use constructors for entering/exiting for important methods that need logging and monitoring. The monitoring functionality is called inside these methods with required monitoring level


Field Summary
static Category categoryCAF
          This determines the location to which the log files are written
static Category categoryXAPPS
          Deprecated.  
static int LEVEL_BASIC
          Trace level for messages that should be created always.
static int LEVEL_DETAIL
          Trace level for messages that should be created when more detailed analysis needed Corresponds to JARM trace level 2
static int LEVEL_MEDIUM
          Trace level for messages that should be created when single activity trace enabled Corresponds to JARM trace level 1
static Location LOC_CAF
          This determines the location to which the trace files are written and is related to the value in the log-configuration.xml file of CAF
 
Constructor Summary
CAFPublicLogger()
           
 
Method Summary
static void entering(String user, String request, String methodName, String application)
           
static void entering(String user, String request, String methodName, String application, int traceLevel)
           
static void entering(String user, String request, String methodName, String application, Object[] params)
           
static void entering(String user, String request, String methodName, String application, Object[] params, int traceLevel)
           
static void exiting(String user, String request, String methodName, Location loc, int traceLevel)
           
static void exiting(String user, String request, String methodName, Location loc, Object res)
           
static void exiting(String user, String request, String methodName, Location loc, Object res, int traceLevel)
           
static void exiting(String user, String request, String methodName, String application)
           
static void log(int severity, Location location, String method, String message)
          Log the formated message in the passed location populated with the params
static void log(int severity, Location location, String method, String message, Object[] params)
          Log the formated message in the passed location populated with the params
static void logThrowable(int severity, Category category, Location location, String method, String message, Throwable throwable)
          Deprecated. use constructor of com.sap.tc.logging.Category.logThrowableT
static void logThrowable(int severity, Category category, Location location, String method, Throwable throwable)
          Deprecated. use constructor of com.sap.tc.logging.Category.logThrowableT
static void logThrowable(int severity, Category category, String method, Throwable throwable)
          Deprecated. use constructor of com.sap.tc.logging.Category.logThrowableT
static void traceThrowable(int severity, Location location, String method, Throwable throwable)
          Deprecated. use constructor of com.sap.tc.logging.Location.traceThrowableT
static void traceThrowable(int severity, String method, Throwable throwable)
          Deprecated. use constructor of com.sap.tc.logging.Location.traceThrowableT
static void traceThrowableT(int severity, Location location, String method, String message, Object[] params, Throwable throwable)
           
static void traceThrowableT(int severity, Location location, String method, String message, Throwable throwable)
           
static void traceThrowableT(int severity, Location location, String method, Throwable throwable)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LEVEL_BASIC

public static final int LEVEL_BASIC
Trace level for messages that should be created always. Corresponds to default JARM trace level 0

See Also:
Constant Field Values

LEVEL_MEDIUM

public static final int LEVEL_MEDIUM
Trace level for messages that should be created when single activity trace enabled Corresponds to JARM trace level 1

See Also:
Constant Field Values

LEVEL_DETAIL

public static final int LEVEL_DETAIL
Trace level for messages that should be created when more detailed analysis needed Corresponds to JARM trace level 2

See Also:
Constant Field Values

LOC_CAF

public static final Location LOC_CAF
This determines the location to which the trace files are written and is related to the value in the log-configuration.xml file of CAF


categoryCAF

public static final Category categoryCAF
This determines the location to which the log files are written


categoryXAPPS

public static final Category categoryXAPPS
Deprecated. 
Constructor Detail

CAFPublicLogger

public CAFPublicLogger()
Method Detail

entering

public static void entering(String user,
                            String request,
                            String methodName,
                            String application)
Parameters:
user -
request -
methodName -
application -

entering

public static void entering(String user,
                            String request,
                            String methodName,
                            String application,
                            int traceLevel)
Parameters:
user -
request -
methodName -
application -
traceLevel -

entering

public static void entering(String user,
                            String request,
                            String methodName,
                            String application,
                            Object[] params)
Parameters:
user -
request -
methodName -
application -
params -

entering

public static void entering(String user,
                            String request,
                            String methodName,
                            String application,
                            Object[] params,
                            int traceLevel)
Parameters:
user -
request -
methodName -
application -
params -
traceLevel -

exiting

public static void exiting(String user,
                           String request,
                           String methodName,
                           String application)
Parameters:
user -
request -
methodName -
application -

exiting

public static void exiting(String user,
                           String request,
                           String methodName,
                           Location loc,
                           Object res)
Parameters:
user -
request -
methodName -
loc -
res -

exiting

public static void exiting(String user,
                           String request,
                           String methodName,
                           Location loc,
                           int traceLevel)
Parameters:
user -
request -
methodName -
loc -
traceLevel -

exiting

public static void exiting(String user,
                           String request,
                           String methodName,
                           Location loc,
                           Object res,
                           int traceLevel)
Parameters:
user -
request -
methodName -
loc -
res -
traceLevel -

traceThrowable

public static void traceThrowable(int severity,
                                  String method,
                                  Throwable throwable)
Deprecated. use constructor of com.sap.tc.logging.Location.traceThrowableT

Parameters:
severity -
method -
throwable -

traceThrowable

public static void traceThrowable(int severity,
                                  Location location,
                                  String method,
                                  Throwable throwable)
Deprecated. use constructor of com.sap.tc.logging.Location.traceThrowableT

Parameters:
severity -
location -
method -
throwable -

traceThrowableT

public static void traceThrowableT(int severity,
                                   Location location,
                                   String method,
                                   String message,
                                   Object[] params,
                                   Throwable throwable)

traceThrowableT

public static void traceThrowableT(int severity,
                                   Location location,
                                   String method,
                                   String message,
                                   Throwable throwable)

traceThrowableT

public static void traceThrowableT(int severity,
                                   Location location,
                                   String method,
                                   Throwable throwable)

logThrowable

public static void logThrowable(int severity,
                                Category category,
                                String method,
                                Throwable throwable)
Deprecated. use constructor of com.sap.tc.logging.Category.logThrowableT

Parameters:
severity -
category -
method -
throwable -

logThrowable

public static void logThrowable(int severity,
                                Category category,
                                Location location,
                                String method,
                                Throwable throwable)
Deprecated. use constructor of com.sap.tc.logging.Category.logThrowableT

Parameters:
severity -
category -
location -
method -
throwable -

logThrowable

public static void logThrowable(int severity,
                                Category category,
                                Location location,
                                String method,
                                String message,
                                Throwable throwable)
Deprecated. use constructor of com.sap.tc.logging.Category.logThrowableT

Parameters:
severity -
category -
location -
method -
message -
throwable -

log

public static void log(int severity,
                       Location location,
                       String method,
                       String message,
                       Object[] params)
Log the formated message in the passed location populated with the params

Parameters:
severity -
location -
method -
message -
params -

log

public static void log(int severity,
                       Location location,
                       String method,
                       String message)
Log the formated message in the passed location populated with the params

Parameters:
severity -
location -
method -
message -
params -


Copyright 2009 SAP AG Complete Copyright Notice