org.jahia.bin.errors

Class ErrorFileDumper

java.lang.Object

org.jahia.bin.errors.ErrorFileDumper

public class ErrorFileDumper
extends Object

System information utility. User: loom Date: Jul 16, 2010 Time: 4:56:24 PM IMPORTANT NOTE : As this code gets called by log4j appenders, please do not use Log4J loggers in this code !

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ErrorFileDumper.HttpRequestData Utility class to copy useful information from the HTTP request object, as we won't have access to it in asynchronous threads.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.lang.time.FastDateFormat	DATE_FORMAT_DIRECTORY
static org.apache.commons.lang.time.FastDateFormat	DATE_FORMAT_FILE

Constructor Summary

Constructors

Constructor and Description
ErrorFileDumper()

Method Summary

Modifier and Type	Method and Description
static void	dumpToFile(Throwable t, javax.servlet.http.HttpServletRequest request)
static StringWriter	generateErrorReport(ErrorFileDumper.HttpRequestData requestData, Throwable exception, int previousExceptionOccurences, Throwable previousException)
static double	getHighLoadBoundary()
static int	getMaximumTasksAllowed()
protected static int	getNestedExceptionDepth(Throwable t, int curDepth)
static boolean	isFileDumpActivated()
static boolean	isHeapDumpSupported()
static boolean	isShutdown()
static void	outputSystemInfo(PrintWriter strOut)
static void	outputSystemInfo(PrintWriter strOut, boolean systemProperties, boolean jahiaSettings, boolean memory, boolean caches, boolean threads, boolean deadlocks, boolean loadAverage)
static void	outputSystemInfo(PrintWriter strOut, boolean systemProperties, boolean environmentVariables, boolean jahiaSettings, boolean memory, boolean caches, boolean threads, boolean deadlocks, boolean loadAverage)
static File	performHeapDump()
protected static String	recursiveStackTraceToString(Throwable t, int curDepth)
static void	setFileDumpActivated(boolean fileDumpActivated)
static void	setHighLoadBoundary(double highLoadBoundary) Sets the boundary load value above which all reporting will automatically deactivate.
static void	setMaximumTasksAllowed(int maximumTasksAllowed) Sets the maximum number of parallel dumping tasks allowed to be queued.
static void	shutdown()
static void	shutdown(long millisecondsToWait)
protected static String	stackTraceToString(Throwable t) Converts an exception stack trace to a string, going doing into all the embedded exceptions too to detail as much as possible the real causes of the error.
static void	start()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DATE_FORMAT_DIRECTORY

public static final org.apache.commons.lang.time.FastDateFormat DATE_FORMAT_DIRECTORY

DATE_FORMAT_FILE

public static final org.apache.commons.lang.time.FastDateFormat DATE_FORMAT_FILE

Constructor Detail

ErrorFileDumper

public ErrorFileDumper()

Method Detail

start

public static void start()

shutdown

public static void shutdown()

shutdown

public static void shutdown(long millisecondsToWait)

isShutdown

public static boolean isShutdown()

setFileDumpActivated

public static void setFileDumpActivated(boolean fileDumpActivated)

isFileDumpActivated

public static boolean isFileDumpActivated()

dumpToFile

public static void dumpToFile(Throwable t,
                              javax.servlet.http.HttpServletRequest request)
                       throws IOException

Throws:

IOException

getMaximumTasksAllowed

public static int getMaximumTasksAllowed()

setMaximumTasksAllowed

public static void setMaximumTasksAllowed(int maximumTasksAllowed)

Sets the maximum number of parallel dumping tasks allowed to be queued. Default value is 100.

generateErrorReport

public static StringWriter generateErrorReport(ErrorFileDumper.HttpRequestData requestData,
                                               Throwable exception,
                                               int previousExceptionOccurences,
                                               Throwable previousException)

outputSystemInfo

public static void outputSystemInfo(PrintWriter strOut)

getHighLoadBoundary

public static double getHighLoadBoundary()

setHighLoadBoundary

public static void setHighLoadBoundary(double highLoadBoundary)

Sets the boundary load value above which all reporting will automatically deactivate. The default value is 10.0

Parameters:

highLoadBoundary -

outputSystemInfo

public static void outputSystemInfo(PrintWriter strOut,
                                    boolean systemProperties,
                                    boolean jahiaSettings,
                                    boolean memory,
                                    boolean caches,
                                    boolean threads,
                                    boolean deadlocks,
                                    boolean loadAverage)

outputSystemInfo

public static void outputSystemInfo(PrintWriter strOut,
                                    boolean systemProperties,
                                    boolean environmentVariables,
                                    boolean jahiaSettings,
                                    boolean memory,
                                    boolean caches,
                                    boolean threads,
                                    boolean deadlocks,
                                    boolean loadAverage)

stackTraceToString

protected static String stackTraceToString(Throwable t)

Converts an exception stack trace to a string, going doing into all the embedded exceptions too to detail as much as possible the real causes of the error.

Parameters:

t - the exception (eventually that contains other exceptions) for which we want to convert the stack trace into a string.

Returns:

a string containing all the stack traces of all the exceptions contained inside this exception, or an empty string if passed an empty string.

recursiveStackTraceToString

protected static String recursiveStackTraceToString(Throwable t,
                                                    int curDepth)

getNestedExceptionDepth

protected static int getNestedExceptionDepth(Throwable t,
                                             int curDepth)

isHeapDumpSupported

public static boolean isHeapDumpSupported()
                                   throws MalformedObjectNameException

Throws:

MalformedObjectNameException

performHeapDump

public static File performHeapDump()
                            throws MalformedObjectNameException,
                                   InstanceNotFoundException,
                                   ReflectionException,
                                   MBeanException

Throws:

MalformedObjectNameException

InstanceNotFoundException

ReflectionException

MBeanException