com.ibm.broker.config.proxy

Class MQPropertyFileBrokerConnectionParameters

  • All Implemented Interfaces:
    BrokerConnectionParameters

    Deprecated. 
    As of IBM Integration Bus v10, replaced by IntegrationNodeConnectionParameters

    @Deprecated
    public class MQPropertyFileBrokerConnectionParameters
    extends IntegrationNodeConnectionParameters
    implements BrokerConnectionParameters

    This class has been deprecated. As of IBM Integration Bus V10, MQ Broker Connections are no longer used and applications should use the IntegrationNodeConnectionParameters class to connect directly with brokers.

    For example:

         BrokerProxy b = BrokerProxy.getInstance(
             new IntegrationNodeConnectionParameters("localhost", 4414)); 
     

    To connect to a broker defined on the local machine, it is recommended that you use BrokerProxy.getLocalInstance instead.

    This class provides the connection parameters to a remote broker by reading a .broker properties file that contains the hostname, queue manager, port and security exit information.

    Use the class in the following way:

         BrokerConnectionParameters bcp = new
             MQPropertyFileBrokerConnectionParameters("b1.broker");
         BrokerProxy.getInstance(bcp);
     

    Files with a *.broker extension are obtained from the Message Broker Explorer by selecting the "Export *.broker file" option after right-clicking on a broker object.

    The file contains all possible connection information required in order to connect to a remote broker and takes the following form:

     <?xml version="1.0" encoding="UTF-8"?>
     <broker crlNameList="" domainName="" host="hostname.example.com" listenerPort="0"
        queueManager="MYQMGR" securityExit="" securityExitJar="" sslCipherSuite="NONE"
        sslDistinguishedNames="" sslKeyStore="" sslTrustStore="" svrconn="SYSTEM.BKR.CONFIG"/>
    (For compatibility with older applications, the root element "broker" can be altenatively set to "configmgr" with no effect.)

    class com.ibm.broker.config.proxy.MQPropertyFileBrokerConnectionParameters implements com.ibm.broker.config.proxy.BrokerConnectionParameters

    Responsibilities Represents a set of connection parameters to a remote WebSphere MQ based broker.
    Collaborators MQBrokerConnectionParameters
    
     Change Activity:
     -------- ----------- -------------   ------------------------------------
     Reason:  Date:       Originator:     Comments:
     -------- ----------- -------------   ------------------------------------
     51619.1  2008-07-16  HDMPL           v7 Release
     60252    2011-06-22  HDCAB           Added setSSLxxxStorePassword methods
    
     
    • Constructor Detail

      • MQPropertyFileBrokerConnectionParameters

        @Deprecated
        public MQPropertyFileBrokerConnectionParameters(java.lang.String filename)
        Deprecated. As of IBM Integration Bus v10, replaced by IntegrationNodeConnectionParameters
        Constructs a new instance that refers to connection properties in the file with the supplied fully qualified name. If the file cannot be read for whatever reason, the call to BrokerProxy.getInstance() will throw a ConfigManagerProxyLoggedException.
        Parameters:
        filename - Path and file name of the parameter file, which must be in the *.broker format. Supplying a null or blank parameter here has the same effect as calling the empty constructor.
    • Method Detail

      • getSecExit

        @Deprecated
        public java.lang.String getSecExit()
        Deprecated. As of IBM Integration Bus v10, replaced by IntegrationNodeConnectionParameters
        Returns the broker's security exit as stored in the properties file. If no security exit is defined, null or the empty string is returned.
        Returns:
        String Security Exit
      • getSecExitURL

        @Deprecated
        public java.net.URL getSecExitURL()
        Deprecated. As of IBM Integration Bus v10, replaced by IntegrationNodeConnectionParameters
        Returns the broker's security exit URL as stored in the properties file. If no security exit URL was defined, or an invalid security exit JAR was defined, null is returned.
        Returns:
        URL Security Exit
      • getSSLCipherSuite

        @Deprecated
        public java.lang.String getSSLCipherSuite()
        Deprecated. As of IBM Integration Bus v10, replaced by IntegrationNodeConnectionParameters
        Returns the broker's SSL cipher suite as stored in the properties file. If this parameter is not defined for this connection, null or the empty string is returned.
        Returns:
        String SSL cipher suite
      • getSSLCRLLDAPList

        @Deprecated
        public java.lang.String getSSLCRLLDAPList()
        Deprecated. As of IBM Integration Bus v10, replaced by IntegrationNodeConnectionParameters
        Returns the broker's SSL CRL LDAP list as stored in the properties file. If this parameter is not defined for this connection, null or the empty string is returned.
        Returns:
        String SSL CRL LDAP list
      • getSSLKeyStore

        @Deprecated
        public java.lang.String getSSLKeyStore()
        Deprecated. As of IBM Integration Bus v10, replaced by IntegrationNodeConnectionParameters
        Returns the broker's SSL key store as stored in the properties file. If this parameter is not defined for this connection, null or the empty string is returned.
        Returns:
        String SSL key store
      • getSSLPeerName

        @Deprecated
        public java.lang.String getSSLPeerName()
        Deprecated. As of IBM Integration Bus v10, replaced by IntegrationNodeConnectionParameters
        Returns the broker's SSL peer name as stored in the properties file. If this parameter is not defined for this connection, null or the empty string is returned.
        Returns:
        String SSL peer name
      • getSSLTrustStore

        @Deprecated
        public java.lang.String getSSLTrustStore()
        Deprecated. As of IBM Integration Bus v10, replaced by IntegrationNodeConnectionParameters
        Returns the broker's SSL trust store as stored in the properties file. If this parameter is not defined for this connection, null or the empty string is returned.
        Returns:
        String SSL trust store
      • setAdvancedConnectionParameters

        @Deprecated
        public void setAdvancedConnectionParameters(java.lang.String channelName,
                                                                java.lang.String requestQueueName,
                                                                java.lang.String responseQueueName,
                                                                int maxRetries,
                                                                int retryWaitMillis,
                                                                byte[] sessionID)
        Deprecated. As of IBM Integration Bus v10, replaced by IntegrationNodeConnectionParameters
        Sets the 'advanced' options for a connection to MQ.
        Parameters:
        channelName - The name of the WebSphere MQ Server Connection channel to use. If this is set to null, the existing value will be used.
        requestQueueName - This parameter is currently ignored.
        responseQueueName - This parameter is currently ignored.
        maxRetries - The number of times the IBM Integration API (CMP) should retry sending after consecutive failures. If this is set to -1, the existing value will be used.
        retryWaitMillis - The time (in milliseconds) the IBM Integration API (CMP) should wait inbetween retries. If this is set to -1, the existing value will be used.
        sessionID - A byte array containing an identifier that uniquely identifies this connection to the broker. This will be used as a correlId, and so should be no longer than 24 bytes. If this is set to null, the existing value will be used.
      • setSSLKeyStorePassword

        @Deprecated
        public void setSSLKeyStorePassword(java.lang.String password)
        Deprecated. As of IBM Integration Bus v10, replaced by IntegrationNodeConnectionParameters
        Sets the SSL key store password for the current connection. If this parameter is required, it must be supplied before BrokerProxy.getInstance() is invoked.
        Parameters:
        password - Password for the key store
      • setSSLTrustStorePassword

        @Deprecated
        public void setSSLTrustStorePassword(java.lang.String password)
        Deprecated. As of IBM Integration Bus v10, replaced by IntegrationNodeConnectionParameters
        Sets the SSL trust store password for the current connection. If this parameter is required, it must be supplied before BrokerProxy.getInstance() is invoked.
        Parameters:
        password - Password for the trust store
      • enableMQJavaClientTracing

        @Deprecated
        public static final void enableMQJavaClientTracing(java.lang.String filename)
        Deprecated. As of IBM Integration Bus v10, replaced by IntegrationNodeConnectionParameters
        Sends level 5 WebSphere MQ Java Client tracing to the specified file.
        Parameters:
        filename - of the trace file
      • disableMQJavaClientTracing

        @Deprecated
        public static final void disableMQJavaClientTracing()
        Deprecated. As of IBM Integration Bus v10, replaced by IntegrationNodeConnectionParameters
        Disables WebSphere MQ Java Client tracing