com.ibm.broker.config.proxy
Interface ConfigManagerConnectionParameters

All Known Implementing Classes:
MQConfigManagerConnectionParameters, MQPropertyFileConfigManagerConnectionParameters

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):

When creating instances of these classes, it is recommended that, if possible, applications assign them to the ConfigManagerConnectionParameters interface, as this will allow them to easily switch to alternative connection methods if necessary. For example:
    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
 f47371    2007-07-30  HDMPL           v6.1 Release (no changes)

 

Version:
Config/com/ibm/broker/config/proxy/ConfigManagerConnectionParameters.java, CMP, S000 1.22

Method Summary
 java.lang.String getDeployID()
          This method is required by the Configuration Manager Proxy and should not be called by user applications.
 com.ibm.broker.config.common.CommsMessageSerializer getProtocol()
          This method is required by the Configuration Manager Proxy and should not be called by user applications.
 com.ibm.broker.config.proxy.Receiver getReceiver()
          This method is required by the Configuration Manager Proxy and should not be called by user applications.
 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 getUserID()
          This method is required by the Configuration Manager Proxy and should not be called by user applications.
 

Method Detail

getSender

com.ibm.broker.config.proxy.Sender getSender()
                                             throws ConfigManagerProxyLoggedException
This 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.

getReceiver

com.ibm.broker.config.proxy.Receiver getReceiver()
                                                 throws ConfigManagerProxyLoggedException
This 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.

getProtocol

com.ibm.broker.config.common.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.

getDeployID

java.lang.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

getUserID

java.lang.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