org.codehaus.activemq.broker
Interface BrokerContainer

All Superinterfaces:

Service

All Known Implementing Classes:

BrokerContainerImpl

public interface BrokerContainer

extends Service

The ActiveMQ JMS Broker Container which contains a Broker and one or more instances talking over some TransportChannel

Version:

$Revision: 1.4 $

Method Summary

void	acknowledgeMessage(BrokerClient client, MessageAck ack) Acknowledge reciept of a message
void	acknowledgeTransactedMessage(BrokerClient client, java.lang.String transactionId, MessageAck ack) Acknowledge receipt of a message within a transaction context
void	addConnector(BrokerConnector connector) Called when a new connector is added to this container
void	commitTransaction(BrokerClient client, ActiveMQXid xid, boolean onePhase) Commit an XA transaction.
void	commitTransaction(BrokerClient client, java.lang.String transactionId) Commit a transaction
void	deregisterConnection(BrokerClient client, ConnectionInfo info) un-registers a Connection
void	deregisterMessageConsumer(BrokerClient client, ConsumerInfo info) De-register a MessageConsumer from the Broker
void	deregisterMessageProducer(BrokerClient client, ProducerInfo info) De-register a MessageProducer from the Broker
void	deregisterSession(BrokerClient client, SessionInfo info) De-register a client-side Session from the Broker (used for monitoring)
void	durableUnsubscribe(BrokerClient client, DurableUnsubscribe ds) Command to delete a durable topic subscription
Broker	getBroker()
java.util.List	getConnectors()
ActiveMQXid[]	getPreparedTransactions(BrokerClient client) Gets the prepared XA transactions.
int	prepareTransaction(BrokerClient client, ActiveMQXid xid) Prepare an XA transaction.
void	registerConnection(BrokerClient client, ConnectionInfo info) registers a new Connection
void	registerMessageConsumer(BrokerClient client, ConsumerInfo info) Registers a MessageConsumer
void	registerMessageProducer(BrokerClient client, ProducerInfo info) Registers a MessageProducer
void	registerSession(BrokerClient client, SessionInfo info) Register a client-side Session (used for Monitoring)
void	removeConnector(BrokerConnector connector) Called when a connector is removed to this container
void	rollbackTransaction(BrokerClient client, ActiveMQXid xid) Rollback an XA transaction.
void	rollbackTransaction(BrokerClient client, java.lang.String transactionId) Rollback a transacton
void	sendMessage(BrokerClient client, ActiveMQMessage message) Send a non-transacted message to the Broker
void	sendTransactedMessage(BrokerClient client, java.lang.String transactionId, ActiveMQMessage message) send message with a transaction context
void	startTransaction(BrokerClient client, ActiveMQXid xid) Start an XA transaction.
void	startTransaction(BrokerClient client, java.lang.String transactionId) Start a transaction from the Client session

Methods inherited from interface org.codehaus.activemq.service.Service

start, stop

Method Detail

registerConnection

public void registerConnection(BrokerClient client,
                               ConnectionInfo info)
                        throws InvalidClientIDException

registers a new Connection

Parameters:

client -

info - infomation about the client-side Connection

Throws:

InvalidClientIDException - if the ClientID of the Connection is a duplicate

deregisterConnection

public void deregisterConnection(BrokerClient client,
                                 ConnectionInfo info)
                          throws JMSException

un-registers a Connection

Parameters:

client -

info - infomation about the client-side Connection

Throws:

JMSException

registerMessageConsumer

public void registerMessageConsumer(BrokerClient client,
                                    ConsumerInfo info)
                             throws JMSException

Registers a MessageConsumer

Parameters:

client -

info -

Throws:

JMSException

JMSSecurityException - if client authentication fails for the Destination the Consumer applies for

deregisterMessageConsumer

public void deregisterMessageConsumer(BrokerClient client,
                                      ConsumerInfo info)
                               throws JMSException

De-register a MessageConsumer from the Broker

Parameters:

client -

info -

Throws:

JMSException

registerMessageProducer

public void registerMessageProducer(BrokerClient client,
                                    ProducerInfo info)
                             throws JMSException

