com.jalios.jcms.plugin
Class PluginAppender

java.lang.Object
  extended by org.apache.log4j.AppenderSkeleton
      extended by com.jalios.jcms.plugin.PluginAppender
All Implemented Interfaces:
org.apache.log4j.Appender, org.apache.log4j.spi.OptionHandler

public class PluginAppender
extends org.apache.log4j.AppenderSkeleton

A log4j appender that keeps from 5 to 500 LoggingEvent inside a list for each plugins.
It does not need any layout.

 <appender name="JCMS" class="com.jalios.jcms.tools.PluginAppender">
   <param name="MaximumEventNbr" value="20"/>
 </appender>
 

Since:
jcms-5.7.0
Version:
$Revision: 27753 $
Author:
Jean-Philippe Encausse

Field Summary
protected  Map pluginMap
           
static String PREFIX
           
static String REVISION
           
 
Fields inherited from class org.apache.log4j.AppenderSkeleton
closed, errorHandler, headFilter, layout, name, tailFilter, threshold
 
Constructor Summary
PluginAppender()
           
 
Method Summary
protected  void append(org.apache.log4j.spi.LoggingEvent event)
           
 void close()
           
static PluginAppender getLastInstanceCreated()
          Return the last PluginAppender instance that was created.
 List getLoggedEventList(String pluginName)
          Returns a copy of the last logged events matching the given plugin.
 int getMaximumEventNbr()
          Returns the current value of the MaximumEvent option.
 boolean requiresLayout()
           
 void setMaximumEventNbr(int size)
          The MaximumEventNbr option takes a integer between 5 and 500.
 
Methods inherited from class org.apache.log4j.AppenderSkeleton
activateOptions, addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

REVISION

public static final String REVISION
See Also:
Constant Field Values

PREFIX

public static final String PREFIX
See Also:
Constant Field Values

pluginMap

protected Map pluginMap
Constructor Detail

PluginAppender

public PluginAppender()
Method Detail

getLastInstanceCreated

public static PluginAppender getLastInstanceCreated()
Return the last PluginAppender instance that was created.

Returns:
a PluginAppender instance or null if no PluginAppender was build

getLoggedEventList

public List getLoggedEventList(String pluginName)
Returns a copy of the last logged events matching the given plugin.

Parameters:
pluginName - the name of the plugin
Returns:
a new LinkedList of org.apache.log4j.spi.LoggingEvent, the most recent being the first one.

setMaximumEventNbr

public void setMaximumEventNbr(int size)
The MaximumEventNbr option takes a integer between 5 and 500. This integer value determines the maximum number of event kept by this appender.


getMaximumEventNbr

public int getMaximumEventNbr()
Returns the current value of the MaximumEvent option.


append

protected void append(org.apache.log4j.spi.LoggingEvent event)
Specified by:
append in class org.apache.log4j.AppenderSkeleton

requiresLayout

public boolean requiresLayout()

close

public void close()


Copyright © 2001-2010 Jalios SA. All Rights Reserved.