com.ibm.broker.config.proxy

Class MQPropertyFileConfigManagerConnectionParameters

  • java.lang.Object
    • com.ibm.broker.config.proxy.MQPropertyFileConfigManagerConnectionParameters
  • All Implemented Interfaces:
    ConfigManagerConnectionParameters

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

    @Deprecated
    public class MQPropertyFileConfigManagerConnectionParameters
    extends java.lang.Object
    implements ConfigManagerConnectionParameters

    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 allows user-written IBM Integration API (CMP) applications to specify a set of connection parameters that can be used to connect to MQ-based brokers.

    This class is included for compatibility with older applications. Application should instead use IntegrationNodeConnectionParameters.

    
     Change Activity:
     -------- ----------- -------------   ------------------------------------
     Reason:  Date:       Originator:     Comments:
     -------- ----------- -------------   ------------------------------------
     25103.7  2004-03-24  HDMPL           v6 Release
     47371    2007-07-30  HDMPL           v6.1 Release
     f51619.1 2008-07-17  HDMPL           v7 Release:
                                             Deprecated class
    
     
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method and Description
      void disableDomainAwareness()
      Deprecated. 
      As of WebSphere Message Broker V7, Configuration Manager ACLs are no longer used, and so this method is no longer required.
      static void disableMQJavaClientTracing()
      Deprecated. 
      Disables WebSphere MQ Java Client tracing
      static void enableMQJavaClientTracing(java.lang.String filename)
      Deprecated. 
      Sends level 5 WebSphere MQ Java Client tracing to the specified file.
      java.lang.String generateUniqueDeployID()
      Deprecated. 
      Sets the deploy ID for the current connection to a unique String and returns it.
      java.lang.String getDeployID()
      Deprecated. 
      This method should not be used.
      java.lang.String getHostname()
      Deprecated. 
      Returns the broker's queue manager's IP address or host name as stored in the properties file.
      int getPort()
      Deprecated. 
      Returns the broker's queue manager's port as stored in the properties file.
      com.ibm.broker.config.proxy.CommsMessageSerializer getProtocol()
      Deprecated. 
      This method is required by the IBM Integration API (CMP) and should not be called by user applications.
      java.lang.String getQueueManager()
      Deprecated. 
      Returns the broker's queue manager name as stored in the properties file.
      com.ibm.broker.config.proxy.Receiver getReceiver()
      Deprecated. 
      This method is required by the IBM Integration API (CMP) and should not be called by user applications.
      java.lang.String getSecExit()
      Deprecated. 
      Returns the broker's security exit as stored in the properties file.
      java.net.URL getSecExitURL()
      Deprecated. 
      Returns the broker's security exit URL as stored in the properties file.
      com.ibm.broker.config.proxy.Sender getSender()
      Deprecated. 
      This method is required by the IBM Integration API (CMP) and should not be called by user applications.
      java.lang.String getSessionIDString()
      Deprecated. 
      Returns a String representation of the Session ID for this MQ Connection.
      java.lang.String getSSLCipherSuite()
      Deprecated. 
      Returns the broker's SSL cipher suite as stored in the properties file.
      java.lang.String getSSLCRLLDAPList()
      Deprecated. 
      Returns the broker's SSL CRL LDAP list as stored in the properties file.
      java.lang.String getSSLKeyStore()
      Deprecated. 
      Returns the broker's SSL key store as stored in the properties file.
      java.lang.String getSSLPeerName()
      Deprecated. 
      Returns the broker's SSL peer name as stored in the properties file.
      java.lang.String getSSLTrustStore()
      Deprecated. 
      Returns the broker's SSL trust store as stored in the properties file.
      java.lang.String getUserID()
      Deprecated. 
      Returns the userid and machine name string that will be used to authorize this application with the broker.
      void setAdvancedConnectionParameters(java.lang.String channelName, java.lang.String requestQueueName, java.lang.String responseQueueName, int maxRetries, int retryWaitMillis, java.lang.String deployID, byte[] sessionID)
      Deprecated. 
      Sets the 'advanced' options for a connection to MQ.
      java.lang.String toString()
      Deprecated. 
      For diagnostic information, this method displays the current connection parameters.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • MQPropertyFileConfigManagerConnectionParameters

        public MQPropertyFileConfigManagerConnectionParameters(java.lang.String filename)
        Deprecated. 
        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 ConfigManagerProxy.getInstance() will throw a ConfigManagerProxyLoggedException.
        Parameters:
        filename - Path and file name of the parameter file, which must be in the *.configmgr format. Supplying a null or blank parameter here has the same effect as calling the empty constructor.
      • MQPropertyFileConfigManagerConnectionParameters

        public MQPropertyFileConfigManagerConnectionParameters()
        Deprecated. the default constructor is no longer supported. Use IntegrationNodeConnectionParameters(String) instead.
        This method instantiates a new MQPropertyFileConfigManagerConnectionParameters instance, but any attempt to use the returned instance will result in a ConfigManagerProxyLoggedException thrown on the getInstance() method. Use IntegrationNodeConnectionParameters(String) instead.
    • Method Detail

      • getHostname

        public java.lang.String getHostname()
        Deprecated. 
        Returns the broker's queue manager's IP address or host name as stored in the properties file.
        Returns:
        String hostname
      • getPort

        public int getPort()
        Deprecated. 
        Returns the broker's queue manager's port as stored in the properties file. If no port was specified, the default value of 1414 will be returned.
        Returns:
        int port
      • getQueueManager

        public java.lang.String getQueueManager()
        Deprecated. 
        Returns the broker's queue manager name as stored in the properties file.
        Returns:
        String Queue Manager
      • getSecExit

        public java.lang.String getSecExit()
        Deprecated. 
        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

        public java.net.URL getSecExitURL()
        Deprecated. 
        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

        public java.lang.String getSSLCipherSuite()
        Deprecated. 
        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

        public java.lang.String getSSLCRLLDAPList()
        Deprecated. 
        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

        public java.lang.String getSSLKeyStore()
        Deprecated. 
        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

        public java.lang.String getSSLPeerName()
        Deprecated. 
        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

        public java.lang.String getSSLTrustStore()
        Deprecated. 
        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

        public void setAdvancedConnectionParameters(java.lang.String channelName,
                                                    java.lang.String requestQueueName,
                                                    java.lang.String responseQueueName,
                                                    int maxRetries,
                                                    int retryWaitMillis,
                                                    java.lang.String deployID,
                                                    byte[] sessionID)
        Deprecated. 
        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 MQSender should retry after consecutive failures. If this is set to -1, the existing value will be used.
        retryWaitMillis - The time (in milliseconds) the MQSender should wait inbetween retries. If this is set to -1, the existing value will be used.
        deployID - This value is ignored.
        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.
      • getProtocol

        public com.ibm.broker.config.proxy.CommsMessageSerializer getProtocol()
        Deprecated. 
        This method is required by the IBM Integration API (CMP) and should not be called by user applications. Returns an instance of the wire protocol associated with this connection.
        Specified by:
        getProtocol in interface ConfigManagerConnectionParameters
        Returns:
        CommsMessageSerializer an object capable of turning Comms Messages into byte streams.
      • toString

        public java.lang.String toString()
        Deprecated. 
        For diagnostic information, this method displays the current connection parameters.
        Overrides:
        toString in class java.lang.Object
      • getDeployID

        public java.lang.String getDeployID()
        Deprecated. This method should not be used.
        This method is functionally equivalent to getUserID().
        Specified by:
        getDeployID in interface ConfigManagerConnectionParameters
        Returns:
        String
      • disableDomainAwareness

        public void disableDomainAwareness()
        Deprecated. As of WebSphere Message Broker V7, Configuration Manager ACLs are no longer used, and so this method is no longer required.
        This method does nothing.
      • getUserID

        public java.lang.String getUserID()
        Deprecated. 
        Returns the userid and machine name string that will be used to authorize this application with the broker.
        Specified by:
        getUserID in interface ConfigManagerConnectionParameters
        Returns:
        String userId and machine, in the form "user@machine"
      • enableMQJavaClientTracing

        public static final void enableMQJavaClientTracing(java.lang.String filename)
        Deprecated. 
        Sends level 5 WebSphere MQ Java Client tracing to the specified file.
        Parameters:
        filename - of the trace file
      • disableMQJavaClientTracing

        public static final void disableMQJavaClientTracing()
        Deprecated. 
        Disables WebSphere MQ Java Client tracing
      • getSessionIDString

        public java.lang.String getSessionIDString()
        Deprecated. 
        Returns a String representation of the Session ID for this MQ Connection.
        Returns:
        String representation of the session ID.
      • generateUniqueDeployID

        public java.lang.String generateUniqueDeployID()
        Deprecated. 
        Sets the deploy ID for the current connection to a unique String and returns it.
        Returns:
        String the generated deploy ID