Class JmsAppender
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.mom.JmsAppender
- All Implemented Interfaces:
Appender,Filterable,LocationAware,LifeCycle,LifeCycle2
@Plugin(name="JMS",
category="Core",
elementType="appender",
printObject=true)
@PluginAliases({"JMSQueue","JMSTopic"})
public class JmsAppender
extends AbstractAppender
Generic JMS Appender plugin for both queues and topics. This Appender replaces the previous split ones. However,
configurations set up for the 2.0 version of the JMS appenders will still work.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classJmsAppender.Builder<B extends JmsAppender.Builder<B>>Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle
LifeCycle.State -
Field Summary
FieldsFields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle
DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGERFields inherited from interface org.apache.logging.log4j.core.Appender
ELEMENT_TYPE, EMPTY_ARRAY -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedJmsAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, JmsManager manager) Deprecated.protectedJmsAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, Property[] properties, JmsManager manager) Constructs a new instance. -
Method Summary
Modifier and TypeMethodDescriptionvoidLogs a LogEvent using whatever logic this Appender wishes to use.static JmsAppender.BuilderbooleanCleanup the Filter.Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender
error, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, requiresLocation, setHandler, toSerializable, toStringMethods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable
addFilter, getFilter, getPropertyArray, hasFilter, isFiltered, removeFilter, start, stopMethods 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
-
Field Details
-
manager
-
-
Constructor Details
-
JmsAppender
protected JmsAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, Property[] properties, JmsManager manager) throws javax.jms.JMSException Constructs a new instance.- Throws:
javax.jms.JMSException- not thrown as of 2.9 but retained in the signature for compatibility, will be removed in 3.0
-
JmsAppender
@Deprecated protected JmsAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, JmsManager manager) throws javax.jms.JMSException Deprecated.Constructs a new instance.- Throws:
javax.jms.JMSException- not thrown as of 2.9 but retained in the signature for compatibility, will be removed in 3.0
-
-
Method Details
-
newBuilder
-
append
Description copied from interface:AppenderLogs a LogEvent using whatever logic this Appender wishes to use. It is typically recommended to use a bridge pattern not only for the benefits from decoupling an Appender from its implementation, but it is also handy for sharing resources which may require some form of locking.- Parameters:
event- The LogEvent.
-
getManager
-
stop
Description copied from class:AbstractFilterableCleanup the Filter.- Specified by:
stopin interfaceLifeCycle2- Overrides:
stopin classAbstractFilterable- Parameters:
timeout- the maximum time to waittimeUnit- the time unit of the timeout argument- Returns:
- true if the receiver was stopped cleanly and normally, false otherwise.
-
JmsAppender(String, Filter, Layout, boolean, Property[], JmsManager).