AbstractLogEventWrapperEntity (Apache Log4j Core 2.3 API)

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 AbstractLogEventWrapperEntity

java.lang.Object
  org.apache.logging.log4j.core.appender.db.jpa.AbstractLogEventWrapperEntity

All Implemented Interfaces:: Serializable, LogEvent

Direct Known Subclasses:: BasicLogEventEntity

@MappedSuperclass public abstract class AbstractLogEventWrapperEntity
extends Object
implements LogEvent
extends Object
implements LogEvent

Users of the JPA appender MUST extend this class, using JPA annotations on the concrete class and all of its accessor methods (as needed) to map them to the proper table and columns. Accessors you do not want persisted should be annotated with @Transient. All accessors should call getWrappedEvent() and delegate the call to the underlying event. Users may want to instead extend BasicLogEventEntity, which takes care of all of this for you.

The concrete class must have two constructors: a public no-arg constructor to convince the JPA provider that it's a valid entity, and a public constructor that takes a single event and passes it to the parent class with super(event). Furthermore, the concrete class must be annotated @Entity and @Table and must implement a fully mutable ID property annotated with @Id and @GeneratedValue to tell the JPA provider how to calculate an ID for new events.

Many of the return types of LogEvent methods (e.g., StackTraceElement, Message, Marker, Throwable, ThreadContext.ContextStack, and Map<String, String>) will not be recognized by the JPA provider. In conjunction with @Convert, you can use the converters in the org.apache.logging.log4j.core.appender.db.jpa.converter package to convert these types to database columns. If you want to retrieve log events from the database, you can create a true POJO entity and also use these converters for extracting persisted values.

The mutator methods in this class not specified in LogEvent are no-op methods, implemented to satisfy the JPA requirement that accessor methods have matching mutator methods. If you create additional accessor methods, you must likewise create matching no-op mutator methods.

See Also:: BasicLogEventEntity, Serialized Form

Constructor Summary
`protected`	`AbstractLogEventWrapperEntity()` Instantiates this base class.
`protected`	`AbstractLogEventWrapperEntity(LogEvent wrappedEvent)` Instantiates this base class.

Method Summary
`protected LogEvent`	`getWrappedEvent()` All eventual accessor methods must call this method and delegate the method call to the underlying wrapped event.
`boolean`	`isEndOfBatch()` Indicates whether this event is the last one in a batch.
`boolean`	`isIncludeLocation()` Indicates whether the source of the logging request is required downstream.
`void`	`setContextMap(Map<String,String> contextMap)` A no-op mutator to satisfy JPA requirements, as this entity is write-only.
`void`	`setContextStack(org.apache.logging.log4j.ThreadContext.ContextStack contextStack)` A no-op mutator to satisfy JPA requirements, as this entity is write-only.
`void`	`setEndOfBatch(boolean endOfBatch)` Sets whether this event is the last one in a batch.
`void`	`setIncludeLocation(boolean locationRequired)` Sets whether the source of the logging request is required downstream.
`void`	`setLevel(org.apache.logging.log4j.Level level)` A no-op mutator to satisfy JPA requirements, as this entity is write-only.
`void`	`setLoggerFqcn(String fqcn)` A no-op mutator to satisfy JPA requirements, as this entity is write-only.
`void`	`setLoggerName(String loggerName)` A no-op mutator to satisfy JPA requirements, as this entity is write-only.
`void`	`setMarker(org.apache.logging.log4j.Marker marker)` A no-op mutator to satisfy JPA requirements, as this entity is write-only.
`void`	`setMessage(org.apache.logging.log4j.message.Message message)` A no-op mutator to satisfy JPA requirements, as this entity is write-only.
`void`	`setSource(StackTraceElement source)` A no-op mutator to satisfy JPA requirements, as this entity is write-only.
`void`	`setThreadName(String threadName)` A no-op mutator to satisfy JPA requirements, as this entity is write-only.
`void`	`setThrown(Throwable throwable)` A no-op mutator to satisfy JPA requirements, as this entity is write-only.
`void`	`setTimeMillis(long millis)` A no-op mutator to satisfy JPA requirements, as this entity is write-only.

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

Methods inherited from interface org.apache.logging.log4j.core.LogEvent
`getContextMap, getContextStack, getLevel, getLoggerFqcn, getLoggerName, getMarker, getMessage, getSource, getThreadName, getThrown, getThrownProxy, getTimeMillis`

Constructor Detail

AbstractLogEventWrapperEntity

protected AbstractLogEventWrapperEntity()

Instantiates this base class. All concrete implementations must have a constructor matching this constructor's signature. The no-argument constructor is required for a standards-compliant JPA provider to accept this as an entity.

AbstractLogEventWrapperEntity

protected AbstractLogEventWrapperEntity(LogEvent wrappedEvent)

Instantiates this base class. All concrete implementations must have a constructor matching this constructor's signature. This constructor is used for wrapping this entity around a logged event.

Parameters:: wrappedEvent - The underlying event from which information is obtained.

Method Detail

getWrappedEvent

protected final LogEvent getWrappedEvent()

All eventual accessor methods must call this method and delegate the method call to the underlying wrapped event. Annotated Transient so as not to be included in the persisted entity.

Returns:: The underlying event from which information is obtained.