Package org.apache.activemq.artemis.ra

Class ActiveMQRASessionFactoryImpl

java.lang.Object

org.apache.activemq.artemis.jms.client.ActiveMQConnectionForContextImpl

org.apache.activemq.artemis.ra.ActiveMQRASessionFactoryImpl

All Implemented Interfaces:

jakarta.jms.Connection, jakarta.jms.QueueConnection, jakarta.jms.TopicConnection, jakarta.jms.XAConnection, jakarta.jms.XAQueueConnection, jakarta.jms.XATopicConnection, jakarta.resource.Referenceable, AutoCloseable, Referenceable, ActiveMQConnectionForContext, ActiveMQRASessionFactory

public final class ActiveMQRASessionFactoryImpl
extends ActiveMQConnectionForContextImpl
implements ActiveMQRASessionFactory, ActiveMQConnectionForContext, jakarta.resource.Referenceable

Implements the JMS Connection API and produces ActiveMQRASession objects.

Field Summary

Fields inherited from class org.apache.activemq.artemis.jms.client.ActiveMQConnectionForContextImpl

threadAwareContext

Fields inherited from interface org.apache.activemq.artemis.ra.ActiveMQRASessionFactory

ISE

Constructor Summary

Constructors

Constructor	Description
ActiveMQRASessionFactoryImpl(ActiveMQRAManagedConnectionFactory mcf, jakarta.resource.spi.ConnectionManager cm, jakarta.transaction.TransactionSynchronizationRegistry tsr, int type)	Constructor

Method Summary

Modifier and Type	Method	Description
void	addTemporaryQueue(jakarta.jms.TemporaryQueue temp)	Add temporary queue
void	addTemporaryTopic(jakarta.jms.TemporaryTopic temp)	Add temporary topic
protected ActiveMQRASession	allocateConnection(boolean transacted, int acknowledgeMode, int sessionType)	Allocate a connection
protected ActiveMQRASession	allocateConnection(int sessionType)	Allocation a connection
protected void	checkClosed()	Check if we are closed
void	close()	Close
void	closeSession(ActiveMQRASession session)	Close session
jakarta.jms.ConnectionConsumer	createConnectionConsumer(jakarta.jms.Destination destination, jakarta.jms.ServerSessionPool pool, int maxMessages)	Create a connection consumer -- throws IllegalStateException
jakarta.jms.ConnectionConsumer	createConnectionConsumer(jakarta.jms.Destination destination, String name, jakarta.jms.ServerSessionPool pool, int maxMessages)	Create a connection consumer -- throws IllegalStateException
jakarta.jms.ConnectionConsumer	createConnectionConsumer(jakarta.jms.Queue queue, String messageSelector, jakarta.jms.ServerSessionPool sessionPool, int maxMessages)	Create a connection consumer -- throws IllegalStateException
jakarta.jms.ConnectionConsumer	createConnectionConsumer(jakarta.jms.Topic topic, String messageSelector, jakarta.jms.ServerSessionPool sessionPool, int maxMessages)	Create a connection consumer -- throws IllegalStateException
jakarta.jms.JMSContext	createContext(int sessionMode)
jakarta.jms.ConnectionConsumer	createDurableConnectionConsumer(jakarta.jms.Topic topic, String subscriptionName, String messageSelector, jakarta.jms.ServerSessionPool sessionPool, int maxMessages)	Create a durable connection consumer -- throws IllegalStateException
jakarta.jms.QueueSession	createQueueSession(boolean transacted, int acknowledgeMode)	Create a queue session
jakarta.jms.Session	createSession()
jakarta.jms.Session	createSession(boolean transacted, int acknowledgeMode)	Create a session
jakarta.jms.Session	createSession(int sessionMode)
jakarta.jms.ConnectionConsumer	createSharedConnectionConsumer(jakarta.jms.Topic topic, String subscriptionName, String messageSelector, jakarta.jms.ServerSessionPool sessionPool, int maxMessages)
jakarta.jms.ConnectionConsumer	createSharedDurableConnectionConsumer(jakarta.jms.Topic topic, String subscriptionName, String messageSelector, jakarta.jms.ServerSessionPool sessionPool, int maxMessages)
jakarta.jms.TopicSession	createTopicSession(boolean transacted, int acknowledgeMode)	Create a topic session
jakarta.jms.XAJMSContext	createXAContext()
jakarta.jms.XAQueueSession	createXAQueueSession()	Create a XA queue session
jakarta.jms.XASession	createXASession()	Create a XA session
jakarta.jms.XATopicSession	createXATopicSession()	Create a XA topic session
String	getClientID()	Get the client ID
jakarta.jms.ExceptionListener	getExceptionListener()	Get the exception listener -- throws IllegalStateException
jakarta.jms.ConnectionMetaData	getMetaData()	Get the connection metadata
Reference	getReference()	Get the naming reference
void	setClientID(String cID)	Set the client ID -- throws IllegalStateException
void	setExceptionListener(jakarta.jms.ExceptionListener listener)	Set the exception listener -- throws IllegalStateException
void	setPassword(String password)	Set the password
void	setReference(Reference reference)	Set the naming reference
void	setUserName(String name)	Set the user name
void	start()	Start
void	stop()	Stop

