com.ibm.broker.config.proxy

Class LocalBrokerConnectionParameters

  • java.lang.Object
    • com.ibm.broker.config.proxy.LocalBrokerConnectionParameters
  • All Implemented Interfaces:
    BrokerConnectionParameters


    public class LocalBrokerConnectionParameters
    extends java.lang.Object
    implements BrokerConnectionParameters
    Provides the connection parameters to a locally defined broker.

    Use the class in the following way:

         BrokerConnectionParameters bcp = new
             LocalBrokerConnectionParameters("MYBROKER");
         BrokerProxy.getInstance(bcp);
     

    You might want to consider using the BrokerProxy.getLocalInstance method, which provides a way of defining the LocalBrokerConnectionParameters object and connecting to the broker in a single method call.

    class com.ibm.broker.config.proxy.LocalBrokerConnectionParameters implements com.ibm.broker.config.proxy.BrokerConnectionParameters

    Responsibilities Represents a set of connection parameters to a locally defined broker.
    Collaborators IntegrationNodeConnectionParameters
    
     Change Activity:
     -------- ----------- -------------   ------------------------------------
     Reason:  Date:       Originator:     Comments:
     -------- ----------- -------------   ------------------------------------
     51619.19 2009-03-05  HDMPL           v7 Release
    
     
    • Constructor Summary

      Constructors 
      Constructor and Description
      LocalBrokerConnectionParameters(java.lang.String brokerName)
      Constructs a new instance that refers to connection properties to the locally defined broker with the supplied name.
    • Method Summary

      All Methods Instance Methods Concrete 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 getSessionIDString()
      Returns a String representation of the Session ID for this connection.
      java.lang.String getUserID()
      Returns the userid that will be used to authorize this application with the broker.
      java.lang.String toString()
      For diagnostic information, this method displays the current connection parameters.
      void validate(BrokerProxy proxy)
      This method is required by the IBM Integration API (CMP) and should not be called by user applications.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • LocalBrokerConnectionParameters

        public LocalBrokerConnectionParameters(java.lang.String brokerName)
        Constructs a new instance that refers to connection properties to the locally defined broker with the supplied name. A broker of the supplied name must exist on the machine on which the application is run. However, the value of the supplied parameter will not be validated until BrokerProxy.getInstance() is called.
        Parameters:
        brokerName - Name of the locally defined broker
    • Method Detail

      • getSender

        public 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.
        Specified by:
        getSender in interface BrokerConnectionParameters
        Returns:
        Sender an object capable of transmitting a byte array to a broker.
        Throws:
        ConfigManagerProxyLoggedException - if the security exit could not be instantiated
      • getProtocol

        public 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.
        Specified by:
        getProtocol in interface BrokerConnectionParameters
        Returns:
        CommsMessageSerializer an object capable of turning Comms Messages into byte streams.
      • toString

        public java.lang.String toString()
        For diagnostic information, this method displays the current connection parameters.
        Overrides:
        toString in class java.lang.Object
      • getUserID

        public java.lang.String getUserID()
        Returns the userid that will be used to authorize this application with the broker. This method will return null if the userid being used to authorize this application is the same as the userid that is running the IBM Integration API (CMP) application. Regardless of the return value of this method, the queue manager is initially connected using the userid under which the application is running.
        Specified by:
        getUserID in interface BrokerConnectionParameters
        Returns:
        String userId
      • getSessionIDString

        public java.lang.String getSessionIDString()
        Returns a String representation of the Session ID for this connection.
        Returns:
        String representation of the session ID.