net.sf.logdistiller
Class LogDistillation

java.lang.Object
  net.sf.logdistiller.LogDistillation

All Implemented Interfaces:

Serializable

public class LogDistillation
extends Object
implements Serializable

The class executing a log distillation, using a log distiller, and processing every log events. A log distillation can be run either with LogDistiller's GUI or with Ant tasks.

See Also:

LogDistiller, Serialized Form

Nested Class Summary

static class	LogDistillation.Category
class	LogDistillation.Group
static class	LogDistillation.Plugin

Field Summary

static String

LINE_SEPARATOR

Constructor Summary

LogDistillation(LogDistiller ld)

Method Summary

void	begin() begin the distillation
void	end() end the distillation
long	getBeginTime()
LogDistillation.Category[]	getCategories()
LogDistillation.Category	getCategory(String id)
String	getContent()
LogDistiller	getDefinition()
long	getEndTime()
long	getEventBytes()
int	getEventCount()
LogDistillation.Group	getGroup(String id)
LogDistillation.Group[]	getGroups()
LogType.Description	getLogTypeDescription()
long	getSkippedEventBytes()
int	getSkippedEventCount()
String	getVersion() What is the version of LogDistiller that was used to create this instance?
List	listCategoriesToReport()
List	listGroupsToReport()
File	newDestinationFile(String filename)
void	processLogEvent(LogEvent le) Process a log event
void	saveTo(File file) Saves the distillation to a file, in Java serialized format.
void	saveTo(OutputStream out)

Methods inherited from class java.lang.Object

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

Field Detail

LINE_SEPARATOR

public static final String LINE_SEPARATOR

Constructor Detail

LogDistillation

public LogDistillation(LogDistiller ld)

Method Detail

begin

public void begin()
           throws IOException

begin the distillation

Throws:

IOException

processLogEvent

public void processLogEvent(LogEvent le)
                     throws IOException

Process a log event

Parameters:

le - LogEvent the log event

Throws:

IOException - if an error occurs when (eventually) saving the log event

end

public void end()
         throws IOException

end the distillation

Throws:

IOException - if an error occurs when closing the files where log events were (eventually) saved

saveTo

public void saveTo(File file)
            throws IOException

Saves the distillation to a file, in Java serialized format.

Parameters:

file - File destination file.

Throws:

IOException

saveTo

public void saveTo(OutputStream out)
            throws IOException

Throws:

IOException

listCategoriesToReport

public List listCategoriesToReport()

listGroupsToReport

public List listGroupsToReport()

getDefinition

public LogDistiller getDefinition()

getGroups

public LogDistillation.Group[] getGroups()

getGroup

public LogDistillation.Group getGroup(String id)

getCategories

public LogDistillation.Category[] getCategories()

getCategory

public LogDistillation.Category getCategory(String id)

getContent

public String getContent()

getEventCount

public int getEventCount()

getEventBytes

public long getEventBytes()

getBeginTime

public long getBeginTime()

getEndTime

public long getEndTime()

getSkippedEventCount

public int getSkippedEventCount()

getSkippedEventBytes

public long getSkippedEventBytes()

newDestinationFile

public File newDestinationFile(String filename)

getLogTypeDescription

public LogType.Description getLogTypeDescription()

getVersion

public String getVersion()

What is the version of LogDistiller that was used to create this instance?

Returns:

String the version