org.webmacro
Interface Log

All Known Implementing Classes:
LogSource

public interface Log

A log is a simple recipient of information about the system. It does not display or render this information, but instead passes it back to a set of log targets. A log is administered by a LogManager so you cannot instantiate one directly. Instead you must ask the Logmanager or a log instance.


Method Summary
 void debug(java.lang.String msg)
          A shortform for debug(msg,null)
 void debug(java.lang.String msg, java.lang.Exception e)
          Debug messages are incidental programmer notes which should not be enabled in a production system.
 void error(java.lang.String msg)
          A shortform for debug(msg,null)
 void error(java.lang.String msg, java.lang.Exception e)
          An error is a major failure within the system.
 void info(java.lang.String msg)
          Info is fairly unimportant information about routine processing within the system.
 boolean loggingDebug()
          Ask the log system if it wants these kinds of log messages.
 boolean loggingInfo()
           
 boolean loggingNotice()
           
 boolean loggingWarning()
           
 void notice(java.lang.String msg)
          Notices are important information about routine processing within the system.
 void warning(java.lang.String msg)
          A shortform for debug(msg,null)
 void warning(java.lang.String msg, java.lang.Exception e)
          Warnings are messages outlining unexpected non-routine events within the system.
 

Method Detail

debug

public void debug(java.lang.String msg,
                  java.lang.Exception e)
Debug messages are incidental programmer notes which should not be enabled in a production system. They are useful only during development.

debug

public void debug(java.lang.String msg)
A shortform for debug(msg,null)

info

public void info(java.lang.String msg)
Info is fairly unimportant information about routine processing within the system. They may be interesting on a production system, but also can typically be ignored.

notice

public void notice(java.lang.String msg)
Notices are important information about routine processing within the system. For example, startup and shutdown messages. They are likely interesting to people running a production system since they provide timestamps for important events.

warning

public void warning(java.lang.String msg,
                    java.lang.Exception e)
Warnings are messages outlining unexpected non-routine events within the system. They may indicate larger problems, but in and of themselves refer to problems the system is capable of handling on its own. On a correctly functioning production system you would expect to see only a few warnings.

warning

public void warning(java.lang.String msg)
A shortform for debug(msg,null)

error

public void error(java.lang.String msg)
A shortform for debug(msg,null)

error

public void error(java.lang.String msg,
                  java.lang.Exception e)
An error is a major failure within the system. Typically it is something which cannot easily be handled by the system. On a correctly functioning production system you would not expect to see any error messages.

loggingDebug

public boolean loggingDebug()
Ask the log system if it wants these kinds of log messages. This is because the overhead of creating log messages is high, even if we're not going to log them, because it usually involves several string concatenations.

loggingInfo

public boolean loggingInfo()

loggingNotice

public boolean loggingNotice()

loggingWarning

public boolean loggingWarning()