BrokerClient

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> activemq >> [ broker overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.activemq.broker.BrokerClient

SOURCE |

Download org.activemq.broker.BrokerClient

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.activemq.broker
Interface BrokerClient

All Superinterfaces:: org.activemq.service.Service

All Known Implementing Classes:: BrokerClientStub

public interface BrokerClient
extends org.activemq.service.Service

A Broker side proxy representing mostly outbound JMS Connnection

Method Summary

void cleanUp()
          Called when the transport has been terminated, so do our best to shut down any resources and deregister from any subscriptions etc

void dispatch(org.activemq.message.ActiveMQMessage message)
          Dispatch an ActiveMQMessage to the end client

BrokerConnector getBrokerConnector()


int getCapacity()
          Get the Capacity for in-progress messages at the peer (probably a JMSConnection) Legimate values between 0-100.

org.activemq.transport.TransportChannel getChannel()


java.lang.String getClientID()


org.activemq.message.ConnectionInfo getConnectionInfo()


javax.security.auth.Subject getSubject()


void initialize(BrokerConnector brokerConnector, org.activemq.transport.TransportChannel channel)
          Initialize the Brokerclient

boolean isBrokerConnection()


boolean isClusteredConnection()


boolean isSlowConsumer()
          Get an indication if the peer should be considered as a slow consumer

void setSubject(javax.security.auth.Subject subject)
          Associcates a subject with BrokerClient.

void updateBrokerCapacity(int capacity)
          Update the peer Connection about the Broker's capacity for messages

void validateConnection(int timeout)
          Tests the connection to assert that it in fact is alive by asserting that a full round-trip to the client is possible.

Methods inherited from interface org.activemq.service.Service

start, stop

Method Detail

initialize

public void initialize(BrokerConnector brokerConnector,
                       org.activemq.transport.TransportChannel channel)

Initialize the Brokerclient

dispatch

public void dispatch(org.activemq.message.ActiveMQMessage message)

Dispatch an ActiveMQMessage to the end client

isBrokerConnection

public boolean isBrokerConnection()

isClusteredConnection

public boolean isClusteredConnection()

getCapacity

public int getCapacity()

Get the Capacity for in-progress messages at the peer (probably a JMSConnection) Legimate values between 0-100. 0 capacity representing that the peer cannot process any more messages at the current time

isSlowConsumer

public boolean isSlowConsumer()

Get an indication if the peer should be considered as a slow consumer

updateBrokerCapacity

public void updateBrokerCapacity(int capacity)

Update the peer Connection about the Broker's capacity for messages

getClientID

public java.lang.String getClientID()

cleanUp

public void cleanUp()

Called when the transport has been terminated, so do our best to shut down any resources and deregister from any subscriptions etc

getChannel

public org.activemq.transport.TransportChannel getChannel()

getBrokerConnector

public BrokerConnector getBrokerConnector()

setSubject

public void setSubject(javax.security.auth.Subject subject)

Associcates a subject with BrokerClient.

getSubject

public javax.security.auth.Subject getSubject()

validateConnection

public void validateConnection(int timeout)
                        throws javax.jms.JMSException

Tests the connection to assert that it in fact is alive by asserting that a full round-trip to the client is possible.

getConnectionInfo

public org.activemq.message.ConnectionInfo getConnectionInfo()