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

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

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

    Classes in org.apache.log4j.component.plugins that implement Plugin
    Modifier and Type | Class and 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.component.plugins that return Plugin
    Modifier and Type | Method and 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.component.plugins with parameters of type Plugin
    Modifier and Type | Method and Description
    --- | ---
    `void` | PluginRegistry.`addPlugin(Plugin plugin)` Adds a plugin to the plugin registry.
    `boolean` | PluginSkeleton.`isEquivalent(Plugin testPlugin)` Returns true if the plugin has the same name and logger repository as the testPlugin passed in.
    `boolean` | Plugin.`isEquivalent(Plugin testPlugin)` Returns true if the testPlugin is considered to be "equivalent" to the this plugin.

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

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

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

    Classes in org.apache.log4j.receivers.net that implement Plugin
    Modifier and Type | Class and 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` | `SocketHubReceiver` SocketHubReceiver receives a remote logging event on a configured socket and "posts" it to a LoggerRepository as if the event was generated locally.
    `class` | `SocketReceiver` SocketReceiver receives a remote logging event on a configured socket and "posts" it to a LoggerRepository as if the event was generated locally.
    `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.receivers.net with parameters of type Plugin
    Modifier and Type | Method and Description
    --- | ---
    `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.
    `boolean` | SocketReceiver.`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` | SocketHubReceiver.`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` | 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.

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

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

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

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

Copyright © 2013 The Apache Software Foundation. Licensed under the Apache License, Version 2.0

Apache Extras for Apache log4j, Apache log4j and Apache are trademarks of the Apache Software Foundation.