ORG.oclc.log
Class UserLog

java.lang.Object
  |
  +--ORG.oclc.log.Log
        |
        +--ORG.oclc.log.UserLog

public class UserLog

extends Log

Fields inherited from class ORG.oclc.log.Log

out, TRACE_ALL, TRACE_ALL_ON, TRACE_ARCHIVE, TRACE_CERTIFIED, TRACE_CRITICAL, TRACE_ENTERS_AND_EXITS, TRACE_FATAL, TRACE_HOUSEKEEPING, TRACE_INFO, TRACE_MSGS, TRACE_NONE, TRACE_PARMS, TRACE_READ_MSGS, TRACE_WARNING, TRACE_WRITE_MSGS, traceLevel

Constructor Summary

UserLog()

Method Summary

void	close() Close the user log.
PrintStream	getLogfile() Get the file object.
void	open() Open the log file with the original name information.
void	open(String user, String fileName, String logDirectory) Open the log file with the input naming parameters.
void	print(String fromClass, String msg) Print to the user log.
void	printError(Object reporter, int errorSeverity, Throwable excep, String shortDescription, String otherDescription) Print Errors to the log.
void	rollOver(long currentTime) Shuts/Re-opens the user log file - currently not used.
void	setName(String id, String logName, String logDir) Sets the filename for the log file.
void	setrollOverTime(int time) Sets the userlog rollover time - currently not used.
void	UserLog() Construct a UserLog object.

Methods inherited from class ORG.oclc.log.Log

getTraceLevel, getTraceLevelString, parseTraceLevel, println, println, println, println, println, println, println, println, putTraceLevel, putTraceLevel, setOut, traceOn

Methods inherited from class java.lang.Object

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

Constructor Detail

UserLog

public UserLog()

Method Detail

UserLog

public void UserLog()

Construct a UserLog object.

open

public void open(String user,
                 String fileName,
                 String logDirectory)

Open the log file with the input naming parameters.

Parameters:

user - the user id information

serverLogName - the name of the log file

serverLogDir - the directory for the file

Overrides:

open in class Log

open

public void open()

Open the log file with the original name information.

Overrides:

open in class Log

print

public void print(String fromClass,
                  String msg)

Print to the user log.

Parameters:

fromClass - the name of the class calling the print

msg - the text to print

printError

public void printError(Object reporter,
                       int errorSeverity,
                       Throwable excep,
                       String shortDescription,
                       String otherDescription)

Print Errors to the log.

Parameters:

reporter - the object reporting the error

errorSeverity - the Code for the severity of the Error

excep - the Exception object

shortDescription - a short textual description of the error

otherDescription - any text that can add additional information to describe the error.

Overrides:

printError in class Log

getLogfile

public PrintStream getLogfile()

Get the file object.

Overrides:

getLogfile in class Log

setName

public void setName(String id,
                    String logName,
                    String logDir)

Sets the filename for the log file.

Parameters:

id - the user identification string

logName - the filename of the log

logDir - the directory for the log file

Overrides:

setName in class Log

setrollOverTime

public void setrollOverTime(int time)

Sets the userlog rollover time - currently not used.

Parameters:

time - the rollover time in seconds.

Overrides:

setrollOverTime in class Log

rollOver

public void rollOver(long currentTime)

Shuts/Re-opens the user log file - currently not used.

Parameters:

currentTime - the current time in milliseconds.

Overrides:

rollOver in class Log

close

public void close()

Close the user log.

Overrides:

close in class Log