Methods inherited from class org.apache.activemq.artemis.jms.client.ActiveMQConnectionForContextImpl

closeFromContext, getThreadAwareContext, incrementRefCounter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.activemq.artemis.jms.client.ActiveMQConnectionForContext

closeFromContext

Constructor Detail

ActiveMQRASessionFactoryImpl

public ActiveMQRASessionFactoryImpl(ActiveMQRAManagedConnectionFactory mcf,
                                    jakarta.resource.spi.ConnectionManager cm,
                                    jakarta.transaction.TransactionSynchronizationRegistry tsr,
                                    int type)

Constructor

Parameters:

mcf - The managed connection factory

cm - The connection manager

type - The connection type

Method Detail

createContext

public jakarta.jms.JMSContext createContext(int sessionMode)

Specified by:

createContext in interface ActiveMQConnectionForContext

Overrides:

createContext in class ActiveMQConnectionForContextImpl

createXAContext

public jakarta.jms.XAJMSContext createXAContext()

Specified by:

createXAContext in interface ActiveMQConnectionForContext

Overrides:

createXAContext in class ActiveMQConnectionForContextImpl

setReference

public void setReference(Reference reference)

Set the naming reference

Specified by:

setReference in interface jakarta.resource.Referenceable

Parameters:

reference - The reference

getReference

public Reference getReference()

Get the naming reference

Specified by:

getReference in interface Referenceable

Returns:

The reference

setUserName

public void setUserName(String name)

Set the user name

Parameters:

name - The user name

setPassword

public void setPassword(String password)

Set the password

Parameters:

password - The password

getClientID

public String getClientID()
                   throws jakarta.jms.JMSException

Get the client ID

Specified by:

getClientID in interface jakarta.jms.Connection

Returns:

The client ID

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

setClientID

public void setClientID(String cID)
                 throws jakarta.jms.JMSException

Set the client ID -- throws IllegalStateException

Specified by:

setClientID in interface jakarta.jms.Connection

Parameters:

cID - The client ID

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

createQueueSession

public jakarta.jms.QueueSession createQueueSession(boolean transacted,
                                                   int acknowledgeMode)
                                            throws jakarta.jms.JMSException

Create a queue session

Specified by:

createQueueSession in interface jakarta.jms.QueueConnection

Specified by:

createQueueSession in interface jakarta.jms.XAQueueConnection

Parameters:

transacted - Use transactions

acknowledgeMode - The acknowledge mode

Returns:

The queue session

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

createXAQueueSession

public jakarta.jms.XAQueueSession createXAQueueSession()
                                                throws jakarta.jms.JMSException

Create a XA queue session

Specified by:

createXAQueueSession in interface jakarta.jms.XAQueueConnection

Returns:

The XA queue session

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

createConnectionConsumer

public jakarta.jms.ConnectionConsumer createConnectionConsumer(jakarta.jms.Queue queue,
                                                               String messageSelector,
                                                               jakarta.jms.ServerSessionPool sessionPool,
                                                               int maxMessages)
                                                        throws jakarta.jms.JMSException

Create a connection consumer -- throws IllegalStateException

Specified by:

createConnectionConsumer in interface jakarta.jms.QueueConnection

Parameters:

queue - The queue

messageSelector - The message selector

sessionPool - The session pool

maxMessages - The number of max messages

Returns:

The connection consumer

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

createTopicSession

public jakarta.jms.TopicSession createTopicSession(boolean transacted,
                                                   int acknowledgeMode)
                                            throws jakarta.jms.JMSException

Create a topic session

Specified by:

createTopicSession in interface jakarta.jms.TopicConnection

Specified by:

createTopicSession in interface jakarta.jms.XATopicConnection

Parameters:

transacted - Use transactions

acknowledgeMode - The acknowledge mode

Returns:

The topic session

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

createXATopicSession

public jakarta.jms.XATopicSession createXATopicSession()
                                                throws jakarta.jms.JMSException

Create a XA topic session

Specified by:

createXATopicSession in interface jakarta.jms.XATopicConnection

Returns:

The XA topic session

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

createConnectionConsumer

public jakarta.jms.ConnectionConsumer createConnectionConsumer(jakarta.jms.Topic topic,
                                                               String messageSelector,
                                                               jakarta.jms.ServerSessionPool sessionPool,
                                                               int maxMessages)
                                                        throws jakarta.jms.JMSException

Create a connection consumer -- throws IllegalStateException

Specified by:

createConnectionConsumer in interface jakarta.jms.TopicConnection

Parameters:

topic - The topic

messageSelector - The message selector

sessionPool - The session pool

maxMessages - The number of max messages

Returns:

The connection consumer

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

createDurableConnectionConsumer

public jakarta.jms.ConnectionConsumer createDurableConnectionConsumer(jakarta.jms.Topic topic,
                                                                      String subscriptionName,
                                                                      String messageSelector,
                                                                      jakarta.jms.ServerSessionPool sessionPool,
                                                                      int maxMessages)
                                                               throws jakarta.jms.JMSException

Create a durable connection consumer -- throws IllegalStateException

Specified by:

createDurableConnectionConsumer in interface jakarta.jms.Connection

Specified by:

createDurableConnectionConsumer in interface jakarta.jms.TopicConnection

Parameters:

topic - The topic

subscriptionName - The subscription name

messageSelector - The message selector

sessionPool - The session pool

maxMessages - The number of max messages

Returns:

The connection consumer

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

createConnectionConsumer

public jakarta.jms.ConnectionConsumer createConnectionConsumer(jakarta.jms.Destination destination,
                                                               jakarta.jms.ServerSessionPool pool,
                                                               int maxMessages)
                                                        throws jakarta.jms.JMSException

Create a connection consumer -- throws IllegalStateException

Parameters:

destination - The destination

pool - The session pool

maxMessages - The number of max messages

Returns:

The connection consumer

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

createConnectionConsumer

public jakarta.jms.ConnectionConsumer createConnectionConsumer(jakarta.jms.Destination destination,
                                                               String name,
                                                               jakarta.jms.ServerSessionPool pool,
                                                               int maxMessages)
                                                        throws jakarta.jms.JMSException

Create a connection consumer -- throws IllegalStateException

Specified by:

createConnectionConsumer in interface jakarta.jms.Connection

Parameters:

destination - The destination

name - The name

pool - The session pool

maxMessages - The number of max messages

Returns:

The connection consumer

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

createSession

public jakarta.jms.Session createSession(boolean transacted,
                                         int acknowledgeMode)
                                  throws jakarta.jms.JMSException

Create a session

Specified by:

createSession in interface jakarta.jms.Connection

Specified by:

createSession in interface jakarta.jms.XAConnection

Parameters:

transacted - Use transactions

acknowledgeMode - The acknowledge mode

Returns:

The session

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

createXASession

public jakarta.jms.XASession createXASession()
                                      throws jakarta.jms.JMSException

Create a XA session

Specified by:

createXASession in interface jakarta.jms.XAConnection

Returns:

The XA session

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

getMetaData

public jakarta.jms.ConnectionMetaData getMetaData()
                                           throws jakarta.jms.JMSException

