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:
Appender
,Filterable
,LifeCycle
,LifeCycle2
@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 abstractAbstractLogEventWrapperEntity
class decorated with JPA annotations.- See Also:
AbstractLogEventWrapperEntity
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.logging.log4j.core.appender.AbstractAppender
AbstractAppender.Builder<B extends AbstractAppender.Builder<B>>
-
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
DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER
-
Fields inherited from interface org.apache.logging.log4j.core.Appender
ELEMENT_TYPE
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static JpaAppender
createAppender(java.lang.String name, java.lang.String ignore, Filter filter, java.lang.String bufferSize, java.lang.String entityClassName, java.lang.String persistenceUnitName)
Factory method for creating a JPA appender within the plugin manager.java.lang.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, stop
-
Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle
equalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, stop, stop
-
-
-
-
Method Detail
-
toString
public java.lang.String toString()
- Overrides:
toString
in classAbstractAppender
-
createAppender
@PluginFactory public static JpaAppender createAppender(@PluginAttribute("name") java.lang.String name, @PluginAttribute("ignoreExceptions") java.lang.String ignore, @PluginElement("Filter") Filter filter, @PluginAttribute("bufferSize") java.lang.String bufferSize, @PluginAttribute("entityClassName") java.lang.String entityClassName, @PluginAttribute("persistenceUnitName") java.lang.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 concreteAbstractLogEventWrapperEntity
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.
-
-