com.portal.pcm

Class ErrorLog

java.lang.Object

com.portal.pcm.Log

com.portal.pcm.ErrorLog

public class ErrorLog
extends Log

ErrorLog presents a Java interface for the PCM library error log.

Author:

Larry Lynch-Freshner

Field Summary

Fields

Modifier and Type	Field and Description
static int	All
static int	Assertion
static int	Debug
static int	Dump
static int	Errno
static int	Error
static int	Message
static int	Security
static int	Serious
static int	Warning

Fields inherited from class com.portal.pcm.Log

CONTROL_BY_FLAG, CONTROL_BY_PRIORITY, m_sdf, NEWLINE, NO_LOG_CONTROL, STATE_FLAG_ALL, STATE_FLAG_NONE, STATE_PRIORITY_HIGHEST, STATE_PRIORITY_LOG_ALL, STATE_PRIORITY_LOG_NONE, STATE_PRIORITY_LOWEST

Constructor Summary

Constructors

Constructor and Description
ErrorLog() Constructs an instance of ErrorLog.
ErrorLog(String path) Constructs an instance of ErrorLog from a path.
ErrorLog(String path, String name, int flags) Constructs an instance of ErrorLog from a path, application name, and logging flags.

Method Summary

Modifier and Type	Method and Description
static ErrorLog	getDefaultLog() Returns the default error log object.
void	log(Object src, String message) Logs information to the log file.
void	log(String message) Logs information to the log file.
protected void	openLog()
void	setFlags(int flags) Sets the log flags.
void	setInMemoryFlag(int value) Sets the inMemorylogflag.
void	setInMemorySize(long logsize) Sets the inMemorylogsize.

Methods inherited from class com.portal.pcm.Log

close, controlToString, doLog, getControlState, getControlStyle, getLog, getMessageHeader, getName, isLogInMemory, log, log, log, log, log, setControlState, setControlStyle, setInMemoryFlagValue, setInMemoryLogSize, setName, setNames, setNames, setPath, setWriter

Methods inherited from class java.lang.Object

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

Field Detail

Assertion

public static final int Assertion

See Also:

Constant Field Values

Error

public static final int Error

See Also:

Constant Field Values

Warning

public static final int Warning

See Also:

Constant Field Values

Debug

public static final int Debug

See Also:

Constant Field Values

Errno

public static final int Errno

See Also:

Constant Field Values

Message

public static final int Message

See Also:

Constant Field Values

Dump

public static final int Dump

See Also:

Constant Field Values

Security

public static final int Security

See Also:

Constant Field Values

All

public static final int All

See Also:

Constant Field Values

Serious

public static final int Serious

See Also:

Constant Field Values

Constructor Detail

ErrorLog

public ErrorLog()

Constructs an instance of ErrorLog. By default will log to the current directory using log named javapcm.log.

ErrorLog

public ErrorLog(String path,
                String name,
                int flags)

Constructs an instance of ErrorLog from a path, application name, and logging flags.

Parameters:

path - The path for the log file.

name - The name of the application doing the logging.

flags - Log control flags.

ErrorLog

public ErrorLog(String path)

Constructs an instance of ErrorLog from a path.

Parameters:

path - The path for the log file.

Method Detail

setFlags

public void setFlags(int flags)

Sets the log flags.

Parameters:

flags - The new log flags.

setInMemoryFlag

public void setInMemoryFlag(int value)

Sets the inMemorylogflag.

Parameters:

value - - value

setInMemorySize

public void setInMemorySize(long logsize)

Sets the inMemorylogsize.

Parameters:

logsize - - log size

log

public void log(String message)
         throws IOException

Logs information to the log file.

Parameters:

message - the line to log.

Throws:

IOException

log

public void log(Object src,
                String message)
         throws IOException

Logs information to the log file.

Parameters:

src - If src is a string, it will be used to describe the source. otherwise the name of the object class will be used

message - the line to log.

Throws:

IOException

getDefaultLog

public static ErrorLog getDefaultLog()

Returns the default error log object. This can be used to safely log errors. If used where there is no permission to create files, the log is generated in memory. The log may be read by thread in the current vm.

The default log is controlled by the following properties set in the Infranet.properties file

• log.file: name of the default log file; defaults to javapcm.log
• log.level: valid values are
  • 0: no logging
  • 1: log errors only
  • 2: log errors and warnings
  • 3: log all messages (default)

Returns:

An ErrorLog object representing the default log ('javapcm.log')

Throws:

EBufException - is thrown if an error occurs.

openLog

protected void openLog()

Overrides:

openLog in class Log