Package org.apache.logging.log4j.core.config.plugins.util

Class PluginBuilder

java.lang.Object
org.apache.logging.log4j.core.config.plugins.util.PluginBuilder
All Implemented Interfaces:
Builder<Object>
public class PluginBuilder extends Object implements Builder<Object>
Builder class to instantiate and configure a Plugin object using a PluginFactory method or PluginBuilderFactory builder class.

  • Field Details

    • EMPTY_FIELD_ARRAY

      private static final Field[] EMPTY_FIELD_ARRAY

    • LOGGER

      private static final Logger LOGGER

    • pluginType

      private final PluginType<?> pluginType

    • clazz

      private final Class<?> clazz

    • configuration

      private Configuration configuration

    • node

      private Node node

    • event

      private LogEvent event

  • Constructor Details

    • PluginBuilder

      public PluginBuilder(PluginType<?> pluginType)
      Constructs a PluginBuilder for a given PluginType.
      Parameters:
      pluginType - type of plugin to configure

  • Method Details

    • withConfiguration

      public PluginBuilder withConfiguration(Configuration configuration)
      Specifies the Configuration to use for constructing the plugin instance.
      Parameters:
      configuration - the configuration to use.
      Returns:
      this

    • withConfigurationNode

      public PluginBuilder withConfigurationNode(Node node)
      Specifies the Node corresponding to the plugin object that will be created.
      Parameters:
      node - the plugin configuration node to use.
      Returns:
      this

    • forLogEvent

      public PluginBuilder forLogEvent(LogEvent event)
      Specifies the LogEvent that may be used to provide extra context for string substitutions.
      Parameters:
      event - the event to use for extra information.
      Returns:
      this

    • build

      public Object build()
      Builds the plugin object.
      Specified by:
      build in interface Builder<Object>
      Returns:
      the plugin object or null if there was a problem creating it.

    • verify

      private void verify()

    • createBuilder

      private static Builder<?> createBuilder(Class<?> clazz) throws InvocationTargetException, IllegalAccessException
      Throws:
      InvocationTargetException
      IllegalAccessException

    • injectFields

      private void injectFields(Builder<?> builder) throws IllegalAccessException
      Throws:
      IllegalAccessException

    • validateFields

      private static String validateFields(Builder<?> builder, List<Field> fields) throws IllegalAccessException
      Throws:
      IllegalAccessException

    • validateFields

      public static boolean validateFields(Builder<?> builder, String errorPrefix)

    • simpleName

      private static String simpleName(Object object)
      object.getClass().getSimpleName() returns Builder, when we want PatternLayout$Builder.

    • findFactoryMethod

      private static Method findFactoryMethod(Class<?> clazz)

    • generateParameters

      private Object[] generateParameters(Method factory)

    • extractPluginAliases

      private static String[] extractPluginAliases(Annotation... parmTypes)

    • checkForRemainingAttributes

      private void checkForRemainingAttributes()

    • verifyNodeChildrenUsed

      private void verifyNodeChildrenUsed()