com.norconex.jef4.log

Class NoLogManager

java.lang.Object

com.norconex.jef4.log.NoLogManager

All Implemented Interfaces:

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

public class NoLogManager
extends Object
implements ILogManager

Use this log manager if you do not want JEF to manage logs. Only the settings defined through usual Log4j customization will take effect.

Side effect: Disabling log management means JEF will no longer produce its own log files and automated log backups. It also means it has no way to report on logs through its API. This may affect integration with other tools such as JEF Monitor.

A typical use case for disabling JEF log management is to use console logging only, or have your own file rotation stategy.

XML configuration usage:

  <logManager class="com.norconex.jef4.log.NoLogManager"/>
 

Since:

4.1.2

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
NoLogManager()

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.
boolean	equals(Object other)
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.
int	hashCode()
void	loadFromXML(Reader in)
void	saveToXML(Writer out)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NoLogManager

public NoLogManager()

Method Detail

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

createAppender

public Appender createAppender(String namespace)
                        throws IOException

Description copied from interface: ILogManager

Creates a Log4J appender for the given name space.

Specified by:

createAppender in interface ILogManager

Parameters:

namespace - namespace of the executing context

Returns:

an appender

Throws:

IOException - problem creating the appender

getLog

public InputStream getLog(String namespace)
                   throws IOException

Description copied from interface: ILogManager

Gets the log for the given namespace.

Specified by:

getLog in interface ILogManager

Parameters:

namespace - namespace of the executing context

Returns:

the log

Throws:

IOException - problem getting log

getLog

public InputStream getLog(String namespace,
                          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:

namespace - namespace of the executing context

jobId - job identifier

Returns:

the log

Throws:

IOException - problem getting log

backup

public void backup(String namespace,
                   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:

namespace - namespace of the executing context

backupDate - date of this backup

Throws:

IOException - problem creating backup

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