LogQueue (pki-javadoc)

java.lang.Object
- com.netscape.cms.logging.LogQueue

All Implemented Interfaces:

ILogQueue
```
public class LogQueue
extends java.lang.Object
implements ILogQueue
```
A class represents a log queue.

Version:

$Revision$, $Date$

Author:

mzhao

Field Summary

Fields
Modifier and Type Field Description

protected java.util.Vector<ILogEventListener> mListeners

Constructor Summary

Constructors
Constructor Description

LogQueue()
Constructs a log queue.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addLogEventListener(ILogEventListener listener)`	Adds an event listener.
`void`	`flush()`	Flushes the log buffers (if any)
`static ILogQueue`	`getLogQueue()`
`void`	`init()`	Initializes the log queue.
`void`	`log(ILogEvent event)`	Logs an event, and notifies logger to reuse the event.
`void`	`removeLogEventListener(ILogEventListener listener)`	Removes an event listener.
`void`	`shutdown()`	Stops this log queue: shuts down all registered listeners

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - mListeners
```
protected java.util.Vector<ILogEventListener> mListeners
```
- Constructor Detail
  - LogQueue
```
public LogQueue()
```
    Constructs a log queue.
- Method Detail
  - getLogQueue
```
public static ILogQueue getLogQueue()
```
  - init
```
public void init()
```
    Initializes the log queue.
    
    Specified by:
    
    init in interface ILogQueue
  - shutdown
```
public void shutdown()
```
    Stops this log queue: shuts down all registered listeners
    
    Specified by:
    
    shutdown in interface ILogQueue
  - addLogEventListener
```
public void addLogEventListener(ILogEventListener listener)
```
    Adds an event listener.
    
    Specified by:
    
    addLogEventListener in interface ILogQueue
    
    Parameters:
    
    listener - the log event listener
  - removeLogEventListener
```
public void removeLogEventListener(ILogEventListener listener)
```
    Removes an event listener.
    
    Specified by:
    
    removeLogEventListener in interface ILogQueue
    
    Parameters:
    
    listener - the log event listener
  - log
```
public void log(ILogEvent event)
```
    Logs an event, and notifies logger to reuse the event.
    
    Specified by:
    
    log in interface ILogQueue
    
    Parameters:
    
    event - the log event
  - flush
```
public void flush()
```
    Flushes the log buffers (if any)
    
    Specified by:
    
    flush in interface ILogQueue