Class TibjmsXATopicConnectionFactory
- java.lang.Object
-
- com.tibco.tibjms.TibjmsxCFImpl
-
- com.tibco.tibjms.TibjmsXAConnectionFactory
-
- com.tibco.tibjms.TibjmsXATopicConnectionFactory
-
- All Implemented Interfaces:
com.tibco.tibjms.TibjmsXMLConst,java.io.Externalizable,java.io.Serializable,java.lang.Cloneable,ConnectionFactory,TopicConnectionFactory,XAConnectionFactory,XATopicConnectionFactory,javax.naming.Referenceable
public class TibjmsXATopicConnectionFactory extends TibjmsXAConnectionFactory implements XATopicConnectionFactory, TopicConnectionFactory, java.io.Serializable, javax.naming.Referenceable
Note: XA sessions do not support routed queues.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.tibco.tibjms.TibjmsxCFImpl
_clientID, _properties, _url, _wasCreatedByUfo
-
Fields inherited from interface com.tibco.tibjms.TibjmsXMLConst
TIBJMS_LDAP_ADMINOBJ, TIBJMS_LDAP_CN, TIBJMS_LDAP_OBJCLASS, TIBJMS_LDAP_TOP, TIBJMS_LDAP_XMLDATA, TIBJMS_XML_ADMINOBJ, TIBJMS_XML_AUTHONLY, TIBJMS_XML_AUTHORITIES, TIBJMS_XML_B64DATA, TIBJMS_XML_CERT, TIBJMS_XML_CERTS, TIBJMS_XML_CIDENTITY, TIBJMS_XML_CIPHERS, TIBJMS_XML_CLIENTID, TIBJMS_XML_CONFACT, TIBJMS_XML_CONNATTEMPTS, TIBJMS_XML_CONNATTEMPTTIMEOUT, TIBJMS_XML_CONNDELAY, TIBJMS_XML_DEBUG_TRACE, TIBJMS_XML_DESTTYPE, TIBJMS_XML_DISABLED, TIBJMS_XML_DTDURL, TIBJMS_XML_ENABLED, TIBJMS_XML_ENCODING, TIBJMS_XML_EXPECTHNAME, TIBJMS_XML_FILE, TIBJMS_XML_GENERIC, TIBJMS_XML_GENPARAMS, TIBJMS_XML_ISSUER, TIBJMS_XML_METRIC, TIBJMS_XML_MULTICAST, TIBJMS_XML_MULTICAST_DAEMON, TIBJMS_XML_NAME, TIBJMS_XML_OAUTH2_CLIENT_ID, TIBJMS_XML_OAUTH2_DISABLE_VERIFY_HOSTNAME, TIBJMS_XML_OAUTH2_EXPECTED_HOSTNAME, TIBJMS_XML_OAUTH2_SERVER_TRUST_FILE, TIBJMS_XML_OAUTH2_SERVER_URL, TIBJMS_XML_OAUTH2PARAMS, TIBJMS_XML_PARAMETER, TIBJMS_XML_PASSWORD, TIBJMS_XML_PKEY, TIBJMS_XML_QUEUE, TIBJMS_XML_RECONNATTEMPTS, TIBJMS_XML_RECONNATTEMPTTIMEOUT, TIBJMS_XML_RECONNDELAY, TIBJMS_XML_SECPARAMS, TIBJMS_XML_SSLPARAMS, TIBJMS_XML_TOPIC, TIBJMS_XML_TRACE, TIBJMS_XML_TRUSTED, TIBJMS_XML_URL, TIBJMS_XML_USERNAME, TIBJMS_XML_VALUE, TIBJMS_XML_VENDOR, TIBJMS_XML_VERIFYHNAME, TIBJMS_XML_VERIFYHOST, TIBJMS_XML_XA
-
-
Constructor Summary
Constructors Constructor Description TibjmsXATopicConnectionFactory()Constructs a new TibjmsXATopicConnectionFactory object.TibjmsXATopicConnectionFactory(java.lang.String serverUrl)Constructs a new TibjmsXATopicConnectionFactory object for the given URL.TibjmsXATopicConnectionFactory(java.lang.String serverUrl, java.lang.String clientId)Constructs a new TibjmsXATopicConnectionFactory object for the given URL and client id.TibjmsXATopicConnectionFactory(java.lang.String serverUrl, java.lang.String clientId, java.util.Map properties)Constructs a new TibjmsXATopicConnectionFactory object for the given URL and client id and properties.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Objectclone()JMSContextcreateContext()Creates a JMSContext with the default user identity and an unspecified sessionMode.JMSContextcreateContext(int sessionMode)Creates a JMSContext with the default user identity and the specified session mode.JMSContextcreateContext(java.lang.String userName, java.lang.String password)Creates a JMSContext with the specified user identity and an unspecified sessionMode.JMSContextcreateContext(java.lang.String userName, java.lang.String password, int sessionMode)Creates a JMSContext with the specified user identity and the specified session mode.TopicConnectioncreateTopicConnection()Creates a topic connection with the default user identity.TopicConnectioncreateTopicConnection(java.lang.String userName, java.lang.String password)Creates a topic connection with the specified user identity.XATopicConnectioncreateXATopicConnection()Creates an XA topic connection with the default user identity.XATopicConnectioncreateXATopicConnection(java.lang.String userName, java.lang.String password)Creates an XA topic connection with the specified user identity.-
Methods inherited from class com.tibco.tibjms.TibjmsXAConnectionFactory
createConnection, createConnection, createXAConnection, createXAConnection, createXAContext, createXAContext, getSSLProxyHost, getSSLProxyPassword, getSSLProxyPort, getSSLProxyUser, setClientID, setConnAttemptCount, setConnAttemptDelay, setConnAttemptTimeout, setMetric, setMulticastDaemon, setMulticastEnabled, setOAuth2AccessToken, setOAuth2ClientId, setOAuth2ClientSecret, setOAuth2DisableVerifyHostname, setOAuth2ExpectedHostname, setOAuth2ServerTrustFile, setOAuth2ServerTrustFile, setOAuth2ServerUrl, setOAuth2TokenFetchCallback, setReconnAttemptCount, setReconnAttemptDelay, setReconnAttemptTimeout, setServerUrl, setSSLAuthOnly, setSSLCipherSuites, setSSLDebugTrace, setSSLEnableVerifyHost, setSSLEnableVerifyHostName, setSSLExpectedHostName, setSSLIdentity, setSSLIdentity, setSSLIdentityEncoding, setSSLIssuerCertificate, setSSLIssuerCertificate, setSSLIssuerCertificate, setSSLPassword, setSSLPrivateKey, setSSLPrivateKey, setSSLPrivateKeyEncoding, setSSLProxy, setSSLProxyAuth, setSSLTrace, setSSLTrustedCertificate, setSSLTrustedCertificate, setSSLTrustedCertificate, setSSLVendor, setUserName, setUserPassword
-
Methods inherited from class com.tibco.tibjms.TibjmsxCFImpl
_getCurrentUrl, buildXML, getClientID, getCurrentUrl, getMetric, getProperties, getReference, getUrl, readExternal, toString, writeExternal
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface javax.jms.ConnectionFactory
createConnection, createConnection
-
Methods inherited from interface javax.jms.XAConnectionFactory
createXAConnection, createXAConnection, createXAContext, createXAContext
-
-
-
-
Constructor Detail
-
TibjmsXATopicConnectionFactory
public TibjmsXATopicConnectionFactory()
Constructs a new TibjmsXATopicConnectionFactory object.
-
TibjmsXATopicConnectionFactory
public TibjmsXATopicConnectionFactory(java.lang.String serverUrl)
Constructs a new TibjmsXATopicConnectionFactory object for the given URL.- Parameters:
serverUrl- url of the EMS server
-
TibjmsXATopicConnectionFactory
public TibjmsXATopicConnectionFactory(java.lang.String serverUrl, java.lang.String clientId)Constructs a new TibjmsXATopicConnectionFactory object for the given URL and client id.- Parameters:
serverUrl- url of the EMS serverclientId- id of the client
-
TibjmsXATopicConnectionFactory
public TibjmsXATopicConnectionFactory(java.lang.String serverUrl, java.lang.String clientId, java.util.Map properties)Constructs a new TibjmsXATopicConnectionFactory object for the given URL and client id and properties.- Parameters:
serverUrl- url of the EMS serverclientId- id of the clientproperties- 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:
clonein classTibjmsXAConnectionFactory- Throws:
java.lang.CloneNotSupportedException
-
createXATopicConnection
public XATopicConnection createXATopicConnection() throws JMSException
Description copied from interface:XATopicConnectionFactoryCreates an XA topic connection with the default user identity. The connection is created in stopped mode. No messages will be delivered until theConnection.startmethod is explicitly called.- Specified by:
createXATopicConnectionin interfaceXATopicConnectionFactory- 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(java.lang.String userName, java.lang.String password) throws JMSException
Description copied from interface:XATopicConnectionFactoryCreates an XA topic connection with the specified user identity. The connection is created in stopped mode. No messages will be delivered until theConnection.startmethod is explicitly called.- Specified by:
createXATopicConnectionin interfaceXATopicConnectionFactory- Parameters:
userName- the caller's user namepassword- 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.
-
createTopicConnection
public TopicConnection createTopicConnection() throws JMSException
Description copied from interface:TopicConnectionFactoryCreates a topic connection with the default user identity. The connection is created in stopped mode. No messages will be delivered until theConnection.startmethod is explicitly called.- Specified by:
createTopicConnectionin interfaceTopicConnectionFactory- 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(java.lang.String userName, java.lang.String password) throws JMSException
Description copied from interface:TopicConnectionFactoryCreates a topic connection with the specified user identity. The connection is created in stopped mode. No messages will be delivered until theConnection.startmethod is explicitly called.- Specified by:
createTopicConnectionin interfaceTopicConnectionFactory- Parameters:
userName- the caller's user namepassword- 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.
-
createContext
public JMSContext createContext()
Description copied from interface:ConnectionFactoryCreates 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_ACKNOWLEDGEFor 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'scommitorrollbackmethods.
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_ACKNOWLEDGEFor a definition of the meaning of this acknowledgement mode see the link below.
- Specified by:
createContextin interfaceConnectionFactory- 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)
- The session will be non-transacted and received messages will be acknowledged automatically using an
acknowledgement mode of
-
createContext
public JMSContext createContext(int sessionMode)
Description copied from interface:ConnectionFactoryCreates 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
sessionModeargument 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 thesessionModeargument 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
sessionModeis set toJMSContext.SESSION_TRANSACTEDthen the session will use a local transaction which may subsequently be committed or rolled back by calling theJMSContext'scommitorrollbackmethods. - If
sessionModeis set to any ofJMSContext.CLIENT_ACKNOWLEDGE,JMSContext.AUTO_ACKNOWLEDGEorJMSContext.DUPS_OK_ACKNOWLEDGE. then the session will be non-transacted and messages received by this session will be acknowledged according to the value ofsessionMode. 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
sessionModeis 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 theJMSContext'scommitorrollbackmethods. Since the argument is ignored, developers are recommended to usecreateContext()instead of this method.
In the Jakarta EE web or EJB container, when there is no active JTA transaction in progress:
- The argument
acknowledgeModemust be set to either ofJMSContext.AUTO_ACKNOWLEDGEorJMSContext.DUPS_OK_ACKNOWLEDGE. The session will be non-transacted and messages received by this session will be acknowledged automatically according to the value ofacknowledgeMode. For a definition of the meaning of these acknowledgement modes see the links below. The valuesJMSContext.SESSION_TRANSACTEDandJMSContext.CLIENT_ACKNOWLEDGEmay not be used.
- Specified by:
createContextin interfaceConnectionFactory- 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_ACKNOWLEDGEandJMSContext.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_ACKNOWLEDGEandJMSContext.DUPS_OK_ACKNOWLEDGE. In this case the valuesJMSContext.TRANSACTEDandJMSContext.CLIENT_ACKNOWLEDGEare not permitted.
- If this method is called in a Java SE environment or in the Jakarta EE application client container, the permitted
values are
- 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)
- If
-
createContext
public JMSContext createContext(java.lang.String userName, java.lang.String password)
Description copied from interface:ConnectionFactoryCreates 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_ACKNOWLEDGEFor 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'scommitorrollbackmethods.
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_ACKNOWLEDGEFor a definition of the meaning of this acknowledgement mode see the link below.
- Specified by:
createContextin interfaceConnectionFactory- Parameters:
userName- the caller's user namepassword- 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)
- The session will be non-transacted and received messages will be acknowledged automatically using an
acknowledgement mode of
-
createContext
public JMSContext createContext(java.lang.String userName, java.lang.String password, int sessionMode)
Description copied from interface:ConnectionFactoryCreates 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
sessionModeargument 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 thesessionModeargument 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
sessionModeis set toJMSContext.SESSION_TRANSACTEDthen the session will use a local transaction which may subsequently be committed or rolled back by calling theJMSContext'scommitorrollbackmethods. - If
sessionModeis set to any ofJMSContext.CLIENT_ACKNOWLEDGE,JMSContext.AUTO_ACKNOWLEDGEorJMSContext.DUPS_OK_ACKNOWLEDGE. then the session will be non-transacted and messages received by this session will be acknowledged according to the value ofsessionMode. 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
sessionModeis 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 theJMSContext'scommitorrollbackmethods. Since the argument is ignored, developers are recommended to usecreateContext(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
acknowledgeModemust be set to either ofJMSContext.AUTO_ACKNOWLEDGEorJMSContext.DUPS_OK_ACKNOWLEDGE. The session will be non-transacted and messages received by this session will be acknowledged automatically according to the value ofacknowledgeMode. For a definition of the meaning of these acknowledgement modes see the links below. The valuesJMSContext.SESSION_TRANSACTEDandJMSContext.CLIENT_ACKNOWLEDGEmay not be used.
- Specified by:
createContextin interfaceConnectionFactory- Parameters:
userName- the caller's user namepassword- the caller's passwordsessionMode- 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_ACKNOWLEDGEandJMSContext.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_ACKNOWLEDGEandJMSContext.DUPS_OK_ACKNOWLEDGE. In this case the valuesJMSContext.TRANSACTEDandJMSContext.CLIENT_ACKNOWLEDGEare not permitted.
- If this method is called in a Java SE environment or in the Jakarta EE application client container, the permitted
values are
- 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)
- If
-
-