public interface ConfigManagerConnectionParameters
Configuration Manager Proxy applications must pass objects that implement this interface to the ConfigManagerProxy.getInstance() method, which enables them to connect to Configuration Managers.
There are currently two implementors of this interface (both of which live in the com.ibm.broker.config.proxy package):
ConfigManagerConnectionParameters cmcp = new MQPropertyFileConfigManagerConnectionParameters("cm1.configmgr");is preferable to:
MQPropertyFileConfigManagerConnectionParameters cmcp = new MQPropertyFileConfigManagerConnectionParameters("cm1.configmgr");...so long as cmcp is not required to call any methods specific to the MQPropertyFileConfigManagerConnectionParameters class.
interface
com.ibm.broker.config.proxy.ConfigManagerConnectionParameters
|
|
Responsibilities | States that implementing classes are able to provide objects capable of sending data to and receiving data from a Configuration Manager. |
Internal Collaborators |
com.ibm.broker.config.proxy.Sender
com.ibm.broker.config.proxy.Receiver |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------ f25103.11 2004-03-15 HDMPL v6 Release
Method | Description |
---|---|
String getDeployID() | This method is required by the Configuration Manager Proxy and should not be called by user applications. |
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 getUserID() | This method is required by the Configuration Manager Proxy and should not be called by user applications. |
public String getDeployID()This method is required by the Configuration Manager Proxy and should not be called by user applications. 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 deployID
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 Receiver could not be initialized.
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 Sender could not be initialized.
public String getUserID()This method is required by the Configuration Manager Proxy and should not be called by user applications. Returns the user ID associated with this ConfigManagerProxy connection.
- Returns
- String userID