org.apache.activemq.broker
Class ErrorBroker

java.lang.Object
  extended by org.apache.activemq.broker.ErrorBroker
All Implemented Interfaces:
Broker, Region, Service

public class ErrorBroker
extends Object
implements Broker

Implementation of the broker where all it's methods throw an BrokerStoppedException.

Version:
$Revision$

Constructor Summary
ErrorBroker(String message)
           
 
Method Summary
 void acknowledge(ConnectionContext context, MessageAck ack)
          Used to acknowledge the receipt of a message by a client.
 void addBroker(Connection connection, BrokerInfo info)
          A remote Broker connects
 void addConnection(ConnectionContext context, ConnectionInfo info)
          A client is establishing a connection with the broker.
 Subscription addConsumer(ConnectionContext context, ConsumerInfo info)
          Adds a consumer.
 Destination addDestination(ConnectionContext context, ActiveMQDestination destination)
          Used to create a destination.
 void addDestinationInfo(ConnectionContext context, DestinationInfo info)
          Add and process a DestinationInfo object
 void addProducer(ConnectionContext context, ProducerInfo info)
          Adds a producer.
 void addSession(ConnectionContext context, SessionInfo info)
          Adds a session.
 void beginTransaction(ConnectionContext context, TransactionId xid)
          Starts a transaction.
 void commitTransaction(ConnectionContext context, TransactionId xid, boolean onePhase)
          Commits a transaction.
 void forgetTransaction(ConnectionContext context, TransactionId transactionId)
          Forgets a transaction.
 void gc()
           
 Broker getAdaptor(Class type)
          Get a Broker from the Broker Stack that is a particular class
 ConnectionContext getAdminConnectionContext()
           
 BrokerId getBrokerId()
          Get the id of the broker
 String getBrokerName()
          Get the name of the broker
 Connection[] getClients()
           
 Map getDestinationMap()
          Returns a copy of the current destinations available in the region
 ActiveMQDestination[] getDestinations()
           
 Set getDestinations(ActiveMQDestination destination)
          Provide an exact or wildcard lookup of destinations in the region
 Set getDurableDestinations()
           
 BrokerInfo[] getPeerBrokerInfos()
          Get the BrokerInfo's of any connected Brokers
 PendingDurableSubscriberMessageStoragePolicy getPendingDurableSubscriberPolicy()
           
 TransactionId[] getPreparedTransactions(ConnectionContext context)
          Gets a list of all the prepared xa transactions.
 Store getTempDataStore()
           
 boolean isFaultTolerantConfiguration()
           
 boolean isSlaveBroker()
           
 boolean isStopped()
           
 Response messagePull(ConnectionContext context, MessagePull pull)
          Allows a consumer to pull a message from a queue
 int prepareTransaction(ConnectionContext context, TransactionId xid)
          Prepares a transaction.
 void processDispatch(MessageDispatch messageDispatch)
          Notify the Broker that a dispatch has happened
 void processDispatchNotification(MessageDispatchNotification messageDispatchNotification)
          Process a notification of a dispatch - used by a Slave Broker
 void removeBroker(Connection connection, BrokerInfo info)
          Remove a BrokerInfo
 void removeConnection(ConnectionContext context, ConnectionInfo info, Throwable error)
          A client is disconnecting from the broker.
 void removeConsumer(ConnectionContext context, ConsumerInfo info)
          Removes a consumer.
 void removeDestination(ConnectionContext context, ActiveMQDestination destination, long timeout)
          Used to destroy a destination.
 void removeDestinationInfo(ConnectionContext context, DestinationInfo info)
          Remove and process a DestinationInfo object
 void removeProducer(ConnectionContext context, ProducerInfo info)
          Removes a producer.
 void removeSession(ConnectionContext context, SessionInfo info)
          Removes a session.
 void removeSubscription(ConnectionContext context, RemoveSubscriptionInfo info)
          Deletes a durable subscription.
 void rollbackTransaction(ConnectionContext context, TransactionId xid)
          Rollsback a transaction.
 void send(ConnectionContext context, Message message)
          Send a message to the broker to using the specified destination.
 void setAdminConnectionContext(ConnectionContext adminConnectionContext)
          Sets the default administration connection context used when configuring the broker on startup or via JMX
 void setPendingDurableSubscriberPolicy(PendingDurableSubscriberMessageStoragePolicy pendingDurableSubscriberPolicy)
           
 void start()
           
 void stop()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ErrorBroker

