org.apache.qpid.management.domain.services
Class ManagementClient

java.lang.Object
  extended by org.apache.qpid.management.domain.services.ManagementClient

public final class ManagementClient
extends Object

This is the Object representation of a management client. According to specification : "A software component that is separate from the messaging broker, connected to the management broker via an AMQP connection, which allows any software component to be managed remotely by QPID."


Constructor Summary
ManagementClient(UUID brokerId, BrokerConnectionData connectionData)
          Builds a new ManagementClient with the given identifier and connection data.
 
Method Summary
(package private)  void estabilishFirstConnectionWithBroker()
          Establishing initial communication Between Client and Broker.
 BrokerConnectionData getBrokerConnectionData()
          Returns the connection data associated with this management client.
(package private)  void shutdown()
          Shutdown procedure for this management client.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ManagementClient

ManagementClient(UUID brokerId,
                 BrokerConnectionData connectionData)
Builds a new ManagementClient with the given identifier and connection data.

Parameters:
brokerId - the broker identifier.
connectionData - the broker connection data (host, port, etc...)
Method Detail

toString

public String toString()
Overrides:
toString in class Object

getBrokerConnectionData

public BrokerConnectionData getBrokerConnectionData()
Returns the connection data associated with this management client.

Returns:
the connection data associated with this management client.

estabilishFirstConnectionWithBroker

void estabilishFirstConnectionWithBroker()
                                   throws StartupFailureException
Establishing initial communication Between Client and Broker. According to specification : "Communication is established between the management client and management agent using normal AMQP procedures. The client creates a connection to the broker and then establishes a session with its corresponding channel. Two private queues are then declared. A management queue is declared and bound to the qpid.management exchange with "mgmt.#" as routing key; in that way all management-related messages sent to the exchange will be received by this client. When a client successfully binds to the qpid.management exchange, the management agent schedules a schema broadcast to be sent to the exchange. The agent will publish, via the exchange, a description of the schema for all manageable objects in its control. That schema is therefore received by this service and it will be part of service's domain model."

Throws:
StartupFailureException - when this management client cannot perform startup operations due to an error.

shutdown

void shutdown()
Shutdown procedure for this management client.



Licensed to the Apache Software Foundation