Package com.tibco.tibjms

Class TibjmsXAConnectionFactory

  • java.lang.Object
    • com.tibco.tibjms.TibjmsxCFImpl
      • com.tibco.tibjms.TibjmsXAConnectionFactory

    • 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 Detail

      • TibjmsXAConnectionFactory

        public TibjmsXAConnectionFactory()

      • TibjmsXAConnectionFactory

        public TibjmsXAConnectionFactory​(java.lang.String serverUrl)

      • TibjmsXAConnectionFactory

        public TibjmsXAConnectionFactory​(java.lang.String serverUrl,
                                 java.lang.String clientId)

      • TibjmsXAConnectionFactory

        public TibjmsXAConnectionFactory​(java.lang.String serverUrl,
                                 java.lang.String clientId,
                                 java.util.Map properties)

    • Method Detail

      • createXAConnection

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

      • createXAContext

        public XAJMSContext createXAContext()
        Description copied from interface: XAConnectionFactory
        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​(java.lang.String userName,
                                    java.lang.String password)
        Description copied from interface: XAConnectionFactory
        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

      • clone

        public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
        Overrides:
        clone in class com.tibco.tibjms.TibjmsxCFImpl
        Throws:
        java.lang.CloneNotSupportedException

      • setConnAttemptCount

        public void setConnAttemptCount​(int attempts)

      • setConnAttemptDelay

        public void setConnAttemptDelay​(int delay)

      • setConnAttemptTimeout

        public void setConnAttemptTimeout​(int connectAttemptTimeout)

      • setReconnAttemptCount

        public void setReconnAttemptCount​(int attempts)

      • setReconnAttemptDelay

        public void setReconnAttemptDelay​(int delay)

      • setReconnAttemptTimeout

        public void setReconnAttemptTimeout​(int reconnectAttemptTimeout)

      • setUserName

        public void setUserName​(java.lang.String username)
        The connection object presents this user identity to the EMS server.
        When OAuth 2.0 is configured, this username is presented to the OAuth 2.0 authorization server via the resource owner password credentials grant. See TibjmsOAuth for more information.
        Parameters:
        username -

      • setUserPassword

        public void setUserPassword​(java.lang.String password)
        The connection object authenticates the user identity with this password.
        When OAuth 2.0 is configured, this password is presented to the OAuth 2.0 authorization server via the resource owner password credentials grant. See TibjmsOAuth for more information.
        Parameters:
        password -

      • setSSLVendor

        public void setSSLVendor​(java.lang.String vendor)

      • setSSLTrace

        public void setSSLTrace​(java.lang.Boolean trace)

      • setSSLDebugTrace

        public void setSSLDebugTrace​(java.lang.Boolean debugTrace)

      • setSSLEnableVerifyHost

        public void setSSLEnableVerifyHost​(java.lang.Boolean enableVerifyHost)

      • setSSLEnableVerifyHostName

        public void setSSLEnableVerifyHostName​(java.lang.Boolean enableVerifyHostName)

      • setSSLExpectedHostName

        public void setSSLExpectedHostName​(java.lang.String expectedHostName)

      • setSSLAuthOnly

        public void setSSLAuthOnly​(java.lang.Boolean authOnly)

      • setSSLTrustedCertificate

        public void setSSLTrustedCertificate​(java.lang.String certificate)

      • setSSLTrustedCertificate

        public void setSSLTrustedCertificate​(java.lang.String certificate,
                                     java.lang.String trustedEncoding)

      • setSSLTrustedCertificate

        public void setSSLTrustedCertificate​(byte[] certificate,
                                     java.lang.String trustedEncoding)

      • setSSLIssuerCertificate

        public void setSSLIssuerCertificate​(java.lang.String certificate)

      • setSSLIssuerCertificate

        public void setSSLIssuerCertificate​(java.lang.String certificate,
                                    java.lang.String encoding)

      • setSSLIssuerCertificate

        public void setSSLIssuerCertificate​(byte[] certificate,
                                    java.lang.String encoding)

      • setSSLIdentity

        public void setSSLIdentity​(java.lang.String sslIdentity)

      • setSSLIdentity

        public void setSSLIdentity​(byte[] identity)

      • setSSLIdentityEncoding

        public void setSSLIdentityEncoding​(java.lang.String sslIdentityEncoding)

      • setSSLPrivateKey

        public void setSSLPrivateKey​(java.lang.String sslPrivateKey)

      • setSSLPrivateKey

        public void setSSLPrivateKey​(byte[] sslPrivateKey)

      • setSSLPrivateKeyEncoding

        public void setSSLPrivateKeyEncoding​(java.lang.String sslPrivateKeyEncoding)

      • setSSLPassword

        public void setSSLPassword​(java.lang.String sslPassword)

      • setSSLCipherSuites

        public void setSSLCipherSuites​(java.lang.String suites)

      • setSSLProxy

        public void setSSLProxy​(java.lang.String host,
                        int port)
                 throws JMSException
        Set the connection factory's parameters for connecting through a TLS proxy. A TLS proxy lets an EMS application create a TLS connection to an EMS server, even though a firewall separates the application from the server. The proxy usually runs within the firewall's DMZ. A connection factory contacts the TLS proxy, requesting a TLS connection to the server. The proxy authenticates the application program, and mediates the initial TLS negotiation between application and server. After the TLS connection is established, the application and server use it to communicate directly with one another.
        Parameters:
        host - the connection factory establishes TLS communication through a web proxy at this host. Supply a simple hostname, a fully qualified hostname with domain name, or an IP address (dot notation).
        port - the connection factory establishes TLS communication through a web proxy on this port.
        Throws:
        JMSException - if the proxy host is null or empty, the port is zero or the protocol of the connection factory's URL is not TLS.

      • setSSLProxyAuth

        public void setSSLProxyAuth​(java.lang.String username,
                            java.lang.String password)
                     throws JMSException
        Set a connection factory's username and password for connecting through a TLS proxy. When a connection factory establishes an EMS server connection through a TLS proxy host, the proxy might first require authentication before facilitating a connection. When required, use this call to set that authentication data on the connection factory. Notice that this proxy authentication data is distinct from the server authentication data, and from the TLS private key encryption password.
        Parameters:
        username - the connection factory authenticates itself to the TLS proxy using this username.
        password - the connection factory authenticates itself to the TLS proxy using this password.
        Throws:
        JMSException - if the protocol of the connection factory's URL is not TLS.

      • getSSLProxyHost

        public java.lang.String getSSLProxyHost()
                                 throws JMSException
        Get the TLS proxy host from this connection factory.
        Returns:
        the host
        Throws:
        JMSException - if the protocol of the connection factory's URL is not TLS.

      • getSSLProxyPort

        public int getSSLProxyPort()
                    throws JMSException
        Get the TLS proxy port from this connection factory.
        Returns:
        the port.
        Throws:
        JMSException - if the protocol of the connection factory's URL is not TLS.

      • getSSLProxyUser

        public java.lang.String getSSLProxyUser()
                                 throws JMSException
        Get the TLS proxy username from a connection factory.
        Returns:
        the username.
        Throws:
        JMSException - if the protocol of the connection factory's URL is not TLS.

      • getSSLProxyPassword

        public java.lang.String getSSLProxyPassword()
                                     throws JMSException
        Get the TLS proxy password from a connection factory.
        Returns:
        the password.
        Throws:
        JMSException - if the protocol of the connection factory's URL is not TLS.

      • setOAuth2AccessToken

        public void setOAuth2AccessToken​(java.lang.String accessToken)
        Set the OAuth 2.0 access token that connections will present to the EMS server.
        Parameters:
        accessToken -
        Since:
        10.4.0
        See Also:
        Tibjms.PROP_OAUTH2_ACCESS_TOKEN

      • setOAuth2ServerUrl

        public void setOAuth2ServerUrl​(java.lang.String serverUrl)
        Set the URL of the OAuth 2.0 authorization server that the client will request access tokens from.
        Parameters:
        serverUrl -
        Since:
        10.4.0
        See Also:
        Tibjms.PROP_OAUTH2_SERVER_URL

      • setOAuth2ClientId

        public void setOAuth2ClientId​(java.lang.String clientId)
        Set the OAuth 2.0 client ID that the client will use when connecting to the OAuth 2.0 authorization server.
        Parameters:
        clientId -
        Since:
        10.4.0
        See Also:
        Tibjms.PROP_OAUTH2_CLIENT_ID

      • setOAuth2ClientSecret

        public void setOAuth2ClientSecret​(java.lang.String clientSecret)
        Set the OAuth 2.0 client secret that the client will use when connecting to the OAuth 2.0 authorization server.
        Parameters:
        clientSecret -
        Since:
        10.4.0
        See Also:
        Tibjms.PROP_OAUTH2_CLIENT_SECRET

      • setOAuth2ServerTrustFile

        public void setOAuth2ServerTrustFile​(java.lang.String serverTrustFile)
        Set the trust file path for verifying the identity of the secure OAuth 2.0 authorization server. The trust file set via this property must contain one or more PEM-encoded public certificates.
        Parameters:
        serverTrustFile - The PEM-encoded certificate file path
        Since:
        10.4.0
        See Also:
        Tibjms.PROP_OAUTH2_SERVER_TRUST_FILE

      • setOAuth2ServerTrustFile

        public void setOAuth2ServerTrustFile​(byte[] serverTrustFile)
        Set the trust contents for verifying the identity of the secure OAuth 2.0 authorization server. The byte array set via this property must contain one or more PEM-encoded public certificates.
        Parameters:
        serverTrustFile - The PEM-encoded certificate, represented as raw bytes
        Since:
        10.4.0
        See Also:
        Tibjms.PROP_OAUTH2_SERVER_TRUST_FILE

      • setOAuth2DisableVerifyHostname

        public void setOAuth2DisableVerifyHostname​(boolean disableVerifyHostname)
        Set whether to disable client verification of the hostname in the secure OAuth 2.0 authorization server host's certificate.
        Parameters:
        disableVerifyHostname -
        Since:
        10.4.0
        See Also:
        Tibjms.PROP_OAUTH2_DISABLE_VERIFY_HOSTNAME

      • setOAuth2ExpectedHostname

        public void setOAuth2ExpectedHostname​(java.lang.String expectedHostname)
        Set the hostname that is expected to be set in the secure OAuth 2.0 authorization server host's certificate.
        Parameters:
        expectedHostname -
        Since:
        10.4.0
        See Also:
        Tibjms.PROP_OAUTH2_EXPECTED_HOSTNAME

      • setMulticastEnabled

        @Deprecated
public void setMulticastEnabled​(boolean enabled)
        Deprecated.
        As of release 8.3
        Set whether MessageConsumers subscribed to a multicast-enabled topic will receive message over multicast.

        When enabled, MessageConsumers subscribed to a multicast-enabled topic will receive messages over multicast.

        The default is enabled.
        Parameters:
        enabled - true to enable multicast, false to disable multicast
        Since:
        EMS 5.0

      • setMulticastDaemon

        @Deprecated
public void setMulticastDaemon​(java.lang.String port)
        Deprecated.
        As of release 8.3
        Set the port on which the EMS client will connect to the multicast daemon.

        A connection to the multicast daemon is required when multicast is enabled and a MessageConsumer is subscribed to a multicast-enabled topic.

        NOTE: setting the port with this method will overrided the default port supplied by the server.
        Parameters:
        port - the port of the multicast daemon
        Since:
        EMS 5.0