public ErrorBroker(String message)
Method Detail

getDestinationMap

public Map getDestinationMap()
Description copied from interface: Region
Returns a copy of the current destinations available in the region

Specified by:
getDestinationMap in interface Region
Returns:
a copy of the regions currently active at the time of the call with the key the destination and the value the Destination.

getDestinations

public Set getDestinations(ActiveMQDestination destination)
Description copied from interface: Region
Provide an exact or wildcard lookup of destinations in the region

Specified by:
getDestinations in interface Region
Returns:
a set of matching destination objects.

getAdaptor

public Broker getAdaptor(Class type)
Description copied from interface: Broker
Get a Broker from the Broker Stack that is a particular class

Specified by:
getAdaptor in interface Broker
Returns:

getBrokerId

public BrokerId getBrokerId()
Description copied from interface: Broker
Get the id of the broker

Specified by:
getBrokerId in interface Broker

getBrokerName

public String getBrokerName()
Description copied from interface: Broker
Get the name of the broker

Specified by:
getBrokerName in interface Broker

addConnection

public void addConnection(ConnectionContext context,
                          ConnectionInfo info)
                   throws Exception
Description copied from interface: Broker
A client is establishing a connection with the broker.

Specified by:
addConnection in interface Broker
Throws:
Exception - TODO

removeConnection

public void removeConnection(ConnectionContext context,
                             ConnectionInfo info,
                             Throwable error)
                      throws Exception
Description copied from interface: Broker
A client is disconnecting from the broker.

Specified by:
removeConnection in interface Broker
Parameters:
context - the environment the operation is being executed under.
error - null if the client requested the disconnect or the error that caused the client to disconnect.
Throws:
Exception - TODO

addSession

public void addSession(ConnectionContext context,
                       SessionInfo info)
                throws Exception
Description copied from interface: Broker
Adds a session.

Specified by:
addSession in interface Broker
Throws:
Exception - TODO

removeSession

public void removeSession(ConnectionContext context,
                          SessionInfo info)
                   throws Exception
Description copied from interface: Broker
Removes a session.

Specified by:
removeSession in interface Broker
Throws:
Exception - TODO

addProducer

public void addProducer(ConnectionContext context,
                        ProducerInfo info)
                 throws Exception
Description copied from interface: Broker
Adds a producer.

Specified by:
addProducer in interface Broker
Parameters:
context - the enviorment the operation is being executed under.
Throws:
Exception - TODO

removeProducer

public void removeProducer(ConnectionContext context,
                           ProducerInfo info)
                    throws Exception
Description copied from interface: Broker
Removes a producer.

Specified by:
removeProducer in interface Broker
Parameters:
context - the enviorment the operation is being executed under.
Throws:
Exception - TODO

getClients

public Connection[] getClients()
                        throws Exception
Specified by:
getClients in interface Broker
Returns:
all clients added to the Broker.
Throws:
Exception - TODO

getDestinations

public ActiveMQDestination[] getDestinations()
                                      throws Exception
Specified by:
getDestinations in interface Broker
Returns:
all destinations added to the Broker.
Throws:
Exception - TODO

getPreparedTransactions

public TransactionId[] getPreparedTransactions(ConnectionContext context)
                                        throws Exception
Description copied from interface: Broker
Gets a list of all the prepared xa transactions.

Specified by:
getPreparedTransactions in interface Broker
Throws:
Exception - TODO

beginTransaction

