Package au.com.forward.logging

See the Logging class for a coding example using this package, see below for the Licence Agreement.

See:
Description

Class Summary

Logging	This class provides logging initialization and debugging.
LoggingSimpleFormatter	This class provides a robust simple formatter.
LoggingXMLFormatter	This class provides a robust xml formatter with stylesheet.
LogStdStreams	Redirects System.Err and optionally System.Out to an output file This catches any uncaught exception traces.
RobustFormatter	A Robust formatter for LogRecords.

Exception Summary

LoggingException

Exception Class for Logging initialization error.

Package au.com.forward.logging Description

See the Logging class for a coding example using this package, see below for the Licence Agreement.

This logging package sets up Java Logging. It can also be used to capture System.err and System.out to a rolling log file for use with other logging packages such as Log4J

For Java Logging this package satisfies the following requirements

1. All logging output to be saved in log files. This includes System.out and System.err outputs. Nothing is to be sent to the terminal window.
2. The logging is to be robust against programming errors and invalid objects.
3. The application should only log SEVERE level errors (and System.err and System.out) to the default log file.
4. The user can be instructed to start up the application in such a way so that more detailed logging is performed to a secondary log file.
5. The detailed logging is output in XML format but in such a way so that it can be easily viewed as a HTML page using an XSL stylesheet.
6. Only program errors are logged to the default log file. User messages are only logged if detailed logging is enabled.

The package also includes a debugging method Logging.currentConfiguration which returns the current logging settings.

If you are using Log4J or some other non-standard Java logging then use LogStdStreams.initializeErrorLogging(String, String, boolean, int) to capture the System.err and System.out to a rolling log file.

Licence Agreement

Logging package
Copyright (c) 2003 Forward Computing and Control Pty. Ltd.
NSW. Australia,  www.forward.com.au
All rights reserved.

Redistribution of the source of this package, with or without
modification, is NOT permitted.

Redistribution of the compiled java .class files of this package, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions in compiled java .class form must reproduce the above
   copyright notice, this list of conditions and the following disclaimer
   in the documentation and/or other materials provided with the distribution.

2. If the software is modified, the compiled java .class distribution must
   include, in the documentation and/or other materials provided with the 
   distribution, a statement that the software has been modified and
   identify the person who was responsable for the modifications.  

3. Neither the name of the author nor Forward Computing and Control may be 
   used to endorse or promote products derived from this software
   without specific prior written permission.

4.  All advertising materials mentioning features or use of this
    software must display the following acknowledgment: 
    "This product includes software developed by Matthew Ford
     and Forward Computing and Control Pty. Ltd. 
    (http://www.forward.com.au)."


THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.