org.oddjob.logging
Interface ConsoleArchiver

All Known Implementing Classes:
JMXClientJob, LocalConsoleArchiver, RemoteLogPoller

public interface ConsoleArchiver

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


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

Method Detail

addConsoleListener

void addConsoleListener(LogListener l,
                        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 recieve the events.
component - The component whose console to receive events for.
last - The last event number recieved. 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,
                           Object component)
Remove the LogListener.

Parameters:
l - The LogListener.

consoleIdFor

String consoleIdFor(Object component)
Get the console id for a given component.

Parameters:
component - The component.
Returns:
The console id.