public void beginTransaction(ConnectionContext context,
                             TransactionId xid)
                      throws Exception
Description copied from interface: Broker
Starts a transaction.

Specified by:
beginTransaction in interface Broker
Throws:
Exception - TODO

prepareTransaction

public int prepareTransaction(ConnectionContext context,
                              TransactionId xid)
                       throws Exception
Description copied from interface: Broker
Prepares a transaction. Only valid for xa transactions.

Specified by:
prepareTransaction in interface Broker
Returns:
Throws:
Exception - TODO

rollbackTransaction

public void rollbackTransaction(ConnectionContext context,
                                TransactionId xid)
                         throws Exception
Description copied from interface: Broker
Rollsback a transaction.

Specified by:
rollbackTransaction in interface Broker
Throws:
Exception - TODO

commitTransaction

public void commitTransaction(ConnectionContext context,
                              TransactionId xid,
                              boolean onePhase)
                       throws Exception
Description copied from interface: Broker
Commits a transaction.

Specified by:
commitTransaction in interface Broker
Throws:
Exception - TODO

forgetTransaction

public void forgetTransaction(ConnectionContext context,
                              TransactionId transactionId)
                       throws Exception
Description copied from interface: Broker
Forgets a transaction.

Specified by:
forgetTransaction in interface Broker
Throws:
Exception - TODO

addDestination

public Destination addDestination(ConnectionContext context,
                                  ActiveMQDestination destination)
                           throws Exception
Description copied from interface: Region
Used to create a destination. Usually, this method is invoked as a side-effect of sending a message to a destination that does not exist yet.

Specified by:
addDestination in interface Region
destination - the destination to create.
Returns:
TODO
Throws:
Exception - TODO

removeDestination

public void removeDestination(ConnectionContext context,
                              ActiveMQDestination destination,
                              long timeout)
                       throws Exception
Description copied from interface: Region
Used to destroy a destination. This should try to quiesce use of the destination up to the timeout allotted time before removing the destination. This will remove all persistent messages associated with the destination.

Specified by:
removeDestination in interface Region
Parameters:
context - the environment the operation is being executed under.
destination - what is being removed from the broker.
timeout - the max amount of time to wait for the destination to quiesce
Throws:
Exception - TODO

addConsumer

public Subscription addConsumer(ConnectionContext context,
                                ConsumerInfo info)
                         throws Exception
Description copied from interface: Region
Adds a consumer.

Specified by:
addConsumer in interface Region
Parameters:
context - the environment the operation is being executed under.
Returns:
TODO
Throws:
Exception - TODO

removeConsumer

public void removeConsumer(ConnectionContext context,
                           ConsumerInfo info)
                    throws Exception
Description copied from interface: Region
Removes a consumer.

Specified by:
removeConsumer in interface Region
Parameters:
context - the environment the operation is being executed under.
Throws:
Exception - TODO

removeSubscription

public void removeSubscription(ConnectionContext context,
                               RemoveSubscriptionInfo info)
                        throws Exception
Description copied from interface: Region
Deletes a durable subscription.

Specified by:
removeSubscription in interface Region
Parameters:
context - the environment the operation is being executed under.
info - TODO
Throws:
Exception - TODO

send

public void send(ConnectionContext context,
                 Message message)
          throws Exception
Description copied from interface: Region
Send a message to the broker to using the specified destination. The destination specified in the message does not need to match the destination the message is sent to. This is handy in case the message is being sent to a dead letter destination.

Specified by:
send in interface Region
Parameters:
context - the environment the operation is being executed under.
Throws:
Exception - TODO

acknowledge

public void acknowledge(ConnectionContext context,
                        MessageAck ack)
                 throws Exception
Description copied from interface: Region
Used to acknowledge the receipt of a message by a client.

Specified by:
acknowledge in interface Region
Parameters:
context - the environment the operation is being executed under.
Throws:
Exception - TODO

gc

public void gc()
Specified by:
gc in interface Region

start

public void start()
           throws Exception
