Class JmsResourceHolder

java.lang.Object
org.springframework.transaction.support.ResourceHolderSupport
org.springframework.jms.connection.JmsResourceHolder
All Implemented Interfaces:
org.springframework.transaction.support.ResourceHolder
public class JmsResourceHolder extends org.springframework.transaction.support.ResourceHolderSupport
Resource holder wrapping a JMS Connection and a JMS Session. JmsTransactionManager binds instances of this class to the thread, for a given JMS ConnectionFactory.

Note: This is an SPI class, not intended to be used by applications.

Since:
1.1
Author:
Juergen Hoeller
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    JmsResourceHolder()
    Create a new JmsResourceHolder that is open for resources to be added.
    JmsResourceHolder(@Nullable jakarta.jms.ConnectionFactory connectionFactory)
    Create a new JmsResourceHolder that is open for resources to be added.
    JmsResourceHolder(@Nullable jakarta.jms.ConnectionFactory connectionFactory, jakarta.jms.Connection connection, jakarta.jms.Session session)
    Create a new JmsResourceHolder for the given JMS resources.
    JmsResourceHolder(jakarta.jms.Connection connection, jakarta.jms.Session session)
    Create a new JmsResourceHolder for the given JMS resources.
    JmsResourceHolder(jakarta.jms.Session session)
    Create a new JmsResourceHolder for the given JMS Session.

  • Method Summary

    Modifier and Type
    Method
    Description
    final void
    addConnection(jakarta.jms.Connection connection)
    Add the given Connection to this resource holder.
    final void
    addSession(jakarta.jms.Session session)
    Add the given Session to this resource holder.
    final void
    addSession(jakarta.jms.Session session, @Nullable jakarta.jms.Connection connection)
    Add the given Session to this resource holder, registered for a specific Connection.
    void
    closeAll()
    Close all of this resource holder's Sessions and clear its state.
    void
    commitAll()
    Commit all of this resource holder's Sessions.
    boolean
    containsSession(jakarta.jms.Session session)
    Determine whether the given Session is registered with this resource holder.
    @Nullable jakarta.jms.Connection
    getConnection()
    Return this resource holder's default Connection, or null if none.
    <C extends jakarta.jms.Connection>
    @Nullable C
    getConnection(Class<C> connectionType)
    Return this resource holder's Connection of the given type, or null if none.
    @Nullable jakarta.jms.Session
    getSession()
    Return this resource holder's default Session, or null if none.
    <S extends jakarta.jms.Session>
    @Nullable S
    getSession(Class<S> sessionType)
    Return this resource holder's Session of the given type, or null if none.
    <S extends jakarta.jms.Session>
    @Nullable S
    getSession(Class<S> sessionType, @Nullable jakarta.jms.Connection connection)
    Return this resource holder's Session of the given type for the given connection, or null if none.
    final boolean
    isFrozen()
    Return whether this resource holder is frozen, i.e.

    Methods inherited from class org.springframework.transaction.support.ResourceHolderSupport

    clear, getDeadline, getTimeToLiveInMillis, getTimeToLiveInSeconds, hasTimeout, isOpen, isRollbackOnly, isSynchronizedWithTransaction, isVoid, released, requested, reset, resetRollbackOnly, setRollbackOnly, setSynchronizedWithTransaction, setTimeoutInMillis, setTimeoutInSeconds, unbound

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • JmsResourceHolder

      public JmsResourceHolder()
      Create a new JmsResourceHolder that is open for resources to be added.
      See Also:

    • JmsResourceHolder

      public JmsResourceHolder(@Nullable jakarta.jms.ConnectionFactory connectionFactory)
      Create a new JmsResourceHolder that is open for resources to be added.
      Parameters:
      connectionFactory - the JMS ConnectionFactory that this resource holder is associated with (may be null)

    • JmsResourceHolder

      public JmsResourceHolder(jakarta.jms.Session session)
      Create a new JmsResourceHolder for the given JMS Session.
      Parameters:
      session - the JMS Session

    • JmsResourceHolder

      public JmsResourceHolder(jakarta.jms.Connection connection, jakarta.jms.Session session)
      Create a new JmsResourceHolder for the given JMS resources.
      Parameters:
      connection - the JMS Connection
      session - the JMS Session

    • JmsResourceHolder

      public JmsResourceHolder(@Nullable jakarta.jms.ConnectionFactory connectionFactory, jakarta.jms.Connection connection, jakarta.jms.Session session)
      Create a new JmsResourceHolder for the given JMS resources.
      Parameters:
      connectionFactory - the JMS ConnectionFactory that this resource holder is associated with (may be null)
      connection - the JMS Connection
      session - the JMS Session

  • Method Details

    • isFrozen

      public final boolean isFrozen()
      Return whether this resource holder is frozen, i.e. does not allow for adding further Connections and Sessions to it.
      See Also:

    • addConnection

      public final void addConnection(jakarta.jms.Connection connection)
      Add the given Connection to this resource holder.

    • addSession

      public final void addSession(jakarta.jms.Session session)
      Add the given Session to this resource holder.

    • addSession

      public final void addSession(jakarta.jms.Session session, @Nullable jakarta.jms.Connection connection)
      Add the given Session to this resource holder, registered for a specific Connection.

    • containsSession

      public boolean containsSession(jakarta.jms.Session session)
      Determine whether the given Session is registered with this resource holder.

    • getConnection

      public @Nullable jakarta.jms.Connection getConnection()
      Return this resource holder's default Connection, or null if none.

    • getConnection

      public <C extends jakarta.jms.Connection> @Nullable C getConnection(Class<C> connectionType)
      Return this resource holder's Connection of the given type, or null if none.

    • getSession

      public @Nullable jakarta.jms.Session getSession()
      Return this resource holder's default Session, or null if none.

    • getSession

      public <S extends jakarta.jms.Session> @Nullable S getSession(Class<S> sessionType)
      Return this resource holder's Session of the given type, or null if none.

    • getSession

      public <S extends jakarta.jms.Session> @Nullable S getSession(Class<S> sessionType, @Nullable jakarta.jms.Connection connection)
      Return this resource holder's Session of the given type for the given connection, or null if none.

    • commitAll

      public void commitAll() throws jakarta.jms.JMSException
      Commit all of this resource holder's Sessions.
      Throws:
      jakarta.jms.JMSException - if thrown from a Session commit attempt
      See Also:
      • Session.commit()

    • closeAll

      public void closeAll()
      Close all of this resource holder's Sessions and clear its state.
      See Also:
      • Session.close()