2006-07-19 10:36:13 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
< html >
< head >
< META HTTP-EQUIV = "Content-Type" CONTENT = "text/html; charset=UTF-8" >
< META HTTP-EQUIV = "Content-Style-Type" CONTENT = "text/css" >
< meta name = "copyright" content = "Copyright (c) IBM Corporation and others 2002, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
< LINK REL = "STYLESHEET" HREF = "../../../book.css" TYPE = "text/css" >
< title > RSE Logger API< / title >
< / head >
< body bgcolor = "#ffffff" >
< h1 > RSE Logger API< / h1 >
< p > To use the RSE logging framework, you must first decide if you want your own log file,
or want to use the common RSE log file.
< / p >
< h2 > Using Your Own Log File< / h2 >
< p >
2007-04-02 07:25:38 +00:00
The log file support is encapsulated in the < b > < samp > org.eclipse.rse.logging< / samp > < / b > package, which
2006-07-20 13:15:28 +00:00
defines the primary < samp > < A href = "../../../reference/api/org/eclipse/rse/logging/Logger.html" > org.eclipse.rse.logging.Logger< / a > < / samp > class that manages the log file.
2006-07-19 10:36:13 +00:00
This log file support offers the ability to log the following types of log messages:< / p >
< ul >
< li > < b > Error< / b > . These are serious errors detected by your programming logic.
< li > < b > Warning< / b > . These are warning situations detected by your programming logic.
< li > < b > Information< / b > . These are informational messages you want to capture to help with problem determination.
< li > < b > Debug< / b > . These are trace statements typically only enabled in development drivers.
< / ul >
< p > To define your own logging file, in your plugin class:< / p >
< ol >
< li > Define a static variable to hold the Logger instance, as in:< br >
< code > protected static Logger log = null;< / code >
< li > Instantiate the Logger object, in your plugin class constructor, as in:< br >
2006-08-02 02:35:23 +00:00
< code > if (log == null) log = LoggerFactory.getLogger(this);< / code >
2006-07-19 10:36:13 +00:00
< li > For convenience, offer fastpaths to the logXXX methods in your Logger instance:
< pre >
public static void < b > logInfo< / b > (String message)
{
log.logInfo(message);
}
public static void < b > logWarning< / b > (String message)
{
log.logWarning(message);
}
public static void < b > logError< / b > (String message)
{
log.logError(message, null);
}
public static void < b > logError< / b > (String message, Throwable exception)
{
log.logError(message, exception);
}
public static void < b > logDebugMessage< / b > (String prefix, String message)
{
2006-08-02 02:35:23 +00:00
log.logDebugMessage(prefix, message);
2006-07-19 10:36:13 +00:00
}
< / pre >
< li > In the < samp > shutdown< / samp > method of your plugin class, close the log file:
2006-08-02 02:35:23 +00:00
< code > LoggerFactory.freeLogger(this); < / code >
2006-07-19 10:36:13 +00:00
< / ol >
< p > Typically your code will write a healthy number of messages to the log file, to help you determine
what went wrong in an error situation in production. However, since this can result in a large number of
messages in the log file, it is recommended that you offer the user's a preference page in which they
can specify the types of messages to record in the log file, which should default to error messages only.
In the event of a problem, they can then turn on a more verbose logging option and re-produce the problem,
sending the log file to you for additional information. For example, for the Remote System Explorer, this
preference page is supplied:< / p >
< P > < IMG border = "0" src = "logPreferences.gif" > < / P >
< h2 > Using The Common RSE Log File< / h2 >
2006-08-02 02:35:23 +00:00
< p > To log your messages to the common RSE log file in < samp > .metadata\plugins\org.eclipse.rse.ui< / samp > ,
2006-07-19 10:36:13 +00:00
either base your plugin class on the < samp > org.eclipse.rse.core.SystemBasePlugin< / samp > class and use
the inherited logging methods, or instead of instantiating your own < samp > Logging< / samp > object, re-use the
2006-08-02 02:35:23 +00:00
RSE-supplied logging object by calling < samp > getDefault().getLog()< / samp > in the < samp > org.eclipse.rse.ui.RSEUIPlugin< / samp >
2006-07-19 10:36:13 +00:00
class.
< / p >
< P > < BR > < / P >
< / body >
< / html >
