Extension SDK 9.0.5

oracle.jdeveloper.audit.service
Class Log

java.lang.Object
  extended byoracle.jdeveloper.audit.service.Log

public final class Log
extends java.lang.Object

The Audit error and trace log. Error logging is always enabled and is done through the static error methods. Trace logging is disabled by default and is done through the non-static trace methods.

Log instances used for trace logging are created with a name and are enabled by name at application launch using the System property audit.trace. When no logs are enabled, the overhead from even liberal use of trace logging is minimal, as long as the calling code takes advantage of the heavy overloading of the trace methods and the use of MessageFormat-style format strings to avoid formatting text. Taking advantage of these also makes the tracing code visually less intrusive.

The value of the audit.trace property is a list of trace names to enable, separated by commas. By default, traces are logged to System.err. If a name begins with "!", the rest of that name is interpreted as the name of the file to which to log; the names "!output" and "!error" are mapped to System.out and System.err, respectively. To launch JDeveloper with the audit.trace property set to "traversal", use the following command line:

   jdev -J-Daudit.trace=traversal
 
If using the command line is not practical, adding the following line to jdev.conf (found in the same directory as jdev.exe) will accomplish the same thing:
   AddVMOption -Daudit.trace=traversal
 

Trace logging is typically used as follows:

 private static final LOG = new Log("profile", "profile-detail");
 private static final DETAILLOG = new Log("profile");
 .
 .
 .
 public void save (URL url)
 {
   LOG.trace("saving profile to {0}", url);
   .
   .
   .
   DETAILLOG.trace("completed saving");
 }
 

Using only one log is probably more typical, but this shows how a log can be given multiple names. In the example, enabling "profile-detail" effectively also enables "profile".

The formatting implementation supports only the basic {0}, {1}, etcetera, parameter substitution of MessageFormat, but is more robust in the face of null and insufficient arguments. Additionally, it provides specialized formatting for some data types. For example, it formats array parameters similarly to List.toString(). If the last parameter is an exception, it will append the stack trace to the message.


Constructor Summary
Log(java.lang.String name)
          Creates a named log.
Log(java.lang.String[] names)
          Creates a named log with multiple names.
Log(java.lang.String name1, java.lang.String name2)
          Creates a named log with two names.
Log(java.lang.String name1, java.lang.String name2, java.lang.String name3)
          Creates a named log with three names.
 
Method Summary
static void error(java.lang.String message)
           
static void error(java.lang.String message, java.lang.Object p1)
           
static void error(java.lang.String message, java.lang.Object[] parameters)
           
static void error(java.lang.String message, java.lang.Object p1, java.lang.Object p2)
           
static void error(java.lang.String message, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3)
           
static void error(java.lang.String message, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4)
           
