com.norconex.jef4.log

Class FileLogManager

java.lang.Object

com.norconex.jef4.log.FileLogManager

All Implemented Interfaces:

com.norconex.commons.lang.config.IXMLConfigurable, ILogManager

public class FileLogManager
extends Object
implements ILogManager

Log manager using the file system to store its logs. When no log directory is explicitly set, it defaults to: <user.home>/Norconex/jef/workdir

XML configuration usage:

  <logManager class="com.norconex.jef4.log.FileLogManager">
      <logDir>(directory where to store logs)</logDir>
  </logManager>
 

Usage example:

The following example indicates logs should be stored in this directory: /tmp/jeflogs

  <logManager class="com.norconex.jef4.log.FileLogManager">
      <logDir>/tmp/jeflogs</logDir>
  </logManager>
 

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
FileLogManager() Constructor using default log directory location.
FileLogManager(String logdir) Creates a new FileLogManager, wrapping the given layout into a ThreadSafeLayout.

Method Summary

Modifier and Type	Method and Description
void	backup(String suiteId, Date backupDate) Backups the log for the given name space, and time stamps it with the given date.
Appender	createAppender(String suiteId) Creates a Log4J appender for the given name space.
boolean	equals(Object other)
InputStream	getLog(String suiteId) Gets the log for the given namespace.
InputStream	getLog(String suiteId, String jobId) Gets the log for the given namespace and job identifier.
String	getLogDirectory()
File	getLogFile(String suiteId) Gets the log file used by this log manager.
int	hashCode()
void	loadFromXML(Reader in)
void	saveToXML(Writer out)
void	setLogDirectory(String logdir)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FileLogManager

public FileLogManager()

Constructor using default log directory location.

FileLogManager

public FileLogManager(String logdir)

Creates a new FileLogManager, wrapping the given layout into a ThreadSafeLayout.

Parameters:

logdir - base directory where the log should be stored

Method Detail

getLogDirectory

public String getLogDirectory()

setLogDirectory

public void setLogDirectory(String logdir)

createAppender

public final Appender createAppender(String suiteId)
                              throws IOException

Description copied from interface: ILogManager

Creates a Log4J appender for the given name space.

Specified by:

createAppender in interface ILogManager

Parameters:

suiteId - namespace of the executing context

Returns:

an appender

Throws:

IOException - problem creating the appender

backup

public final void backup(String suiteId,
                         Date backupDate)
                  throws IOException

Description copied from interface: ILogManager

Backups the log for the given name space, and time stamps it with the given date. A backed-up log can no longer be retrieved by the getLog(String) method.

Specified by:

backup in interface ILogManager

Parameters:

suiteId - namespace of the executing context

backupDate - date of this backup

Throws:

IOException - problem creating backup

getLog

public final InputStream getLog(String suiteId)
                         throws IOException

Description copied from interface: ILogManager

Gets the log for the given namespace.

Specified by:

getLog in interface ILogManager

Parameters:

suiteId - namespace of the executing context

Returns:

the log

Throws:

IOException - problem getting log

getLog

public InputStream getLog(String suiteId,
                          String jobId)
                   throws IOException

Description copied from interface: ILogManager

Gets the log for the given namespace and job identifier.

Specified by:

getLog in interface ILogManager

Parameters:

suiteId - namespace of the executing context

jobId - job identifier

Returns:

the log

Throws:

IOException - problem getting log

getLogFile

public File getLogFile(String suiteId)

Gets the log file used by this log manager.

Parameters:

suiteId - log file suiteId

Returns:

log file

loadFromXML

public void loadFromXML(Reader in)
                 throws IOException

Specified by:

loadFromXML in interface com.norconex.commons.lang.config.IXMLConfigurable

Throws:

IOException

saveToXML

public void saveToXML(Writer out)
               throws IOException

Specified by:

saveToXML in interface com.norconex.commons.lang.config.IXMLConfigurable

Throws:

IOException

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object