## Uses of Interface
org.apache.log4j.plugins.Plugin

- Packages that use Plugin
  Package | Description
  --- | ---
  org.apache.log4j.chainsaw |
  org.apache.log4j.chainsaw.plugins |
  org.apache.log4j.chainsaw.receivers |
  org.apache.log4j.chainsaw.vfs |
  org.apache.log4j.chainsaw.zeroconf |
  org.apache.log4j.db | The org.apache.log4j.db package provides means to append logging events into various databases.
  org.apache.log4j.net |
  org.apache.log4j.plugins |
  org.apache.log4j.varia |
  org.apache.log4j.xml |

- - ### Uses of Plugin in org.apache.log4j.chainsaw

    Classes in org.apache.log4j.chainsaw that implement Plugin
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `Generator` | Class designed to stress, and/or test the Chainsaw GUI by sending it lots of Logging Events.

  - ### Uses of Plugin in org.apache.log4j.chainsaw.plugins

    Classes in org.apache.log4j.chainsaw.plugins that implement Plugin
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `GUIPluginSkeleton` |

    Methods in org.apache.log4j.chainsaw.plugins with parameters of type Plugin
    Modifier and Type | Method | Description
    --- | --- | ---
    `boolean` | GUIPluginSkeleton.`isEquivalent​(Plugin testPlugin)` |

  - ### Uses of Plugin in org.apache.log4j.chainsaw.receivers

    Methods in org.apache.log4j.chainsaw.receivers that return Plugin
    Modifier and Type | Method | Description
    --- | --- | ---
    `Plugin` | NewReceiverDialogPanel.`getPlugin()` |
    `Plugin` | PluginPropertyEditorPanel.`getPlugin()` |

    Methods in org.apache.log4j.chainsaw.receivers with parameters of type Plugin
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | PluginPropertyEditorPanel.`setPlugin​(Plugin plugin)` |

  - ### Uses of Plugin in org.apache.log4j.chainsaw.vfs

    Classes in org.apache.log4j.chainsaw.vfs that implement Plugin
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `VFSLogFilePatternReceiver` | A VFS-enabled version of org.apache.log4j.varia.LogFilePatternReceiver.

  - ### Uses of Plugin in org.apache.log4j.chainsaw.zeroconf

    Classes in org.apache.log4j.chainsaw.zeroconf that implement Plugin
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `ZeroConfPlugin` | This plugin is designed to detect specific Zeroconf zones (Rendevouz/Bonjour, whatever people are calling it) and allow the user to double click on 'devices' to try and connect to them with no configuration needed.

  - ### Uses of Plugin in org.apache.log4j.db

    Classes in org.apache.log4j.db that implement Plugin
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `CustomSQLDBReceiver` | Converts log data stored in a database into LoggingEvents.
    `class` | `DBReceiver` |

  - ### Uses of Plugin in org.apache.log4j.net

    Classes in org.apache.log4j.net that implement Plugin
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `JMSReceiver` | JMSReceiver receives a remote logging event on a configured JSM topic and "posts" it to a LoggerRepository as if the event was generated locally.
    `class` | `MulticastReceiver` | Multicast-based receiver.
    `class` | `UDPReceiver` | Receive LoggingEvents encoded with an XMLLayout, convert the XML data to a LoggingEvent and post the LoggingEvent.
    `class` | `XMLSocketReceiver` | XMLSocketReceiver receives a remote logging event via XML on a configured socket and "posts" it to a LoggerRepository as if the event were generated locally.

    Methods in org.apache.log4j.net with parameters of type Plugin
    Modifier and Type | Method | Description
    --- | --- | ---
    `boolean` | JMSReceiver.`isEquivalent​(Plugin testPlugin)` | Returns true if the receiver is the same class and they are configured for the same properties, and super class also considers them to be equivalent.
    `boolean` | XMLSocketReceiver.`isEquivalent​(Plugin testPlugin)` | Returns true if the receiver is the same class and they are configured for the same properties, and super class also considers them to be equivalent.

  - ### Uses of Plugin in org.apache.log4j.plugins

    Classes in org.apache.log4j.plugins that implement Plugin
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `PluginSkeleton` | A convienent abstract class for plugin subclasses that implements the basic methods of the Plugin interface.
    `class` | `Receiver` | Defines the base class for Receiver plugins.

    Methods in org.apache.log4j.plugins that return Plugin
    Modifier and Type | Method | Description
    --- | --- | ---
    `Plugin` | PluginEvent.`getPlugin()` | Returns the source Plugin of this event, which is simple the getSource() method casted to Plugin for convenience.
    `Plugin` | PluginRegistry.`stopPlugin​(String pluginName)` | Stops a plugin by plugin name and repository.

    Methods in org.apache.log4j.plugins that return types with arguments of type Plugin
    Modifier and Type | Method | Description
    --- | --- | ---
    `List<Plugin>` | PluginRegistry.`getPlugins()` | Returns all the plugins for a given repository.

    Methods in org.apache.log4j.plugins with parameters of type Plugin
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | PluginRegistry.`addPlugin​(Plugin plugin)` | Adds a plugin to the plugin registry.
    `boolean` | Plugin.`isEquivalent​(Plugin testPlugin)` | Returns true if the testPlugin is considered to be "equivalent" to the this plugin.
    `boolean` | PluginSkeleton.`isEquivalent​(Plugin testPlugin)` | Returns true if the plugin has the same name and logger repository as the testPlugin passed in.

  - ### Uses of Plugin in org.apache.log4j.varia

    Classes in org.apache.log4j.varia that implement Plugin
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `LogFilePatternReceiver` | LogFilePatternReceiver can parse and tail log files, converting entries into LoggingEvents.

  - ### Uses of Plugin in org.apache.log4j.xml

    Classes in org.apache.log4j.xml that implement Plugin
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `LogFileXMLReceiver` | LogFileXMLReceiver will read an xml-formated log file and make the events in the log file available to the log4j framework.