|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.broker.config.proxy.MQPropertyFileConfigManagerConnectionParameters
public class MQPropertyFileConfigManagerConnectionParameters
Provides the connection parameters to a Configuration Manager by reading a properties file that contains the hostname, queue manager, port and security exit information. The class is able to parse *.configmgr files (as created in the toolkit) as well as the mqsicfgutil.ini format.
There are two ways of connecting to a Configuration Manager using this class. The preferred method is by specifying the location of a *.configmgr file:
ConfigManagerConnectionParameters cmcp = new MQPropertyFileConfigManagerConnectionParameters("cm1.configmgr"); ConfigManagerProxy.getInstance(cmcp);However, the empty constructor may also be used, which will attempt to connect to a Configuration Manager using the information in the file mqsicfgutil.ini. This method is not recommended for new applications.
ConfigManagerProxy.getInstance( new MQPropertyFileConfigManagerConnectionParameters() );
NOTE: As the .configmgr file is XML, an XML parser is needs to be available on the CLASSPATH in order to load such a file. Configuration Manager Proxy applications using a v1.3-based JRE will need to manually add such a parser to the CLASSPATH in order to use this class.
class
com.ibm.broker.config.proxy.MQPropertyFileConfigManagerConnectionParameters
implements
com.ibm.broker.config.proxy.ConfigManagerConnectionParameters
|
|
Responsibilities | Represents a set of connection parameters to a WebSphere MQ based Configuration Manager. |
Collaborators | MQConfigManagerConnectionParameters |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------ 25103.7 2004-03-24 HDMPL v6 Release 47371 2007-07-30 HDMPL v6.1 Release
Constructor Summary | |
---|---|
MQPropertyFileConfigManagerConnectionParameters()
Constructs a new instance that refers to connection properties in the file 'mqsicfgutil.ini' in the JRE's current directory. |
|
MQPropertyFileConfigManagerConnectionParameters(java.lang.String filename)
Constructs a new instance that refers to connection properties in the file with the supplied fully qualified name. |
Method Summary | |
---|---|
void |
disableDomainAwareness()
Prevents Windows domain awareness support from initializing for this instance. |
static void |
disableMQJavaClientTracing()
Disables WebSphere MQ Java Client tracing |
static void |
enableMQJavaClientTracing(java.lang.String filename)
Sends level 5 WebSphere MQ Java Client tracing to the specified file. |
java.lang.String |
generateUniqueDeployID()
Sets the deploy ID for the current connection to a unique String and returns it. |
java.lang.String |
getDeployID()
Returns the string used to uniquely map each deployment request back to this ConfigManagerProxy connection. |
java.lang.String |
getHostname()
Returns the Configuration Manager's IP address or host name as stored in the properties file. |
int |
getPort()
Returns the Configuration Manager's port as stored in the properties file. |
com.ibm.broker.config.common.CommsMessageSerializer |
getProtocol()
This method is required by the Configuration Manager Proxy and should not be called by user applications. |
java.lang.String |
getQueueManager()
Returns the Configuration Manager's queue manager as stored in the properties file. |
com.ibm.broker.config.proxy.Receiver |
getReceiver()
This method is required by the Configuration Manager Proxy and should not be called by user applications. |
java.lang.String |
getSecExit()
Returns the Configuration Manager's security exit as stored in the properties file. |
java.net.URL |
getSecExitURL()
Returns the Configuration Manager's security exit URL as stored in the properties file. |
com.ibm.broker.config.proxy.Sender |
getSender()
This method is required by the Configuration Manager Proxy and should not be called by user applications. |
java.lang.String |
getSessionIDString()
Returns a String representation of the Session ID for this MQ Connection. |
java.lang.String |
getSSLCipherSuite()
Returns the Configuration Manager's SSL cipher suite as stored in the properties file. |
java.lang.String |
getSSLCRLLDAPList()
Returns the Configuration Manager's SSL CRL LDAP list as stored in the properties file. |
java.lang.String |
getSSLKeyStore()
Returns the Configuration Manager's SSL key store as stored in the properties file. |
java.lang.String |
getSSLPeerName()
Returns the Configuration Manager's SSL peer name as stored in the properties file. |
java.lang.String |
getSSLTrustStore()
Returns the Configuration Manager's SSL trust store as stored in the properties file. |
java.lang.String |
getUserID()
Crosses the JNI to return the correctly formatted MQSeries userId & domain. |
void |
setAdvancedConnectionParameters(java.lang.String channelName,
java.lang.String requestQueueName,
java.lang.String responseQueueName,
int maxRetries,
int retryWaitMillis,
java.lang.String deployID,
byte[] sessionID)
Sets the 'advanced' options for a connection to MQ. |
java.lang.String |
toString()
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 |
---|
public MQPropertyFileConfigManagerConnectionParameters(java.lang.String filename)
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.public MQPropertyFileConfigManagerConnectionParameters()
Method Detail |
---|
public java.lang.String getHostname()
public int getPort()
public java.lang.String getQueueManager()
public java.lang.String getSecExit()
public java.net.URL getSecExitURL()
public java.lang.String getSSLCipherSuite()
public java.lang.String getSSLCRLLDAPList()
public java.lang.String getSSLKeyStore()
public java.lang.String getSSLPeerName()
public java.lang.String getSSLTrustStore()
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)
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 com.ibm.broker.config.proxy.Sender getSender() throws ConfigManagerProxyLoggedException
getSender
in interface ConfigManagerConnectionParameters
ConfigManagerProxyLoggedException
- if the security exit could not be instantiatedpublic com.ibm.broker.config.proxy.Receiver getReceiver() throws ConfigManagerProxyLoggedException
getReceiver
in interface ConfigManagerConnectionParameters
ConfigManagerProxyLoggedException
- if the security exit could not be instantiatedpublic com.ibm.broker.config.common.CommsMessageSerializer getProtocol()
getProtocol
in interface ConfigManagerConnectionParameters
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getDeployID()
getDeployID
in interface ConfigManagerConnectionParameters
public void disableDomainAwareness()
public java.lang.String getUserID()
getUserID
in interface ConfigManagerConnectionParameters
public static final void enableMQJavaClientTracing(java.lang.String filename)
filename
- of the trace filepublic static final void disableMQJavaClientTracing()
public java.lang.String getSessionIDString()
public java.lang.String generateUniqueDeployID()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |