net.sourceforge.jobman

Class Logger

java.lang.Object

net.sourceforge.jobman.Logger

public class Logger
extends java.lang.Object

This is the logging utility for the main jobman process. All members are static.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.text.DateFormat	df
private static java.io.PrintWriter	masterCsv CSV file recording task status in a tabular format: sequence number, loop, time, task type, task name, stage, task string representation.
private static java.lang.String	masterFilePath The full path to the master log file.
private static java.io.PrintWriter	masterLog This is the common log file.
private static int	reportCounter
private static int	reportSession
private static java.io.File	rootPath

Constructor Summary

Constructors

Constructor and Description
Logger()

Method Summary

Modifier and Type	Method and Description
(package private) static void	cleanTaskFiles(java.lang.String taskString)
(package private) static void	close()
(package private) static void	debugDump(boolean alwaysDump) Try to dump the debug information into the master log file.
(package private) static void	debugMaster(java.lang.String message)
(package private) static void	debugMaster(java.lang.String message, java.lang.Object o) Write debug message into the master log file.
private static boolean	deleteDirectory(java.io.File path)
private static boolean	deleteDirectory(java.io.File path, boolean delTop) Delete the specified directory.
private static int	getLastSession(java.io.File rptFile) Obtain the session number of the last run.
(package private) static java.lang.String	getMasterFilePath()
(package private) static java.io.File	getPathByExtension(Task t, java.lang.String ext)
(package private) static java.lang.String	getRoot() Return the path to jobman home directory.
(package private) static void	logSuccess(Task t) Log success message into the task log file.
(package private) static void	makeNodeDir(java.lang.String taskString)
private static boolean	parseErrFile(java.io.File errF) Parse an error file.
private static void	printHeader()
(package private) static java.util.ArrayList<java.lang.String>	readParameter(Node parent, java.lang.String paramChild) Read the parameter file for a parameterized job.
(package private) static void	report(Task t)
(package private) static void	setup(java.lang.String path, java.lang.String topJob) Set up the logging system.
private static Status	statusByLog(java.io.File logP, java.lang.String taskName) Obtain the status of the task by parsing the log file of the task.
(package private) static Status	taskStatus(Task t) Scan the log and the err files to see if the task has completed successfully.
(package private) static void	traceMaster(java.lang.Exception t) Write non-critical Exception message into the master log file.
(package private) static void	traceMaster(java.lang.String message) Write message into the master log file.
(package private) static void	warnMaster(java.lang.Exception t) Write a Exception as a warning message into the master log file.
(package private) static void	warnMaster(java.lang.String message) Write a warning message into the master log file.
(package private) static void	warnMaster(java.lang.String message, java.lang.Exception t) Write a warning message and record Exception into the log file.
(package private) static void	writePar(Task sh, java.lang.String param)
(package private) static void	writePar(Task sh, java.lang.String[] param)

Methods inherited from class java.lang.Object

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

Field Detail

df

private static java.text.DateFormat df

masterLog

private static java.io.PrintWriter masterLog

This is the common log file.

masterFilePath

private static java.lang.String masterFilePath

The full path to the master log file.

rootPath

private static java.io.File rootPath

masterCsv

private static java.io.PrintWriter masterCsv

CSV file recording task status in a tabular format: sequence number, loop, time, task type, task name, stage, task string representation. The stage of a job is the same as its status except for a queuing or running job. For a job in queue or running, the stage is either in preparation or main execution.

reportSession

private static int reportSession

reportCounter

private static int reportCounter

Constructor Detail

Logger

public Logger()

Method Detail

setup

static void setup(java.lang.String path,
                  java.lang.String topJob)
           throws java.lang.Exception

Set up the logging system. It also reads from previous run's log files to decide where to start.

Parameters:

path - The full path of the jobman home directory.

topJob - The the name of the top most job to be run.

Throws:

java.lang.Exception

getRoot

static java.lang.String getRoot()

