|
Log4j 1.3alpha-6 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Defines the required interface for all Plugin objects.
A plugin implements some specific functionality to extend the log4j framework. Each plugin is associated with a specific LoggerRepository, which it then uses/acts upon. The functionality of the plugin is up to the developer.
Examples of plugins are Receiver and Watchdog. Receiver plugins allow for remote logging events to be received and processed by a repository as if the event was sent locally. Watchdog plugins allow for a repository to be reconfigured when some "watched" configuration data changes.
Method Summary | |
void |
addPropertyChangeListener(java.beans.PropertyChangeListener l)
Adds a PropertyChangeListener that will be notified of all property changes. |
void |
addPropertyChangeListener(java.lang.String propertyName,
java.beans.PropertyChangeListener l)
Adds a PropertyChangeListener to this instance which is notified only by changes of the property with name propertyName |
LoggerRepository |
getLoggerRepository()
Gets the logger repository for this plugin. |
java.lang.String |
getName()
Gets the name of the plugin. |
boolean |
isActive()
True if the plugin is active and running. |
boolean |
isEquivalent(Plugin testPlugin)
Returns true if the testPlugin is considered to be "equivalent" to the this plugin. |
void |
removePropertyChangeListener(java.beans.PropertyChangeListener l)
Removes a specific PropertyChangeListener from this instances registry that has been mapped to be notified of all property changes. |
void |
removePropertyChangeListener(java.lang.String propertyName,
java.beans.PropertyChangeListener l)
Removes a specific PropertyChangeListener from this instance's registry which has been previously registered to be notified of only a specific property change. |
void |
setLoggerRepository(LoggerRepository repository)
Sets the logger repository used by this plugin. |
void |
setName(java.lang.String name)
Sets the name of the plugin. |
void |
shutdown()
Call when the plugin should be stopped. |
Methods inherited from interface org.apache.log4j.spi.OptionHandler |
activateOptions |
Method Detail |
public java.lang.String getName()
public void setName(java.lang.String name)
name
- the name of the plugin.public LoggerRepository getLoggerRepository()
public void setLoggerRepository(LoggerRepository repository)
repository
- the logger repository to attach this plugin to.public void addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener l)
propertyName
- the name of the property in standard JavaBean syntax (e.g. for setName(), property="name")l
- public void addPropertyChangeListener(java.beans.PropertyChangeListener l)
l
- The listener to add.public void removePropertyChangeListener(java.beans.PropertyChangeListener l)
l
- The listener to remove.public void removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener l)
propertyName
- l
- public boolean isActive()
public boolean isEquivalent(Plugin testPlugin)
testPlugin
- The plugin to test equivalency against.
public void shutdown()
|
Log4j 1.3alpha-6 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |