Package org.apache.activemq.artemis.ra

Class ActiveMQRAConnectionFactoryImpl

java.lang.Object
org.apache.activemq.artemis.ra.ActiveMQRAConnectionFactoryImpl
All Implemented Interfaces:
ConnectionFactory, QueueConnectionFactory, TopicConnectionFactory, XAConnectionFactory, XAQueueConnectionFactory, XATopicConnectionFactory, Referenceable, Serializable, Referenceable, ActiveMQRAConnectionFactory
public class ActiveMQRAConnectionFactoryImpl extends Object implements ActiveMQRAConnectionFactory
See Also:

  • Constructor Details

  • Method Details

    • setReference

      public void setReference(Reference reference)
      Sets the Reference instance. This method is called by the deployment code to set the Reference that can be later returned by the getReference method (as defined in the javax.naming.Referenceable interface).
      Specified by:
      setReference in interface Referenceable
      Parameters:
      reference - A Reference instance
      See Also:

    • getReference

      public Reference getReference()
      Specified by:
      getReference in interface Referenceable

    • createQueueConnection

      public QueueConnection createQueueConnection() throws JMSException
      Creates a queue connection with the default user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.
      Specified by:
      createQueueConnection in interface QueueConnectionFactory
      Returns:
      a newly created queue connection
      Throws:
      JMSException - if the Jakarta Messaging provider fails to create the queue connection due to some internal error.
      JMSSecurityException - if client authentication fails due to an invalid user name or password.

    • createQueueConnection

      public QueueConnection createQueueConnection(String userName, String password) throws JMSException
      Creates a queue connection with the specified user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.
      Specified by:
      createQueueConnection in interface QueueConnectionFactory
      Parameters:
      userName - the caller's user name
      password - the caller's password
      Returns:
      a newly created queue connection
      Throws:
      JMSException - if the Jakarta Messaging provider fails to create the queue connection due to some internal error.
      JMSSecurityException - if client authentication fails due to an invalid user name or password.

    • createTopicConnection

      public TopicConnection createTopicConnection() throws JMSException
      Creates a topic connection with the default user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.
      Specified by:
      createTopicConnection in interface TopicConnectionFactory
      Returns:
      a newly created topic connection
      Throws:
      JMSException - if the Jakarta Messaging provider fails to create a topic connection due to some internal error.
      JMSSecurityException - if client authentication fails due to an invalid user name or password.

    • createTopicConnection

      public TopicConnection createTopicConnection(String userName, String password) throws JMSException
      Creates a topic connection with the specified user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.
      Specified by:
      createTopicConnection in interface TopicConnectionFactory
      Parameters:
      userName - the caller's user name
      password - the caller's password
      Returns:
      a newly created topic connection
      Throws:
      JMSException - if the Jakarta Messaging provider fails to create a topic connection due to some internal error.
      JMSSecurityException - if client authentication fails due to an invalid user name or password.

    • createConnection

      public Connection createConnection() throws JMSException
      Creates a connection with the default user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.
      Specified by:
      createConnection in interface ConnectionFactory
      Returns:
      a newly created connection
      Throws:
      JMSException - if the Jakarta Messaging provider fails to create the connection due to some internal error.
      JMSSecurityException - if client authentication fails due to an invalid user name or password.

    • createConnection

      public Connection createConnection(String userName, String password) throws JMSException
      Creates a connection with the specified user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.
      Specified by:
      createConnection in interface ConnectionFactory
      Parameters:
      userName - the caller's user name
      password - the caller's password
      Returns:
      a newly created connection
      Throws:
      JMSException - if the Jakarta Messaging provider fails to create the connection due to some internal error.
      JMSSecurityException - if client authentication fails due to an invalid user name or password.

    • createXAQueueConnection

      public XAQueueConnection createXAQueueConnection() throws JMSException
      Creates an XA queue connection with the default user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.
      Specified by:
      createXAQueueConnection in interface XAQueueConnectionFactory
      Returns:
      a newly created XA queue connection
      Throws:
      JMSException - if the Jakarta Messaging provider fails to create an XA queue connection due to some internal error.
      JMSSecurityException - if client authentication fails due to an invalid user name or password.

    • createXAQueueConnection

      public XAQueueConnection createXAQueueConnection(String userName, String password) throws JMSException
      Creates an XA queue connection with the specified user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.
      Specified by:
      createXAQueueConnection in interface XAQueueConnectionFactory
      Parameters:
      userName - the caller's user name
      password - the caller's password
      Returns:
      a newly created XA queue connection
      Throws:
      JMSException - if the Jakarta Messaging provider fails to create an XA queue connection due to some internal error.
      JMSSecurityException - if client authentication fails due to an invalid user name or password.

    • createXATopicConnection

      public XATopicConnection createXATopicConnection() throws JMSException
      Creates an XA topic connection with the default user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.
      Specified by:
      createXATopicConnection in interface XATopicConnectionFactory
      Returns:
      a newly created XA topic connection
      Throws:
      JMSException - if the Jakarta Messaging provider fails to create an XA topic connection due to some internal error.
      JMSSecurityException - if client authentication fails due to an invalid user name or password.

    • createXATopicConnection

      public XATopicConnection createXATopicConnection(String userName, String password) throws JMSException
      Creates an XA topic connection with the specified user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.
      Specified by:
      createXATopicConnection in interface XATopicConnectionFactory
      Parameters:
      userName - the caller's user name
      password - the caller's password
      Returns:
      a newly created XA topic connection
      Throws:
      JMSException - if the Jakarta Messaging provider fails to create an XA topic connection due to some internal error.
      JMSSecurityException - if client authentication fails due to an invalid user name or password.

    • createXAConnection

      public XAConnection createXAConnection() throws JMSException
      Creates an XAConnection with the default user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.
      Specified by:
      createXAConnection in interface XAConnectionFactory
      Returns:
      a newly created XAConnection
      Throws:
      JMSException - if the Jakarta Messaging provider fails to create an XA connection due to some internal error.
      JMSSecurityException - if client authentication fails due to an invalid user name or password.

    • createXAConnection

      public XAConnection createXAConnection(String userName, String password) throws JMSException
      Creates an XAConnection with the specified user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.
      Specified by:
      createXAConnection in interface XAConnectionFactory
      Parameters:
      userName - the caller's user name
      password - the caller's password
      Returns:
      a newly created XAConnection
      Throws:
      JMSException - if the Jakarta Messaging provider fails to create an XA connection due to some internal error.
      JMSSecurityException - if client authentication fails due to an invalid user name or password.

    • createContext

      public JMSContext createContext()
      Creates a JMSContext with the default user identity and an unspecified sessionMode.

      A connection and session are created for use by the new JMSContext. The connection is created in stopped mode but will be automatically started when a JMSConsumer is created.

      The behaviour of the session that is created depends on whether this method is called in a Java SE environment, in the Jakarta EE application client container, or in the Jakarta EE web or EJB container. If this method is called in the Jakarta EE web or EJB container then the behaviour of the session also depends on whether or not there is an active JTA transaction in progress.

      In a Java SE environment or in the Jakarta EE application client container:

      • The session will be non-transacted and received messages will be acknowledged automatically using an acknowledgement mode of JMSContext.AUTO_ACKNOWLEDGE For a definition of the meaning of this acknowledgement mode see the link below.

      In a Jakarta EE web or EJB container, when there is an active JTA transaction in progress:

      • The session will participate in the JTA transaction and will be committed or rolled back when that transaction is committed or rolled back, not by calling the JMSContext's commit or rollback methods.

      In the Jakarta EE web or EJB container, when there is no active JTA transaction in progress:

      • The session will be non-transacted and received messages will be acknowledged automatically using an acknowledgement mode of JMSContext.AUTO_ACKNOWLEDGE For a definition of the meaning of this acknowledgement mode see the link below.
      Specified by:
      createContext in interface ConnectionFactory
      Returns:
      a newly created JMSContext
      See Also:

    • createContext

      public JMSContext createContext(String userName, String password)
      Creates a JMSContext with the specified user identity and an unspecified sessionMode.

      A connection and session are created for use by the new JMSContext. The connection is created in stopped mode but will be automatically started when a JMSConsumer.

      The behaviour of the session that is created depends on whether this method is called in a Java SE environment, in the Jakarta EE application client container, or in the Jakarta EE web or EJB container. If this method is called in the Jakarta EE web or EJB container then the behaviour of the session also depends on whether or not there is an active JTA transaction in progress.

      In a Java SE environment or in the Jakarta EE application client container:

      • The session will be non-transacted and received messages will be acknowledged automatically using an acknowledgement mode of JMSContext.AUTO_ACKNOWLEDGE For a definition of the meaning of this acknowledgement mode see the link below.

      In a Jakarta EE web or EJB container, when there is an active JTA transaction in progress:

      • The session will participate in the JTA transaction and will be committed or rolled back when that transaction is committed or rolled back, not by calling the JMSContext's commit or rollback methods.

      In the Jakarta EE web or EJB container, when there is no active JTA transaction in progress:

      • The session will be non-transacted and received messages will be acknowledged automatically using an acknowledgement mode of JMSContext.AUTO_ACKNOWLEDGE For a definition of the meaning of this acknowledgement mode see the link below.
      Specified by:
      createContext in interface ConnectionFactory
      Parameters:
      userName - the caller's user name
      password - the caller's password
      Returns:
      a newly created JMSContext
      See Also:

    • createContext

      public JMSContext createContext(String userName, String password, int sessionMode)
      Creates a JMSContext with the specified user identity and the specified session mode.

      A connection and session are created for use by the new JMSContext. The JMSContext is created in stopped mode but will be automatically started when a JMSConsumer is created.

      The effect of setting the sessionMode argument depends on whether this method is called in a Java SE environment, in the Jakarta EE application client container, or in the Jakarta EE web or EJB container. If this method is called in the Jakarta EE web or EJB container then the effect of setting the sessionMode argument also depends on whether or not there is an active JTA transaction in progress.

      In a Java SE environment or in the Jakarta EE application client container:

      • If sessionMode is set to JMSContext.SESSION_TRANSACTED then the session will use a local transaction which may subsequently be committed or rolled back by calling the JMSContext's commit or rollback methods.
      • If sessionMode is set to any of JMSContext.CLIENT_ACKNOWLEDGE, JMSContext.AUTO_ACKNOWLEDGE or JMSContext.DUPS_OK_ACKNOWLEDGE. then the session will be non-transacted and messages received by this session will be acknowledged according to the value of sessionMode. For a definition of the meaning of these acknowledgement modes see the links below.

      In a Jakarta EE web or EJB container, when there is an active JTA transaction in progress:

      • The argument sessionMode is ignored. The session will participate in the JTA transaction and will be committed or rolled back when that transaction is committed or rolled back, not by calling the JMSContext's commit or rollback methods. Since the argument is ignored, developers are recommended to use createContext(String userName, String password) instead of this method.

      In the Jakarta EE web or EJB container, when there is no active JTA transaction in progress:

      • The argument acknowledgeMode must be set to either of JMSContext.AUTO_ACKNOWLEDGE or JMSContext.DUPS_OK_ACKNOWLEDGE. The session will be non-transacted and messages received by this session will be acknowledged automatically according to the value of acknowledgeMode. For a definition of the meaning of these acknowledgement modes see the links below. The values JMSContext.SESSION_TRANSACTED and JMSContext.CLIENT_ACKNOWLEDGE may not be used.
      Specified by:
      createContext in interface ConnectionFactory
      Parameters:
      userName - the caller's user name
      password - the caller's password
      sessionMode - indicates which of four possible session modes will be used.
      • If this method is called in a Java SE environment or in the Jakarta EE application client container, the permitted values are JMSContext.SESSION_TRANSACTED, JMSContext.CLIENT_ACKNOWLEDGE, JMSContext.AUTO_ACKNOWLEDGE and JMSContext.DUPS_OK_ACKNOWLEDGE.
      • If this method is called in the Jakarta EE web or EJB container when there is an active JTA transaction in progress then this argument is ignored.
      • If this method is called in the Jakarta EE web or EJB container when there is no active JTA transaction in progress, the permitted values are JMSContext.AUTO_ACKNOWLEDGE and JMSContext.DUPS_OK_ACKNOWLEDGE. In this case the values JMSContext.TRANSACTED and JMSContext.CLIENT_ACKNOWLEDGE are not permitted.
      Returns:
      a newly created JMSContext
      See Also:

    • createContext

      public JMSContext createContext(int sessionMode)
      Creates a JMSContext with the default user identity and the specified session mode.

      A connection and session are created for use by the new JMSContext. The JMSContext is created in stopped mode but will be automatically started when a JMSConsumer is created.

      The effect of setting the sessionMode argument depends on whether this method is called in a Java SE environment, in the Jakarta EE application client container, or in the Jakarta EE web or EJB container. If this method is called in the Jakarta EE web or EJB container then the effect of setting the sessionMode argument also depends on whether or not there is an active JTA transaction in progress.

      In a Java SE environment or in the Jakarta EE application client container:

      • If sessionMode is set to JMSContext.SESSION_TRANSACTED then the session will use a local transaction which may subsequently be committed or rolled back by calling the JMSContext's commit or rollback methods.
      • If sessionMode is set to any of JMSContext.CLIENT_ACKNOWLEDGE, JMSContext.AUTO_ACKNOWLEDGE or JMSContext.DUPS_OK_ACKNOWLEDGE. then the session will be non-transacted and messages received by this session will be acknowledged according to the value of sessionMode. For a definition of the meaning of these acknowledgement modes see the links below.

      In a Jakarta EE web or EJB container, when there is an active JTA transaction in progress:

      • The argument sessionMode is ignored. The session will participate in the JTA transaction and will be committed or rolled back when that transaction is committed or rolled back, not by calling the JMSContext's commit or rollback methods. Since the argument is ignored, developers are recommended to use createContext() instead of this method.

      In the Jakarta EE web or EJB container, when there is no active JTA transaction in progress:

      • The argument acknowledgeMode must be set to either of JMSContext.AUTO_ACKNOWLEDGE or JMSContext.DUPS_OK_ACKNOWLEDGE. The session will be non-transacted and messages received by this session will be acknowledged automatically according to the value of acknowledgeMode. For a definition of the meaning of these acknowledgement modes see the links below. The values JMSContext.SESSION_TRANSACTED and JMSContext.CLIENT_ACKNOWLEDGE may not be used.
      Specified by:
      createContext in interface ConnectionFactory
      Parameters:
      sessionMode - indicates which of four possible session modes will be used.
      • If this method is called in a Java SE environment or in the Jakarta EE application client container, the permitted values are JMSContext.SESSION_TRANSACTED, JMSContext.CLIENT_ACKNOWLEDGE, JMSContext.AUTO_ACKNOWLEDGE and JMSContext.DUPS_OK_ACKNOWLEDGE.
      • If this method is called in the Jakarta EE web or EJB container when there is an active JTA transaction in progress then this argument is ignored.
      • If this method is called in the Jakarta EE web or EJB container when there is no active JTA transaction in progress, the permitted values are JMSContext.AUTO_ACKNOWLEDGE and JMSContext.DUPS_OK_ACKNOWLEDGE. In this case the values JMSContext.TRANSACTED and JMSContext.CLIENT_ACKNOWLEDGE are not permitted.
      Returns:
      a newly created JMSContext
      See Also:

    • createXAContext

      public XAJMSContext createXAContext()
      Creates a XAJMSContext with the default user identity

      A connection and session are created for use by the new XAJMSContext. The connection is created in stopped mode but will be automatically started when a JMSConsumer is created.

      Specified by:
      createXAContext in interface XAConnectionFactory
      Returns:
      a newly created XAJMSContext

    • createXAContext

      public XAJMSContext createXAContext(String userName, String password)
      Creates a JMSContext with the specified user identity

      A connection and session are created for use by the new XAJMSContext. The connection is created in stopped mode but will be automatically started when a JMSConsumer is created.

      Specified by:
      createXAContext in interface XAConnectionFactory
      Parameters:
      userName - the caller's user name
      password - the caller's password
      Returns:
      a newly created JMSContext

    • getDefaultFactory

      public ActiveMQConnectionFactory getDefaultFactory() throws ResourceException
      Specified by:
      getDefaultFactory in interface ActiveMQRAConnectionFactory
      Throws:
      ResourceException

    • getResourceAdapter

      public ActiveMQResourceAdapter getResourceAdapter()
      Specified by:
      getResourceAdapter in interface ActiveMQRAConnectionFactory