org.objectweb.cjdbc.controller.core
Class ReportManager

java.lang.Object
  org.objectweb.cjdbc.controller.core.ReportManager

public class ReportManager

extends java.lang.Object

Class to create report from Controller

Author:

Emmanuel Cecchet , Nicolas Modrzyk , Mathieu Peltier

Field Summary

private java.lang.StringBuffer	buffer
private Controller	controller
(package private) boolean	enableFileLogging
private java.io.FileOutputStream	fos
(package private) boolean	generateOnFatal
(package private) boolean	generateOnShutdown
(package private) boolean	hideSensitiveData
(package private) static Trace	logger Logger instance.
(package private) boolean	reportEnabled Settings
(package private) java.lang.String	reportLocation
(package private) boolean	showLogsOnly

Constructor Summary

ReportManager(Controller controller)
Call above and write controller xml information and information

ReportManager(Controller controller, boolean showLogsOnly)
Creates a new ReportManager.java object Report only logs

ReportManager(Controller controller, java.lang.Exception e)
Call above and write about the exception

Method Summary

java.lang.String	generate() Flush and close
java.lang.String	generateJustLogs() Get a trace of the logs only
java.lang.String	getReportLocation()
boolean	isEnableFileLogging()
boolean	isGenerateOnFatal()
boolean	isGenerateOnShutdown()
boolean	isHideSensitiveData()
boolean	isReportEnabled()
(package private) void	listLoggers()
void	setEnableFileLogging(boolean enableFileLogging) Sets the enableFileLogging value.
void	setGenerateOnFatal(boolean generateOnFatal) Sets the generateOnFatal value.
void	setGenerateOnShutdown(boolean generateOnShutdown) Sets the generateOnShutdown value.
void	setHideSensitiveData(boolean hideSensitiveData) Sets the hideSensitiveData value.
private void	setLogsDeleteOnExit()
void	setReportEnabled(boolean reportEnabled) Sets the reportEnabled value.
void	setReportLocation(java.lang.String reportLocation) Sets the reportLocation value.
void	setSettings(java.util.Hashtable settings)
void	startReport() Starts generating the report.
private void	write(java.util.Hashtable table)
private void	write(java.lang.String string)
void	writeControllerInfo() Write Controller info as return by getInformation()
void	writeControllerSettings() Write all parameters from ControllerFactory
void	writeException(java.lang.Exception e) Write Details of the exception
private void	writeFile(java.lang.String filename)
private void	writeHeader(java.lang.String header)
void	writeJavaProperties() Write All Java Properties
void	writeLogs() Write Logs
private void	writeTitle(java.lang.String title)

Methods inherited from class java.lang.Object

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

Field Detail

logger

static Trace logger

Logger instance.

reportEnabled

boolean reportEnabled

Settings

hideSensitiveData

boolean hideSensitiveData

generateOnShutdown

boolean generateOnShutdown

generateOnFatal

boolean generateOnFatal

enableFileLogging

boolean enableFileLogging

showLogsOnly

boolean showLogsOnly

reportLocation

java.lang.String reportLocation

controller

private Controller controller

buffer

private java.lang.StringBuffer buffer

fos

private java.io.FileOutputStream fos

Constructor Detail

ReportManager

public ReportManager(Controller controller)

Call above and write controller xml information and information

Parameters:

controller - to report

ReportManager

public ReportManager(Controller controller,
                     boolean showLogsOnly)

Creates a new ReportManager.java object Report only logs

Parameters:

controller - the controller to report logs from

showLogsOnly - show logs

ReportManager

public ReportManager(Controller controller,
                     java.lang.Exception e)

Call above and write about the exception

Parameters:

controller - to report

e - exception

Method Detail

startReport

public void startReport()

Starts generating the report. Effectively write the java properties, controller settings, controller info but do not write the logs yet.

writeControllerInfo

public void writeControllerInfo()

Write Controller info as return by getInformation()

writeControllerSettings

public void writeControllerSettings()

Write all parameters from ControllerFactory

writeJavaProperties

public void writeJavaProperties()

Write All Java Properties

writeLogs

public void writeLogs()

Write Logs

writeException

public void writeException(java.lang.Exception e)

Write Details of the exception

Parameters:

e - exception to write

generate

public java.lang.String generate()

Flush and close

Returns:

report content

generateJustLogs

public java.lang.String generateJustLogs()

Get a trace of the logs only

Returns:

String content of the log4j output

write

private void write(java.lang.String string)

writeFile

private void writeFile(java.lang.String filename)

write

private void write(java.util.Hashtable table)

writeTitle

private void writeTitle(java.lang.String title)

writeHeader

private void writeHeader(java.lang.String header)

setLogsDeleteOnExit

private void setLogsDeleteOnExit()

setSettings

public final void setSettings(java.util.Hashtable settings)

Parameters:

settings - hashtable of settings

listLoggers

void listLoggers()

isEnableFileLogging

public boolean isEnableFileLogging()

Returns:

Returns the enableFileLogging.

isGenerateOnFatal

public boolean isGenerateOnFatal()

Returns:

Returns the generateOnFatal.

isGenerateOnShutdown

public boolean isGenerateOnShutdown()

Returns:

Returns the generateOnShutdown.

isHideSensitiveData

public boolean isHideSensitiveData()

Returns:

Returns the hideSensitiveData.

isReportEnabled

public boolean isReportEnabled()

Returns:

Returns the reportEnabled.

getReportLocation

public java.lang.String getReportLocation()

Returns:

Returns the reportLocation.

setEnableFileLogging

public void setEnableFileLogging(boolean enableFileLogging)

Sets the enableFileLogging value.

Parameters:

enableFileLogging - The enableFileLogging to set.

setGenerateOnFatal

public void setGenerateOnFatal(boolean generateOnFatal)

Sets the generateOnFatal value.

Parameters:

generateOnFatal - The generateOnFatal to set.

setGenerateOnShutdown

public void setGenerateOnShutdown(boolean generateOnShutdown)

Sets the generateOnShutdown value.

Parameters:

generateOnShutdown - The generateOnShutdown to set.

setHideSensitiveData

public void setHideSensitiveData(boolean hideSensitiveData)

Sets the hideSensitiveData value.

Parameters:

hideSensitiveData - The hideSensitiveData to set.

setReportEnabled

public void setReportEnabled(boolean reportEnabled)

Sets the reportEnabled value.

Parameters:

reportEnabled - The reportEnabled to set.

setReportLocation

public void setReportLocation(java.lang.String reportLocation)

Sets the reportLocation value.

Parameters:

reportLocation - The reportLocation to set.