Specified by:
start in interface Service
Throws:
Exception

stop

public void stop()
          throws Exception
Specified by:
stop in interface Service
Throws:
Exception

addBroker

public void addBroker(Connection connection,
                      BrokerInfo info)
Description copied from interface: Broker
A remote Broker connects

Specified by:
addBroker in interface Broker

removeBroker

public void removeBroker(Connection connection,
                         BrokerInfo info)
Description copied from interface: Broker
Remove a BrokerInfo

Specified by:
removeBroker in interface Broker

getPeerBrokerInfos

public BrokerInfo[] getPeerBrokerInfos()
Description copied from interface: Broker
Get the BrokerInfo's of any connected Brokers

Specified by:
getPeerBrokerInfos in interface Broker
Returns:
array of peer BrokerInfos

processDispatch

public void processDispatch(MessageDispatch messageDispatch)
Description copied from interface: Broker
Notify the Broker that a dispatch has happened

Specified by:
processDispatch in interface Broker

processDispatchNotification

public void processDispatchNotification(MessageDispatchNotification messageDispatchNotification)
                                 throws Exception
Description copied from interface: Region
Process a notification of a dispatch - used by a Slave Broker

Specified by:
processDispatchNotification in interface Region
Throws:
Exception - TODO

isSlaveBroker

public boolean isSlaveBroker()
Specified by:
isSlaveBroker in interface Broker
Returns:
true if the broker is running as a slave

isStopped

public boolean isStopped()
Specified by:
isStopped in interface Broker
Returns:
true if the broker has stopped

getDurableDestinations

public Set getDurableDestinations()
Specified by:
getDurableDestinations in interface Broker
Returns:
a Set of all durable destinations

addDestinationInfo

public void addDestinationInfo(ConnectionContext context,
                               DestinationInfo info)
                        throws Exception
Description copied from interface: Broker
Add and process a DestinationInfo object

Specified by:
addDestinationInfo in interface Broker
Throws:
Exception

removeDestinationInfo

public void removeDestinationInfo(ConnectionContext context,
                                  DestinationInfo info)
                           throws Exception
Description copied from interface: Broker
Remove and process a DestinationInfo object

Specified by:
removeDestinationInfo in interface Broker
Throws:
Exception

isFaultTolerantConfiguration

public boolean isFaultTolerantConfiguration()
Specified by:
isFaultTolerantConfiguration in interface Broker
Returns:
true if fault tolerant

getAdminConnectionContext

public ConnectionContext getAdminConnectionContext()
Specified by:
getAdminConnectionContext in interface Broker
Returns:
the connection context used to make administration operations on startup or via JMX MBeans

setAdminConnectionContext

public void setAdminConnectionContext(ConnectionContext adminConnectionContext)
Description copied from interface: Broker
Sets the default administration connection context used when configuring the broker on startup or via JMX

Specified by:
setAdminConnectionContext in interface Broker

messagePull

public Response messagePull(ConnectionContext context,
                            MessagePull pull)
Description copied from interface: Region
Allows a consumer to pull a message from a queue

Specified by:
messagePull in interface Region

getPendingDurableSubscriberPolicy

public PendingDurableSubscriberMessageStoragePolicy getPendingDurableSubscriberPolicy()
Specified by:
getPendingDurableSubscriberPolicy in interface Broker
Returns:
the pendingDurableSubscriberPolicy

setPendingDurableSubscriberPolicy

public void setPendingDurableSubscriberPolicy(PendingDurableSubscriberMessageStoragePolicy pendingDurableSubscriberPolicy)
Specified by:
setPendingDurableSubscriberPolicy in interface Broker
Parameters:
pendingDurableSubscriberPolicy - the pendingDurableSubscriberPolicy to set

getTempDataStore

public Store getTempDataStore()
Specified by:
getTempDataStore in interface Broker
Returns:
the broker's temp data store


Copyright © 2011 Apache Software Foundation. All Rights Reserved.