Class JmsManager
java.lang.Object
org.apache.logging.log4j.core.appender.AbstractManager
org.apache.logging.log4j.core.appender.mom.JmsManager
- All Implemented Interfaces:
AutoCloseable
Consider this class private; it is only public for access by integration tests.
JMS connection and session manager. Can be used to access MessageProducer, MessageConsumer, and Message objects involving a configured ConnectionFactory and Destination.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
private static class
private class
Handles reconnecting to JMS on a Thread.Nested classes/interfaces inherited from class org.apache.logging.log4j.core.appender.AbstractManager
AbstractManager.AbstractFactoryData
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final JmsManager.JmsManagerConfiguration
private javax.jms.Connection
private javax.jms.Destination
(package private) static final JmsManager.JmsManagerFactory
private JndiManager
private javax.jms.MessageProducer
private JmsManager.Reconnector
private javax.jms.Session
Fields inherited from class org.apache.logging.log4j.core.appender.AbstractManager
count, LOGGER
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
JmsManager
(String name, JmsManager.JmsManagerConfiguration configuration) -
Method Summary
Modifier and TypeMethodDescriptionprivate boolean
private boolean
private boolean
private boolean
private javax.jms.Connection
createConnection
(JndiManager jndiManager) private javax.jms.Destination
createDestination
(JndiManager jndiManager) javax.jms.Message
createMessage
(Serializable object) Creates a TextMessage, MapMessage, or ObjectMessage from a Serializable object.private void
createMessageAndSend
(LogEvent event, Serializable serializable) javax.jms.MessageConsumer
Creates a MessageConsumer on this Destination using the current Session.javax.jms.MessageProducer
createMessageProducer
(javax.jms.Session session, javax.jms.Destination destination) Creates a MessageProducer on this Destination using the current Session.private JmsManager.Reconnector
private javax.jms.Session
createSession
(javax.jms.Connection connection) static JmsManager
getJmsManager
(String name, Properties jndiProperties, String connectionFactoryName, String destinationName, String userName, char[] password, boolean immediateFail, long reconnectIntervalMillis) Gets a JmsManager using the specified configuration parameters.(package private) JndiManager
(package private) <T> T
private javax.jms.MapMessage
map
(MapMessage<?, ?> log4jMapMessage, javax.jms.MapMessage jmsMapMessage) protected boolean
releaseSub
(long timeout, TimeUnit timeUnit) May be overridden by managers to perform processing while the manager is being released and the lock is held.(package private) void
send
(LogEvent event, Serializable serializable) Methods inherited from class org.apache.logging.log4j.core.appender.AbstractManager
close, getContentFormat, getCount, getLoggerContext, getManager, getName, getStrSubstitutor, hasManager, log, logDebug, logError, logger, logWarn, narrow, release, stop, updateData
-
Field Details
-
FACTORY
-
configuration
-
reconnector
-
jndiManager
-
connection
private volatile javax.jms.Connection connection -
session
private volatile javax.jms.Session session -
destination
private volatile javax.jms.Destination destination -
messageProducer
private volatile javax.jms.MessageProducer messageProducer
-
-
Constructor Details
-
JmsManager
-
-
Method Details
-
getJmsManager
public static JmsManager getJmsManager(String name, Properties jndiProperties, String connectionFactoryName, String destinationName, String userName, char[] password, boolean immediateFail, long reconnectIntervalMillis) Gets a JmsManager using the specified configuration parameters.- Parameters:
name
- The name to use for this JmsManager.jndiProperties
- JNDI properties.connectionFactoryName
- The binding name for theConnectionFactory
.destinationName
- The binding name for theDestination
.userName
- The userName to connect with ornull
for no authentication.password
- The password to use with the given userName ornull
for no authentication.immediateFail
- Whether or not to fail immediately with aAppenderLoggingException
when connecting to JMS fails.reconnectIntervalMillis
- How to log sleep in milliseconds before trying to reconnect to JMS.- Returns:
- The JmsManager as configured.
-
closeConnection
private boolean closeConnection() -
closeJndiManager
private boolean closeJndiManager() -
closeMessageProducer
private boolean closeMessageProducer() -
closeSession
private boolean closeSession() -
createConnection
private javax.jms.Connection createConnection(JndiManager jndiManager) throws NamingException, javax.jms.JMSException - Throws:
NamingException
javax.jms.JMSException
-
createDestination
- Throws:
NamingException
-
createMessage
Creates a TextMessage, MapMessage, or ObjectMessage from a Serializable object.For instance, when using a text-based
Layout
such asPatternLayout
, theLogEvent
message will be serialized to a String.When using a layout such as
SerializedLayout
, the LogEvent message will be serialized as a Java object.When using a layout such as
MessageLayout
and the LogEvent message is a Log4j MapMessage, the message will be serialized as a JMS MapMessage.- Parameters:
object
- The LogEvent or String message to wrap.- Returns:
- A new JMS message containing the provided object.
- Throws:
javax.jms.JMSException
- if the JMS provider fails to create this message due to some internal error.
-
createMessageAndSend
private void createMessageAndSend(LogEvent event, Serializable serializable) throws javax.jms.JMSException - Throws:
javax.jms.JMSException
-
createMessageConsumer
public javax.jms.MessageConsumer createMessageConsumer() throws javax.jms.JMSExceptionCreates a MessageConsumer on this Destination using the current Session.- Returns:
- A MessageConsumer on this Destination.
- Throws:
javax.jms.JMSException
- if the session fails to create a consumer due to some internal error.
-
createMessageProducer
public javax.jms.MessageProducer createMessageProducer(javax.jms.Session session, javax.jms.Destination destination) throws javax.jms.JMSException Creates a MessageProducer on this Destination using the current Session.- Parameters:
session
- The JMS Session to use to create the MessageProducerdestination
- The JMS Destination for the MessageProducer- Returns:
- A MessageProducer on this Destination.
- Throws:
javax.jms.JMSException
- if the session fails to create a MessageProducer due to some internal error.
-
createReconnector
-
createSession
private javax.jms.Session createSession(javax.jms.Connection connection) throws javax.jms.JMSException - Throws:
javax.jms.JMSException
-
getJmsManagerConfiguration
-
getJndiManager
JndiManager getJndiManager() -
lookup
- Throws:
NamingException
-
map
private javax.jms.MapMessage map(MapMessage<?, ?> log4jMapMessage, javax.jms.MapMessage jmsMapMessage) -
releaseSub
Description copied from class:AbstractManager
May be overridden by managers to perform processing while the manager is being released and the lock is held. A timeout is passed for implementors to use as they see fit.- Overrides:
releaseSub
in classAbstractManager
- Parameters:
timeout
- timeouttimeUnit
- timeout time unit- Returns:
- true if all resources were closed normally, false otherwise.
-
send
-