com.ibm.broker.config.proxy

Interface BrokerConnectionParameters

All Known Implementing Classes:

LocalBrokerConnectionParameters, MQBrokerConnectionParameters, MQPropertyFileBrokerConnectionParameters

public interface BrokerConnectionParameters

In order to connect to brokers, applications must pass objects that implement this interface to the BrokerProxy.getInstance() method.

There are three implementors of this interface (all of which live in the com.ibm.broker.config.proxy package):

• LocalBrokerConnectionParameters, which allows applications to connect to locally defined brokers using just their name,
• MQBrokerConnectionParameters, which allows applications to connect to brokers using hostname or IP address, port, queue manager and security exit parameters, and
• MQPropertyFileConfigManagerConnectionParameters, which allows applications to connect to brokers using *.broker files.

interface com.ibm.broker.config.proxy.BrokerConnectionParameters
Responsibilities	States that implementing classes are able to provide objects capable of sending data to and receiving data from a broker.
Internal Collaborators	None

 Change Activity:
 --------  ----------- -------------   ------------------------------------
 Reason:   Date:       Originator:     Comments:
 --------  ----------- -------------   ------------------------------------
 f51619.1  2008-07-16  HDMPL           v7 Release

 

Method Summary

Methods

Modifier and Type	Method and Description
com.ibm.broker.config.proxy.CommsMessageSerializer	getProtocol() This method is required by the IBM Integration API (CMP) and should not be called by user applications.
com.ibm.broker.config.proxy.Receiver	getReceiver() This method is required by the IBM Integration API (CMP) and should not be called by user applications.
com.ibm.broker.config.proxy.Sender	getSender() This method is required by the IBM Integration API (CMP) and should not be called by user applications.
java.lang.String	getUserID() This method is required by the IBM Integration API (CMP) 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 IBM Integration API (CMP) 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 broker.

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 IBM Integration API (CMP) 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 broker.

Throws:

ConfigManagerProxyLoggedException - if the Receiver could not be initialized.

getProtocol

com.ibm.broker.config.proxy.CommsMessageSerializer getProtocol()

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.

Returns:

CommsMessageSerializer an object capable of turning Comms Messages into byte streams.

getUserID

java.lang.String getUserID()

This method is required by the IBM Integration API (CMP) and should not be called by user applications. Returns the user ID associated with this connection.

Returns:

String userID