Registers a MessageProducer

Parameters:

client -

info -

Throws:

JMSException

JMSSecurityException - if client authentication fails for the Destination the Consumer applies for

deregisterMessageProducer

public void deregisterMessageProducer(BrokerClient client,
                                      ProducerInfo info)
                               throws JMSException

De-register a MessageProducer from the Broker

Parameters:

client -

info -

Throws:

JMSException

registerSession

public void registerSession(BrokerClient client,
                            SessionInfo info)
                     throws JMSException

Register a client-side Session (used for Monitoring)

Parameters:

client -

info -

Throws:

JMSException

deregisterSession

public void deregisterSession(BrokerClient client,
                              SessionInfo info)
                       throws JMSException

De-register a client-side Session from the Broker (used for monitoring)

Parameters:

client -

info -

Throws:

JMSException

startTransaction

public void startTransaction(BrokerClient client,
                             java.lang.String transactionId)
                      throws JMSException

Start a transaction from the Client session

Parameters:

client -

transactionId -

Throws:

JMSException

rollbackTransaction

public void rollbackTransaction(BrokerClient client,
                                java.lang.String transactionId)
                         throws JMSException

Rollback a transacton

Parameters:

client -

transactionId -

Throws:

JMSException

commitTransaction

public void commitTransaction(BrokerClient client,
                              java.lang.String transactionId)
                       throws JMSException

Commit a transaction

Parameters:

client -

transactionId -

Throws:

JMSException

sendTransactedMessage

public void sendTransactedMessage(BrokerClient client,
                                  java.lang.String transactionId,
                                  ActiveMQMessage message)
                           throws JMSException

send message with a transaction context

Parameters:

client -

transactionId -

message -

Throws:

JMSException

acknowledgeTransactedMessage

public void acknowledgeTransactedMessage(BrokerClient client,
                                         java.lang.String transactionId,
                                         MessageAck ack)
                                  throws JMSException

Acknowledge receipt of a message within a transaction context

Parameters:

client -

transactionId -

ack -

Throws:

JMSException

sendMessage

public void sendMessage(BrokerClient client,
                        ActiveMQMessage message)
                 throws JMSException

Send a non-transacted message to the Broker

Parameters:

client -

message -

Throws:

JMSException

acknowledgeMessage

public void acknowledgeMessage(BrokerClient client,
                               MessageAck ack)
                        throws JMSException

Acknowledge reciept of a message

Parameters:

client -

ack -

Throws:

JMSException

durableUnsubscribe

public void durableUnsubscribe(BrokerClient client,
                               DurableUnsubscribe ds)
                        throws JMSException

Command to delete a durable topic subscription

Parameters:

client -

ds -

Throws:

JMSException

startTransaction

public void startTransaction(BrokerClient client,
                             ActiveMQXid xid)
                      throws XAException

Start an XA transaction.

Parameters:

client -

xid -

Throws:

XAException

getPreparedTransactions

public ActiveMQXid[] getPreparedTransactions(BrokerClient client)
                                      throws XAException

Gets the prepared XA transactions.

Parameters:

client -

Returns:

Throws:

XAException

prepareTransaction

public int prepareTransaction(BrokerClient client,
                              ActiveMQXid xid)
                       throws XAException

Prepare an XA transaction.

Parameters:

client -

xid -

Throws:

XAException

rollbackTransaction

public void rollbackTransaction(BrokerClient client,
                                ActiveMQXid xid)
                         throws XAException

Rollback an XA transaction.

Parameters:

client -

xid -

Throws:

XAException

commitTransaction

public void commitTransaction(BrokerClient client,
                              ActiveMQXid xid,
                              boolean onePhase)
                       throws XAException

Commit an XA transaction.

Parameters:

client -

xid -

onePhase -

Throws:

XAException

addConnector

public void addConnector(BrokerConnector connector)

Called when a new connector is added to this container

Parameters:

connector -

removeConnector

public void removeConnector(BrokerConnector connector)

Called when a connector is removed to this container

Parameters:

connector -

getBroker

public Broker getBroker()

Returns:

the Broker for the Container

getConnectors

public java.util.List getConnectors()