com.norconex.jef4.log

Interface ILogManager

All Superinterfaces:

com.norconex.commons.lang.config.IXMLConfigurable

All Known Implementing Classes:

FileLogManager, NoLogManager

public interface ILogManager
extends com.norconex.commons.lang.config.IXMLConfigurable

Class responsible for everything that relates to the underlying logging mechanism.

When saving as XML, the tag name must be called "logManager".

Author:

Pascal Essiembre

Method Summary

Modifier and Type	Method and Description
void	backup(String namespace, Date backupDate) Backups the log for the given name space, and time stamps it with the given date.
Appender	createAppender(String namespace) Creates a Log4J appender for the given name space.
InputStream	getLog(String namespace) Gets the log for the given namespace.
InputStream	getLog(String namespace, String jobId) Gets the log for the given namespace and job identifier.

Methods inherited from interface com.norconex.commons.lang.config.IXMLConfigurable

loadFromXML, saveToXML

Method Detail

createAppender

Appender createAppender(String namespace)
                 throws IOException

Creates a Log4J appender for the given name space.

Parameters:

namespace - namespace of the executing context

Returns:

an appender

Throws:

IOException - problem creating the appender

getLog

InputStream getLog(String namespace)
            throws IOException

Gets the log for the given namespace.

Parameters:

namespace - namespace of the executing context

Returns:

the log

Throws:

IOException - problem getting log

getLog

InputStream getLog(String namespace,
                   String jobId)
            throws IOException

Gets the log for the given namespace and job identifier.

Parameters:

namespace - namespace of the executing context

jobId - job identifier

Returns:

the log

Throws:

IOException - problem getting log

backup

void backup(String namespace,
            Date backupDate)
     throws IOException

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.

Parameters:

namespace - namespace of the executing context

backupDate - date of this backup

Throws:

IOException - problem creating backup