Return the path to jobman home directory.

getMasterFilePath

static java.lang.String getMasterFilePath()

Returns:

The full path to the master log file.

traceMaster

static void traceMaster(java.lang.String message)

Write message into the master log file.

Parameters:

message - The message to be written into the log file.

traceMaster

static void traceMaster(java.lang.Exception t)

Write non-critical Exception message into the master log file.

Parameters:

t - The Exception to be logged.

warnMaster

static void warnMaster(java.lang.Exception t)

Write a Exception as a warning message into the master log file. This will not stop the program.

warnMaster

static void warnMaster(java.lang.String message)

Write a warning message into the master log file. This will not stop the program.

warnMaster

static void warnMaster(java.lang.String message,
                       java.lang.Exception t)

Write a warning message and record Exception into the log file. This will not stop the program.

debugMaster

static void debugMaster(java.lang.String message,
                        java.lang.Object o)

Write debug message into the master log file. No wrapping method is expected. This means this function must be called directly. Otherwise an extra stack trace frame would be added by the wrapper.

Parameters:

message - A string of debug message.

o - The object whose toString() will be appended.

debugMaster

static void debugMaster(java.lang.String message)

debugDump

static void debugDump(boolean alwaysDump)

Try to dump the debug information into the master log file. Depending on configurations, the debug info may not output into the log file.

Parameters:

alwaysDump - Insist dump the debug info regardless configuration settings.

parseErrFile

private static boolean parseErrFile(java.io.File errF)
                             throws java.lang.Exception

Parse an error file.

Parameters:

errF - The handle of the error file to be parsed.

Returns:

true if the err file contains a true error. This means some line in the error file contains a string not specified in the cfg/ignore_list.txt.

Throws:

java.lang.Exception

logSuccess

static void logSuccess(Task t)

Log success message into the task log file. The log file is used for later resumed run.

taskStatus

static Status taskStatus(Task t)

Scan the log and the err files to see if the task has completed successfully. It is assumed that the task has finished, either successfully or failed.

statusByLog

private static Status statusByLog(java.io.File logP,
                                  java.lang.String taskName)
                           throws java.lang.Exception

Obtain the status of the task by parsing the log file of the task. The success string will be searched for to determine if the task was successful.

Parameters:

logP - The path to the log file that is used to determine the job status.

Throws:

java.lang.Exception

cleanTaskFiles

static void cleanTaskFiles(java.lang.String taskString)

makeNodeDir

static void makeNodeDir(java.lang.String taskString)

getPathByExtension

static java.io.File getPathByExtension(Task t,
                                       java.lang.String ext)

readParameter

static java.util.ArrayList<java.lang.String> readParameter(Node parent,
                                                           java.lang.String paramChild)
                                                    throws java.lang.Exception

Read the parameter file for a parameterized job.

Parameters:

parent - The parent job.

paramChild - The job name of the child job specifying parameters.

Returns:

The Vector containing the parameters.

Throws:

java.lang.Exception

deleteDirectory

private static boolean deleteDirectory(java.io.File path,
                                       boolean delTop)

Delete the specified directory. This is equivalent to org.apache.commons.io.FileUtils.deleteDirectory().

deleteDirectory

private static boolean deleteDirectory(java.io.File path)

writePar

static void writePar(Task sh,
                     java.lang.String param)
              throws java.lang.Exception

Throws:

java.lang.Exception

writePar

static void writePar(Task sh,
                     java.lang.String[] param)
              throws java.lang.Exception

Throws:

java.lang.Exception

printHeader

private static void printHeader()

report

static void report(Task t)

close

static void close()

getLastSession

private static int getLastSession(java.io.File rptFile)
                           throws java.lang.Exception

Obtain the session number of the last run.

Parameters:

rptFile - The path to report file "jobman.csv".

Returns:

The previously run session number. If last session did not record a single complete line, return 0.

Throws:

java.lang.Exception