java.lang.Object com.ibm.broker.config.proxy.MQConfigManagerConnectionParameters
public class MQConfigManagerConnectionParameters
implements ConfigManagerConnectionParameters
extends Object
Allows user-written Configuration Manager Proxy applications to specify a set of connection parameters that can be used to connect to MQ-based Configuration Managers.
Applications should create an instance of this class if they require the hostname, port, queue manager and (optionally) security exit information in order to connect to a Configuration Manager. In order to attempt a connection, the instance must then be passed to the ConfigManagerProxy.getInstance() method. For example:
ConfigManagerProxy.getInstance( new MQConfigManagerConnectionParameters( "mymachine.domain.com", 1414, "MYQM"));Note that once the getInstance() method has been called, modifying the MQConfigManagerConnectionParameters object will have no effect on existing connections.
class
com.ibm.broker.config.proxy.MQConfigManagerConnectionParameters
implements
com.ibm.broker.config.proxy.ConfigManagerConnectionParameters
|
|
Responsibilities | Represents a set of connection parameters to a WebSphere MQ based Configuration Manager. |
Collaborators | com.ibm.mq.* |
Change Activity: --------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: --------- ----------- ------------- ------------------------------------ f25103.1 2004-03-15 HDMPL v6 Release
Constructor | Description |
---|---|
MQConfigManagerConnectionParameters(String, int, String) | Takes the parameters required to connect to an MQSeries-based Config Manager. |
MQConfigManagerConnectionParameters(String, int, String, String) | Takes the parameters required to connect to an MQSeries-based Config Manager. |
MQConfigManagerConnectionParameters(String, int, String, String, URL) | Takes the parameters required to connect to an MQSeries-based Config Manager. |
MQConfigManagerConnectionParameters(String, int, String, String, URL, String, String, String, String, Collection) | Constructor. |
MQConfigManagerConnectionParameters(String, int, String, String, URL, String, String, String, String, String) | Constructor. |
Method | Description |
---|---|
void disableDomainAwareness() | Prevents Windows domain awareness support from initializing for this instance. |
void disableMQJavaClientTracing() | Disables WebSphere MQ Java Client tracing |
void enableMQJavaClientTracing(String) | Sends level 5 WebSphere MQ Java Client tracing to the specified file. |
String generateUniqueDeployID() | Generates a deploy ID and returns it. |
String getDeployID() | Returns the string used to uniquely map each deployment request back to this ConfigManagerProxy connection. |
CommsMessageSerializer getProtocol() | This method is required by the Configuration Manager Proxy and should not be called by user applications. |
Receiver getReceiver() | This method is required by the Configuration Manager Proxy and should not be called by user applications. |
Sender getSender() | This method is required by the Configuration Manager Proxy and should not be called by user applications. |
String getSessionIDString() | Returns a String representation of the session Id for this connection to the Configuration Manager. |
String[] getSupportedSSLCipherSuites() | Minimum set of supported SSL Cipher Suites |
String getUserID() | Crosses the JNI to return the correctly formatted MQSeries userId & domain. |
void setAdvancedConnectionParameters(String, String, String, int, int, String, byte[]) | Sets the 'advanced' options for a connection to MQ. |
String toString() | For diagnostic information, this method displays the current connection parameters. |
public MQConfigManagerConnectionParameters(String ip, int port, String qmgr)Takes the parameters required to connect to an MQSeries-based Config Manager. Upon returning from this method, the supplied data will not have been validated and a connection to a Configuration Manager will not have been established. All this work takes place during the call to ConfigManagerProxy.getInstance().
- Parameters
- ip - IP Address of the target server
- port - Port of the target server
- qmgr - MQSeries Queue Manager which the Configuration Manager is using
public MQConfigManagerConnectionParameters(String ip, int port, String qmgr, String mqseClassname)Takes the parameters required to connect to an MQSeries-based Config Manager. Upon returning from this method, the supplied data will not have been validated and a connection to a Configuration Manager will not have been established. All this work takes place during the call to ConfigManagerProxy.getInstance().
- Parameters
- ip - IP Address of the target server
- port - Port of the target server
- qmgr - MQSeries Queue Manager which the Configuration Manager is using
- mqseClassname - Name of the Security Exit to use with this connection. The Security Exit will be loaded using the standard class loader.
public MQConfigManagerConnectionParameters(String ip, int port, String qmgr, String mqseClassname, URL mqseURL)Takes the parameters required to connect to an MQSeries-based Config Manager. Upon returning from this method, the supplied data will not have been validated and a connection to a Configuration Manager will not have been established. All this work takes place during the call to ConfigManagerProxy.getInstance().
- Parameters
- ip - IP Address of the target server
- port - Port of the target server
- qmgr - MQSeries Queue Manager which the Configuration Manager is using
- mqseClassname - Name of the Security Exit to use with this connection. If running inside an Eclipse environment, callers should also use the mqseURL parameter.
- mqseURL - URL that describes where the MQ Security Exit can be loaded. If null, the standard class loader will be used to locate and instantiate the security exit class.
public MQConfigManagerConnectionParameters(String ip, int port, String qmgr, String mqseClassname, URL mqseURL, String sslCipherSuite, String sslPeerName, String sslKeyStore, String sslTrustStore, Collection sslCRLLdapCollection)Constructor. Takes the parameters required to connect to an MQSeries-based Config Manager. Upon returning from this method, the supplied data will not have been validated and a connection to a Configuration Manager will not have been established. All this work takes place during the call to ConfigManagerProxy.getInstance().
- Parameters
- ip - - IP Address of the target server
- port - - Port of the target server
- qmgr - - MQSeries Queue Manager which the Configuration Manager is using
- mqseClassname - - Name of the Security Exit to use with this connection. If running inside an Eclipse environment, callers should also use the mqseURL parameter.
- mqseURL - URL that describes where the MQ Security Exit can be loaded. If null, the standard class loader will be used to locate and instantiate the security exit class.
- sslCipherSuite - SSL CipherSuite to be used
- sslPeerName - SSL Peername to be used
- sslKeyStore - SSL KeyStore to be used
- sslTrustStore - SSL TrustStore to be used
- sslCRLLdapCollection - A collection of CertStore objects represting LDAP servers hosting CRLs
public MQConfigManagerConnectionParameters(String ip, int port, String qmgr, String mqseClassname, URL mqseURL, String sslCipherSuite, String sslPeerName, String sslKeyStore, String sslTrustStore, String sslCRLLdapList)Constructor. Takes the parameters required to connect to an MQSeries-based Config Manager. Upon returning from this method, the supplied data will not have been validated and a connection to a Configuration Manager will not have been established. All this work takes place during the call to ConfigManagerProxy.getInstance().
- Parameters
- ip - - IP Address of the target server
- port - - Port of the target server
- qmgr - - MQSeries Queue Manager which the Configuration Manager is using
- mqseClassname - - Name of the Security Exit to use with this connection. If running inside an Eclipse environment, callers should also use the mqseURL parameter.
- mqseURL - URL that describes where the MQ Security Exit can be loaded. If null, the standard class loader will be used to locate and instantiate the security exit class.
- sslCipherSuite - SSL CipherSuite to be used
- sslPeerName - SSL Peername to be used
- sslKeyStore - SSL KeyStore to be used
- sslTrustStore - SSL TrustStore to be used
- sslCRLLdapList - A comma seperated list of LDAP servers hosting CRLs
public void disableDomainAwareness()Prevents Windows domain awareness support from initializing for this instance. If disabled, the userid will be obtained from the user.name property in the JVM. If required, this method must be called before ConfigManagerProxy.getInstance().
public static final void disableMQJavaClientTracing()Disables WebSphere MQ Java Client tracing
public static final void enableMQJavaClientTracing(String filename)Sends level 5 WebSphere MQ Java Client tracing to the specified file.
- Parameters
- filename - of the trace file
public static String generateUniqueDeployID()Generates a deploy ID and returns it.
- Returns
- String the generated deploy ID
public String getDeployID()Returns the string used to uniquely map each deployment request back to this ConfigManagerProxy connection. Most of the time the current userid is a sufficient deployID, as the field is only used to get back the correct log records related to each deployment.
- Returns
- String Deployment identifier
public CommsMessageSerializer getProtocol()This method is required by the Configuration Manager Proxy and should not be called by user applications. Returns an instance of the wire protocol associated with this connection.
- Returns
- CommsMessageSerializer - an object capable of turning Comms Messages into byte streams.
public Receiver getReceiver() throws ConfigManagerProxyLoggedExceptionThis method is required by the Configuration Manager Proxy and should not be called by user applications. Returns an instance of the Receiver associated with this type.
- Returns
- Sender an object capable of receiving byte arrays from a Configuration Manager.
- Throws
ConfigManagerProxyLoggedException
if the security exit could not be instantiated
public Sender getSender() throws ConfigManagerProxyLoggedExceptionThis method is required by the Configuration Manager Proxy and should not be called by user applications. Returns an instance of the Sender associated with this type.
- Returns
- Sender an object capable of transmitting a byte array to a Configuration Manager.
- Throws
ConfigManagerProxyLoggedException
if the security exit could not be instantiated
public String getSessionIDString()Returns a String representation of the session Id for this connection to the Configuration Manager.
- Returns
- String representation of the session Id.
public static final String[] getSupportedSSLCipherSuites()Minimum set of supported SSL Cipher Suites
- Returns
- String[] Supported SSL Cipher Suites
public String getUserID()Crosses the JNI to return the correctly formatted MQSeries userId & domain. If domain awareness has been disabled, or if the LogonInfo classes or DLL could not be loaded, the value of the system property 'user.name' will be returned.
- Returns
- String userId (and possibly domain, using '@' as a separator).
public void setAdvancedConnectionParameters(String channelName, String requestQueueName, String responseQueueName, int maxRetries, int retryWaitMillis, String deployID, byte[] sessionID)Sets the 'advanced' options for a connection to MQ. User-written Configuration Manager Proxy applications should never need to use this method.
- Parameters
- channelName - The name of the MQSeries Server Connection channel to use. If this is set to null, the existing value will be used.
- requestQueueName - The name of the MQSeries queue to which messages will be put. If this is set to null, the existing value will be used.
- responseQueueName - The name of the MQSeries queue from which messages will be got. If this is set to null, the existing value will be used.
- 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 - The String used to map deployment requests uniquely back to this connection. If this is set to null the existing value will be used.
- sessionID - A byte array containing an identifier that uniquely identifies this connection to the Configuration Manager. 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.
public String toString()For diagnostic information, this method displays the current connection parameters.