com.adaptris.core

Class FileLogHandler

java.lang.Object

com.adaptris.core.LogHandlerImp

com.adaptris.core.FileLogHandler

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, LogHandler

public class FileLogHandler
extends LogHandlerImp

Zip file based implemention of LogHandler. This LogHandler returns the specified log file (up to maximum of 5Mb) compressed using the GZIP algorithm.

In the adapter configuration file this class is aliased as file-log-handler which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor and Description
FileLogHandler()

Method Summary

Modifier and Type	Method and Description
void	clean() This deletes any files in the log directory older than the clean period.
java.lang.String	getLogDirectory() Get the directory used for logging.
java.lang.String	getLogFile() Return the filename that will be sent as part of the LogRequestEvent.
java.lang.Integer	getPeriod() Get the clean period.
void	prepare() Prepare for initialisation.
void	setLogDirectory(java.lang.String dir) Set the directory that is used for logging.
void	setLogFile(java.lang.String s) The filename that will be sent as part of any LogRequestEvent.
void	setPeriod(java.lang.Integer days) Set the cleaning period.

Methods inherited from class com.adaptris.core.LogHandlerImp

close, getUniqueId, init, setUniqueId, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

FileLogHandler

public FileLogHandler()

Method Detail

clean

public void clean()
           throws java.io.IOException

This deletes any files in the log directory older than the clean period.

Throws:

java.io.IOException - if there was an error.

See Also:

LogHandler.clean()

setLogDirectory

public void setLogDirectory(java.lang.String dir)

Set the directory that is used for logging.

Parameters:

dir - the directory.

getLogDirectory

public java.lang.String getLogDirectory()

Get the directory used for logging.

Returns:

the directory.

setLogFile

public void setLogFile(java.lang.String s)

The filename that will be sent as part of any LogRequestEvent.

Parameters:

s - the file.

getLogFile

public java.lang.String getLogFile()

Return the filename that will be sent as part of the LogRequestEvent.

Returns:

the configured logfile.

setPeriod

public void setPeriod(java.lang.Integer days)

Set the cleaning period. Must be at least one day.

Parameters:

days - the cleaning period in days.

getPeriod

public java.lang.Integer getPeriod()

Get the clean period.

Returns:

the clean period in days.

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Throws:

CoreException