Package com.netscape.certsrv.logging
Interface ILogEventListener
- All Superinterfaces:
EventListener
- All Known Implementing Classes:
LogFile
,RollingLogFile
An interface represents a log event listener.
A ILogEventListener is registered to a specific
ILogQueue to be notified of created ILogEvents.
the log queue will notify all its registered listeners
of the logged event. The listener will then proceed to
process the event accordingly which will result in a log
message existing in some file.
- Version:
- $Revision$, $Date$
-
Method Summary
Modifier and TypeMethodDescriptionvoid
flush()
Flushes the log buffers (if any).Get the configuration store for the log event listener.Return list of default config parameters for this log event listener.Returns the description of this log event listener.Returns implementation name.Return list of instance config parameters for this log event listener.void
init
(ISubsystem owner, ConfigStore config) Initialize this log listenervoid
The event notification method: Logs event.Retrieve last "maxLine" number of system logs with log level > "level" and from source "source".retrieveLogList
(Hashtable<String, String> req) Retrieve list of log files.void
shutdown()
Closes the log file and destroys any associated threads.void
startup()
Startup the instance.
-
Method Details
-
log
The event notification method: Logs event.- Parameters:
event
- The log event to be processed.- Throws:
ELogException
-
flush
void flush()Flushes the log buffers (if any). Will result in the messages being actually written to their destination. -
shutdown
void shutdown()Closes the log file and destroys any associated threads. -
getConfigStore
ConfigStore getConfigStore()Get the configuration store for the log event listener.- Returns:
- The configuration store of this log event listener.
-
init
Initialize this log listener- Parameters:
owner
- The subsystem.config
- Configuration store for this log listener.- Throws:
initialization
- error.EBaseException
-
startup
Startup the instance.- Throws:
EBaseException
-
retrieveLogContent
NameValuePairs retrieveLogContent(Hashtable<String, String> req) throws javax.servlet.ServletException, IOException, EBaseExceptionRetrieve last "maxLine" number of system logs with log level > "level" and from source "source". If the parameter is omitted. All entries are sent back.- Parameters:
req
- a Hashtable containing the required information such as log entry, log level, log source, and log name.- Returns:
- NameValue pair list of log messages.
- Throws:
javax.servlet.ServletException
- For servlet errors.IOException
- For input/output problems.EBaseException
- For other problems.
-
retrieveLogList
NameValuePairs retrieveLogList(Hashtable<String, String> req) throws javax.servlet.ServletException, IOException, EBaseExceptionRetrieve list of log files.- Throws:
javax.servlet.ServletException
IOException
EBaseException
-
getImplName
String getImplName()Returns implementation name.- Returns:
- String name of event listener implementation.
-
getDescription
String getDescription()Returns the description of this log event listener.- Returns:
- String with listener description.
-
getDefaultParams
Return list of default config parameters for this log event listener.- Returns:
- Vector of default parameters.
-
getInstanceParams
Return list of instance config parameters for this log event listener.- Returns:
- Vector of instance parameters.
-