Package com.tibco.tibjms

Class TibjmsXAQueueConnectionFactory

    • Constructor Detail

      • TibjmsXAQueueConnectionFactory

        public TibjmsXAQueueConnectionFactory()
        Constructs a new TibjmsXAQueueConnectionFactory object.

      • TibjmsXAQueueConnectionFactory

        public TibjmsXAQueueConnectionFactory​(java.lang.String serverUrl)
        Constructs a new TibjmsXAQueueConnectionFactory object for the given URL.
        Parameters:
        serverUrl - url of the EMS server

      • TibjmsXAQueueConnectionFactory

        public TibjmsXAQueueConnectionFactory​(java.lang.String serverUrl,
                                      java.lang.String clientId)
        Constructs a new TibjmsXAQueueConnectionFactory object for the given URL and client id.
        Parameters:
        serverUrl - url of the EMS server
        clientId - id of the client

      • TibjmsXAQueueConnectionFactory

        public TibjmsXAQueueConnectionFactory​(java.lang.String serverUrl,
                                      java.lang.String clientId,
                                      java.util.Map properties)
        Constructs a new TibjmsXAQueueConnectionFactory object for the given URL and client id and properties.
        Parameters:
        serverUrl - url of the EMS server
        clientId - id of the client
        properties - properties object The following properties can be set in the properties object: TibjmsSSL.VENDOR TibjmsSSL.TRACE TibjmsSSL.DEBUG_TRACE TibjmsSSL.TRUSTED_CERTIFICATES TibjmsSSL.ENABLE_VERIFY_HOST TibjmsSSL.ENABLE_VERIFY_HOST_NAME TibjmsSSL.EXPECTED_HOST_NAME TibjmsSSL.HOST_NAME_VERIFIER TibjmsSSL.AUTH_ONLY TibjmsSSL.IDENTITY TibjmsSSL.IDENTITY_ENCODING TibjmsSSL.ISSUER_CERTIFICATES TibjmsSSL.PRIVATE_KEY TibjmsSSL.PRIVATE_KEY_ENCODING TibjmsSSL.PASSWORD TibjmsSSL.CIPHER_SUITES
        See Also:
        TibjmsSSL

    • Method Detail

      • clone

        public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
        Overrides:
        clone in class TibjmsXAConnectionFactory
        Throws:
        java.lang.CloneNotSupportedException

      • createXAQueueConnection

        public XAQueueConnection createXAQueueConnection()
                                          throws JMSException
        Description copied from interface: XAQueueConnectionFactory
        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​(java.lang.String userName,
                                                 java.lang.String password)
                                          throws JMSException
        Description copied from interface: XAQueueConnectionFactory
        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.

      • createQueueConnection

        public QueueConnection createQueueConnection()
                                      throws JMSException
        Description copied from interface: QueueConnectionFactory
        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​(java.lang.String userName,
                                             java.lang.String password)
                                      throws JMSException
        Description copied from interface: QueueConnectionFactory
        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.

      • createContext

        public JMSContext createContext()
        Description copied from interface: ConnectionFactory
        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:
        JMSContext.AUTO_ACKNOWLEDGE, ConnectionFactory.createContext(int), ConnectionFactory.createContext(java.lang.String, java.lang.String), ConnectionFactory.createContext(java.lang.String, java.lang.String, int), JMSContext.createContext(int)

      • createContext

        public JMSContext createContext​(int sessionMode)
        Description copied from interface: ConnectionFactory
        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:
        JMSContext.SESSION_TRANSACTED, JMSContext.CLIENT_ACKNOWLEDGE, JMSContext.AUTO_ACKNOWLEDGE, JMSContext.DUPS_OK_ACKNOWLEDGE, ConnectionFactory.createContext(), ConnectionFactory.createContext(java.lang.String, java.lang.String), ConnectionFactory.createContext(java.lang.String, java.lang.String, int), JMSContext.createContext(int)

      • createContext

        public JMSContext createContext​(java.lang.String userName,
                                java.lang.String password)
        Description copied from interface: ConnectionFactory
        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:
        JMSContext.AUTO_ACKNOWLEDGE, ConnectionFactory.createContext(), ConnectionFactory.createContext(int), ConnectionFactory.createContext(java.lang.String, java.lang.String, int), JMSContext.createContext(int)

      • createContext

        public JMSContext createContext​(java.lang.String userName,
                                java.lang.String password,
                                int sessionMode)
        Description copied from interface: ConnectionFactory
        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:
        JMSContext.SESSION_TRANSACTED, JMSContext.CLIENT_ACKNOWLEDGE, JMSContext.AUTO_ACKNOWLEDGE, JMSContext.DUPS_OK_ACKNOWLEDGE, ConnectionFactory.createContext(), ConnectionFactory.createContext(int), ConnectionFactory.createContext(java.lang.String, java.lang.String), JMSContext.createContext(int)