Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.logging.log4j.core.appender.db.jpa
Class JpaAppender

    java.lang.Object
      org.apache.logging.log4j.core.AbstractLifeCycle
          org.apache.logging.log4j.core.filter.AbstractFilterable
              org.apache.logging.log4j.core.appender.AbstractAppender
                  org.apache.logging.log4j.core.appender.db.AbstractDatabaseAppender<JpaDatabaseManager>
                      org.apache.logging.log4j.core.appender.db.jpa.JpaAppender

All Implemented Interfaces:
  Serializable, Appender, Filterable, LifeCycle

    @Plugin(name="JPA",
            category="Core",
            elementType="appender",
            printObject=true)
    public final class JpaAppender

extends AbstractDatabaseAppender<JpaDatabaseManager>

This Appender writes logging events to a relational database using the Java Persistence API. It requires a pre-configured JPA persistence unit and a concrete implementation of the abstract `AbstractLogEventWrapperEntity` class decorated with JPA annotations.

See Also:
  `AbstractLogEventWrapperEntity`, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle
`LifeCycle.State`

Field Summary

Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle
`LOGGER`

Method Summary
`static JpaAppender` | `createAppender(String name, String ignore, Filter filter, String bufferSize, String entityClassName, String persistenceUnitName)` Factory method for creating a JPA appender within the plugin manager.
`String` | `toString()`

Methods inherited from class org.apache.logging.log4j.core.appender.db.AbstractDatabaseAppender
`append, getLayout, getManager, replaceManager, start, stop`

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender
`error, error, error, getHandler, getName, ignoreExceptions, parseInt, setHandler`

Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable
`addFilter, getFilter, hasFilter, isFiltered, removeFilter`

Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle
`equalsImpl, getState, hashCodeImpl, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Methods inherited from interface org.apache.logging.log4j.core.LifeCycle
`getState, isStarted, isStopped`

Method Detail

### toString

    public String toString()

  Overrides:
    `toString` in class `AbstractAppender`

### createAppender

    @PluginFactory
    public static JpaAppender createAppender(@PluginAttribute(value="name")
                                                           String name,
                                                           @PluginAttribute(value="ignoreExceptions")
                                                           String ignore,
                                                           @PluginElement(value="Filter")
                                                           Filter filter,
                                                           @PluginAttribute(value="bufferSize")
                                                           String bufferSize,
                                                           @PluginAttribute(value="entityClassName")
                                                           String entityClassName,
                                                           @PluginAttribute(value="persistenceUnitName")
                                                           String persistenceUnitName)

  Factory method for creating a JPA appender within the plugin manager.

  Parameters:
    `name` - The name of the appender.
    `ignore` - If `"true"` (default) exceptions encountered when appending events are logged; otherwise they are propagated to the caller.
    `filter` - The filter, if any, to use.
    `bufferSize` - If an integer greater than 0, this causes the appender to buffer log events and flush whenever the buffer reaches this size.
    `entityClassName` - The fully qualified name of the concrete `AbstractLogEventWrapperEntity` implementation that has JPA annotations mapping it to a database table.
    `persistenceUnitName` - The name of the JPA persistence unit that should be used for persisting log events.
  Returns:
    a new JPA appender.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 1999-2015 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.