org.oddjob.logging

Interface ConsoleArchiver

All Known Implementing Classes:

JMXClientJob, LocalConsoleArchiver, RemoteLogPoller, WebClientJob

public interface ConsoleArchiver

A ConsoleArchiver is something which has archived away console messages for different consoles.

Method Summary

Modifier and Type	Method and Description
void	addConsoleListener(LogListener l, java.lang.Object component, long last, int max) Add a listener to the archiver which will receive all missed events.
java.lang.String	consoleIdFor(java.lang.Object component) Get the console id for a given component.
void	removeConsoleListener(LogListener l, java.lang.Object component) Remove the LogListener.

Method Detail

addConsoleListener

void addConsoleListener(LogListener l,
                        java.lang.Object component,
                        long last,
                        int max)

Add a listener to the archiver which will receive all missed events. The idea of receiving only missed event is to minimise network traffic when used remotely.

Parameters:

l - The logListener which will receive the events.

component - The component whose console to receive events for.

last - The last event number received. The LogArchive will not send messages from before this number.

max - The maximum messages to send up to the most recent.

removeConsoleListener

void removeConsoleListener(LogListener l,
                           java.lang.Object component)

Remove the LogListener.

Parameters:

l - The LogListener.

consoleIdFor

java.lang.String consoleIdFor(java.lang.Object component)

Get the console id for a given component.

Parameters:

component - The component.

Returns:

The console id.