Get the connection metadata

Specified by:

getMetaData in interface jakarta.jms.Connection

Returns:

The connection metadata

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

getExceptionListener

public jakarta.jms.ExceptionListener getExceptionListener()
                                                   throws jakarta.jms.JMSException

Get the exception listener -- throws IllegalStateException

Specified by:

getExceptionListener in interface jakarta.jms.Connection

Returns:

The exception listener

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

setExceptionListener

public void setExceptionListener(jakarta.jms.ExceptionListener listener)
                          throws jakarta.jms.JMSException

Set the exception listener -- throws IllegalStateException

Specified by:

setExceptionListener in interface jakarta.jms.Connection

Parameters:

listener - The exception listener

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

start

public void start()
           throws jakarta.jms.JMSException

Start

Specified by:

start in interface jakarta.jms.Connection

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

stop

public void stop()
          throws jakarta.jms.JMSException

Stop

Specified by:

stop in interface jakarta.jms.Connection

Throws:

jakarta.jms.IllegalStateException

jakarta.jms.JMSException - Thrown if an error occurs

close

public void close()
           throws jakarta.jms.JMSException

Close

Specified by:

close in interface AutoCloseable

Specified by:

close in interface jakarta.jms.Connection

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

closeSession

public void closeSession(ActiveMQRASession session)
                  throws jakarta.jms.JMSException

Close session

Specified by:

closeSession in interface ActiveMQRASessionFactory

Parameters:

session - The session

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

addTemporaryQueue

public void addTemporaryQueue(jakarta.jms.TemporaryQueue temp)

Add temporary queue

Specified by:

addTemporaryQueue in interface ActiveMQRASessionFactory

Parameters:

temp - The temporary queue

addTemporaryTopic

public void addTemporaryTopic(jakarta.jms.TemporaryTopic temp)

Add temporary topic

Specified by:

addTemporaryTopic in interface ActiveMQRASessionFactory

Parameters:

temp - The temporary topic

createSession

public jakarta.jms.Session createSession(int sessionMode)
                                  throws jakarta.jms.JMSException

Specified by:

createSession in interface jakarta.jms.Connection

Throws:

jakarta.jms.JMSException

createSession

public jakarta.jms.Session createSession()
                                  throws jakarta.jms.JMSException

Specified by:

createSession in interface jakarta.jms.Connection

Throws:

jakarta.jms.JMSException

createSharedConnectionConsumer

public jakarta.jms.ConnectionConsumer createSharedConnectionConsumer(jakarta.jms.Topic topic,
                                                                     String subscriptionName,
                                                                     String messageSelector,
                                                                     jakarta.jms.ServerSessionPool sessionPool,
                                                                     int maxMessages)
                                                              throws jakarta.jms.JMSException

Specified by:

createSharedConnectionConsumer in interface jakarta.jms.Connection

Throws:

jakarta.jms.JMSException

createSharedDurableConnectionConsumer

public jakarta.jms.ConnectionConsumer createSharedDurableConnectionConsumer(jakarta.jms.Topic topic,
                                                                            String subscriptionName,
                                                                            String messageSelector,
                                                                            jakarta.jms.ServerSessionPool sessionPool,
                                                                            int maxMessages)
                                                                     throws jakarta.jms.JMSException

Specified by:

createSharedDurableConnectionConsumer in interface jakarta.jms.Connection

Throws:

jakarta.jms.JMSException

allocateConnection

protected ActiveMQRASession allocateConnection(int sessionType)
                                        throws jakarta.jms.JMSException

Allocation a connection

Parameters:

sessionType - The session type

Returns:

The session

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

allocateConnection

protected ActiveMQRASession allocateConnection(boolean transacted,
                                               int acknowledgeMode,
                                               int sessionType)
                                        throws jakarta.jms.JMSException

Allocate a connection

Parameters:

transacted - Use transactions

acknowledgeMode - The acknowledge mode

sessionType - The session type

Returns:

The session

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

checkClosed

protected void checkClosed()
                    throws jakarta.jms.IllegalStateException

Check if we are closed

Throws:

jakarta.jms.IllegalStateException - Thrown if closed