Interface LogReaderService
-
public interface LogReaderService
Provides methods to retrieveLogEntry
objects from the log.There are two ways to retrieve
LogEntry
objects:- The primary way to retrieve
LogEntry
objects is to register aLogListener
object whoseLogListener.logged
method will be called for each entry added to the log. - To retrieve past
LogEntry
objects, thegetLog
method can be called which will return anEnumeration
of allLogEntry
objects in the log.
- Version:
- $Revision: 5654 $
- See Also:
LogEntry
,LogListener
,LogListener.logged(LogEntry)
- The primary way to retrieve
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addLogListener(LogListener listener)
Subscribes toLogEntry
objects.java.util.Enumeration
getLog()
Returns anEnumeration
of allLogEntry
objects in the log.void
removeLogListener(LogListener listener)
Unsubscribes toLogEntry
objects.
-
-
-
Method Detail
-
addLogListener
void addLogListener(LogListener listener)
Subscribes toLogEntry
objects.This method registers a
LogListener
object with the Log Reader Service. TheLogListener.logged(LogEntry)
method will be called for eachLogEntry
object placed into the log.When a bundle which registers a
LogListener
object is stopped or otherwise releases the Log Reader Service, the Log Reader Service must remove all of the bundle's listeners.If this Log Reader Service's list of listeners already contains a listener
l
such that(l==listener)
, this method does nothing.- Parameters:
listener
- ALogListener
object to register; theLogListener
object is used to receiveLogEntry
objects.- See Also:
LogListener
,LogEntry
,LogListener.logged(LogEntry)
-
removeLogListener
void removeLogListener(LogListener listener)
Unsubscribes toLogEntry
objects.This method unregisters a
LogListener
object from the Log Reader Service.If
listener
is not contained in this Log Reader Service's list of listeners, this method does nothing.- Parameters:
listener
- ALogListener
object to unregister.- See Also:
LogListener
-
getLog
java.util.Enumeration getLog()
Returns anEnumeration
of allLogEntry
objects in the log.Each element of the enumeration is a
LogEntry
object, ordered with the most recent entry first. Whether the enumeration is of allLogEntry
objects since the Log Service was started or some recent past is implementation-specific. Also implementation-specific is whether informational and debugLogEntry
objects are included in the enumeration.- Returns:
- An
Enumeration
of allLogEntry
objects in the log.
-
-