static java.lang.String format(java.lang.String message, java.lang.Object[] arguments)
           
 boolean isEnabled()
           
 void trace(java.lang.String message)
           
 void trace(java.lang.String message, boolean p1)
           
 void trace(java.lang.String message, boolean p1, java.lang.Object p2)
           
 void trace(java.lang.String message, int p1)
           
 void trace(java.lang.String message, int p1, int p2)
           
 void trace(java.lang.String message, int p1, int p2, int p3)
           
 void trace(java.lang.String message, int p1, int p2, int p3, int p4)
           
 void trace(java.lang.String message, int p1, int p2, java.lang.Object p3)
           
 void trace(java.lang.String message, int p1, int p2, java.lang.Object p3, java.lang.Object p4)
           
 void trace(java.lang.String message, int p1, int p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5)
           
 void trace(java.lang.String message, int p1, java.lang.Object p2)
           
 void trace(java.lang.String message, int p1, java.lang.Object p2, java.lang.Object p3)
           
 void trace(java.lang.String message, int p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4)
           
 void trace(java.lang.String message, int p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5)
           
 void trace(java.lang.String message, long p1)
           
 void trace(java.lang.String message, long p1, java.lang.Object p2)
           
 void trace(java.lang.String message, java.lang.Object p1)
           
 void trace(java.lang.String message, java.lang.Object[] parameters)
           
 void trace(java.lang.String message, java.lang.Object p1, java.lang.Object p2)
           
 void trace(java.lang.String message, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3)
           
 void trace(java.lang.String message, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4)
           
 void trace(java.lang.String message, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Log

public Log(java.lang.String name)
Creates a named log.

Parameters:
name - The name of this log.

Log

public Log(java.lang.String name1,
           java.lang.String name2)
Creates a named log with two names.

Parameters:
name1 - A name of this log.
name2 - A name of this log.

Log

public Log(java.lang.String name1,
           java.lang.String name2,
           java.lang.String name3)
Creates a named log with three names.

Parameters:
name1 - A name of this log.
name2 - A name of this log.
name3 - A name of this log.

Log

public Log(java.lang.String[] names)
Creates a named log with multiple names.

Parameters:
names - The names of this log.
Method Detail

error

public static void error(java.lang.String message)

error

public static void error(java.lang.String message,
                         java.lang.Object p1)

error

public static void error(java.lang.String message,
                         java.lang.Object p1,
                         java.lang.Object p2)

error

public static void error(java.lang.String message,
                         java.lang.Object p1,
                         java.lang.Object p2,
                         java.lang.Object p3)

error

public static void error(java.lang.String message,
                         java.lang.Object p1,
                         java.lang.Object p2,
                         java.lang.Object p3,
                         java.lang.Object p4)

error

public static void error(java.lang.String message,
                         java.lang.Object[] parameters)

isEnabled

public boolean isEnabled()

trace

public void trace(java.lang.String message)

trace

public void trace(java.lang.String message,
                  java.lang.Object p1)

trace

public void trace(java.lang.String message,
                  int p1)

trace

public void trace(java.lang.String message,
                  long p1)

trace

public void trace(java.lang.String message,
                  boolean p1)

trace

public void trace(java.lang.String message,
                  java.lang.Object p1,
                  java.lang.Object p2)

trace

public void trace(java.lang.String message,
                  int p1,
                  java.lang.Object p2)

trace

public void trace(java.lang.String message,
                  int p1,
                  int p2)

trace

public void trace(java.lang.String message,
                  long p1,
                  java.lang.Object p2)

trace

public void trace(java.lang.String message,
                  boolean p1,
                  java.lang.Object p2)

trace

public void trace(java.lang.String message,
                  java.lang.Object p1,
                  java.lang.Object p2,
                  java.lang.Object p3)

trace

public void trace(java.lang.String message,
                  int p1,
                  java.lang.Object p2,
                  java.lang.Object p3)

trace

public void trace(java.lang.String message,
                  int p1,
                  int p2,
                  java.lang.Object p3)

trace

public void trace(java.lang.String message,
                  int p1,
                  int p2,
                  int p3)

trace

public void trace(java.lang.String message,
                  java.lang.Object p1,
                  java.lang.Object p2,
                  java.lang.Object p3,
                  java.lang.Object p4)

trace

public void trace(java.lang.String message,
                  int p1,
                  java.lang.Object p2,
                  java.lang.Object p3,
                  java.lang.Object p4)

trace

public void trace(java.lang.String message,
                  int p1,
                  int p2,
                  java.lang.Object p3,
                  java.lang.Object p4)

trace

public void trace(java.lang.String message,
                  int p1,
                  int p2,
                  int p3,
                  int p4)

trace

public void trace(java.lang.String message,
                  java.lang.Object p1,
                  java.lang.Object p2,
                  java.lang.Object p3,
                  java.lang.Object p4,
                  java.lang.Object p5)

trace

public void trace(java.lang.String message,
                  int p1,
                  java.lang.Object p2,
                  java.lang.Object p3,
                  java.lang.Object p4,
                  java.lang.Object p5)

trace

public void trace(java.lang.String message,
                  int p1,
                  int p2,
                  java.lang.Object p3,
                  java.lang.Object p4,
                  java.lang.Object p5)

trace

public void trace(java.lang.String message,
                  java.lang.Object[] parameters)

format

public static java.lang.String format(java.lang.String message,
                                      java.lang.Object[] arguments)

Extension SDK

 

Copyright © 1997, 2004, Oracle. All rights reserved.