Class LogEventListener

java.lang.Object
com.netscape.certsrv.logging.LogEventListener
All Implemented Interfaces:
EventListener
Direct Known Subclasses:
LogFile
public abstract class LogEventListener extends Object implements EventListener
A class representing a log event listener. A LogEventListener 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$

  • Field Details

  • Constructor Details

    • LogEventListener

      public LogEventListener()

  • Method Details

    • getCMSEngine

      public CMSEngine getCMSEngine()

    • setCMSEngine

      public void setCMSEngine(CMSEngine engine)

    • log

      public abstract void log(LogEvent event) throws ELogException
      The event notification method: Logs event.
      Parameters:
      event - The log event to be processed.
      Throws:
      ELogException

    • flush

      public abstract void flush()
      Flushes the log buffers (if any). Will result in the messages being actually written to their destination.

    • shutdown

      public abstract void shutdown()
      Closes the log file and destroys any associated threads.

    • getConfigStore

      public abstract ConfigStore getConfigStore()
      Get the configuration store for the log event listener.
      Returns:
      The configuration store of this log event listener.

    • init

      public abstract void init(Subsystem owner, LoggerConfig config) throws EBaseException
      Initialize this log listener
      Parameters:
      owner - The subsystem.
      config - Configuration store for this log listener.

    • startup

      public abstract void startup() throws EBaseException
      Startup the instance.
      Throws:
      EBaseException

    • retrieveLogContent

      public abstract NameValuePairs retrieveLogContent(Hashtable<String,String> req) throws jakarta.servlet.ServletException, IOException, EBaseException
      Retrieve 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:
      jakarta.servlet.ServletException - For servlet errors.
      IOException - For input/output problems.
      EBaseException - For other problems.

    • retrieveLogList

      public abstract NameValuePairs retrieveLogList(Hashtable<String,String> req) throws jakarta.servlet.ServletException, IOException, EBaseException
      Retrieve list of log files.
      Throws:
      jakarta.servlet.ServletException
      IOException
      EBaseException

    • getImplName

      public abstract String getImplName()
      Returns implementation name.
      Returns:
      String name of event listener implementation.

    • getDescription

      public abstract String getDescription()
      Returns the description of this log event listener.
      Returns:
      String with listener description.

    • getDefaultParams

      public abstract Vector<String> getDefaultParams()
      Return list of default config parameters for this log event listener.
      Returns:
      Vector of default parameters.

    • getInstanceParams

      public abstract Vector<String> getInstanceParams()
      Return list of instance config parameters for this log event listener.
      Returns:
      Vector of instance parameters.