Package org.apache.logging.log4j.core.appender.mom.jakarta

Class JmsManager

java.lang.Object
org.apache.logging.log4j.core.appender.AbstractManager
org.apache.logging.log4j.core.appender.mom.jakarta.JmsManager
All Implemented Interfaces:
AutoCloseable
public final class JmsManager extends AbstractManager
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.

  • Field Details

    • FACTORY

      static final JmsManager.JmsManagerFactory FACTORY

    • configuration

      private final JmsManager.JmsManagerConfiguration configuration

    • reconnector

      private volatile JmsManager.Reconnector reconnector

    • jndiManager

      private volatile JndiManager jndiManager

    • connection

      private volatile jakarta.jms.Connection connection

    • session

      private volatile jakarta.jms.Session session

    • destination

      private volatile jakarta.jms.Destination destination

    • messageProducer

      private volatile jakarta.jms.MessageProducer messageProducer

  • Constructor Details

  • 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 the ConnectionFactory.
      destinationName - The binding name for the Destination.
      userName - The userName to connect with or null for no authentication.
      password - The password to use with the given userName or null for no authentication.
      immediateFail - Whether or not to fail immediately with a AppenderLoggingException 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 jakarta.jms.Connection createConnection(JndiManager jndiManager) throws NamingException, jakarta.jms.JMSException
      Throws:
      NamingException
      jakarta.jms.JMSException

    • createDestination

      private jakarta.jms.Destination createDestination(JndiManager jndiManager) throws NamingException
      Throws:
      NamingException

    • createMessage

      private jakarta.jms.Message createMessage(Serializable object) throws jakarta.jms.JMSException
      Creates a TextMessage, MapMessage, or ObjectMessage from a Serializable object.

      For instance, when using a text-based Layout such as PatternLayout, the LogEvent 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:
      jakarta.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 jakarta.jms.JMSException
      Throws:
      jakarta.jms.JMSException

    • createMessageProducer

      private jakarta.jms.MessageProducer createMessageProducer(jakarta.jms.Session session, jakarta.jms.Destination destination) throws jakarta.jms.JMSException
      Creates a MessageProducer on this Destination using the current Session.
      Parameters:
      session - The JMS Session to use to create the MessageProducer
      destination - The JMS Destination for the MessageProducer
      Returns:
      A MessageProducer on this Destination.
      Throws:
      jakarta.jms.JMSException - if the session fails to create a MessageProducer due to some internal error.

    • createReconnector

      private JmsManager.Reconnector createReconnector()

    • createSession

      private jakarta.jms.Session createSession(jakarta.jms.Connection connection) throws jakarta.jms.JMSException
      Throws:
      jakarta.jms.JMSException

    • getJmsManagerConfiguration

      public JmsManager.JmsManagerConfiguration getJmsManagerConfiguration()

    • getJndiManager

      JndiManager getJndiManager()

    • lookup

      <T> T lookup(String destinationName) throws NamingException
      Throws:
      NamingException

    • map

      private jakarta.jms.MapMessage map(MapMessage<?,?> log4jMapMessage, jakarta.jms.MapMessage jmsMapMessage)

    • releaseSub

      protected boolean releaseSub(long timeout, TimeUnit timeUnit)
      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 class AbstractManager
      Parameters:
      timeout - timeout
      timeUnit - timeout time unit
      Returns:
      true if all resources were closed normally, false otherwise.

    • send

      void send(LogEvent event, Serializable serializable)