Apache
/
activemq
mirror of https://github.com/apache/activemq.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1219 from kenliao94/misc_fix 

[Misc] Various misc. fixes for Broker interface
This commit is contained in:
JB Onofré 2024-05-03 08:30:37 +02:00 committed by GitHub
parent b39e64f258 9096ae6e75
commit 986cd7c52b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 80 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

136
activemq-broker/src/main/java/org/apache/activemq/broker/Broker.java
View File

@ -49,7 +49,7 @@ public interface Broker extends Region, Service {
/** /**
* Get a Broker from the Broker Stack that is a particular class * Get a Broker from the Broker Stack that is a particular class
* *
* @param type * @param type a Broker type.
* @return a Broker instance. * @return a Broker instance.
*/ */
Broker getAdaptor(Class<?> type); Broker getAdaptor(Class<?> type);
@ -72,8 +72,8 @@ public interface Broker extends Region, Service {
/** /**
* Remove a BrokerInfo * Remove a BrokerInfo
* *
* @param connection * @param connection Broker connection
* @param info * @param info metadata about the Broker
*/ */
void removeBroker(Connection connection, BrokerInfo info); void removeBroker(Connection connection, BrokerInfo info);
@ -88,7 +88,7 @@ public interface Broker extends Region, Service {
* A client is disconnecting from the broker. * A client is disconnecting from the broker.
* *
* @param context the environment the operation is being executed under. * @param context the environment the operation is being executed under.
* @param info * @param info metadata about the Broker
* @param error null if the client requested the disconnect or the error * @param error null if the client requested the disconnect or the error
* that caused the client to disconnect. * that caused the client to disconnect.
* @throws Exception TODO * @throws Exception TODO
@ -98,8 +98,8 @@ public interface Broker extends Region, Service {
/** /**
* Adds a session. * Adds a session.
* *
* @param context * @param context connection context
* @param info * @param info metadata about the Broker
* @throws Exception TODO * @throws Exception TODO
*/ */
void addSession(ConnectionContext context, SessionInfo info) throws Exception; void addSession(ConnectionContext context, SessionInfo info) throws Exception;
@ -107,8 +107,8 @@ public interface Broker extends Region, Service {
/** /**
* Removes a session. * Removes a session.
* *
* @param context * @param context connection context
* @param info * @param info metadata about the Broker
* @throws Exception TODO * @throws Exception TODO
*/ */
void removeSession(ConnectionContext context, SessionInfo info) throws Exception; void removeSession(ConnectionContext context, SessionInfo info) throws Exception;
@ -146,11 +146,11 @@ public interface Broker extends Region, Service {
/** /**
* return a reference destination map of a region based on the destination type * return a reference destination map of a region based on the destination type
* *
* @param destination * @param destination ActiveMQ Destination
* *
* @return destination Map * @return destination Map
*/ */
public Map<ActiveMQDestination, Destination> getDestinationMap(ActiveMQDestination destination); Map<ActiveMQDestination, Destination> getDestinationMap(ActiveMQDestination destination);
/** /**
* Gets a list of all the prepared xa transactions. * Gets a list of all the prepared xa transactions.
@ -164,8 +164,8 @@ public interface Broker extends Region, Service {
/** /**
* Starts a transaction. * Starts a transaction.
* *
* @param context * @param context connection context
* @param xid * @param xid transaction id
* @throws Exception TODO * @throws Exception TODO
*/ */
void beginTransaction(ConnectionContext context, TransactionId xid) throws Exception; void beginTransaction(ConnectionContext context, TransactionId xid) throws Exception;
@ -173,18 +173,18 @@ public interface Broker extends Region, Service {
/** /**
* Prepares a transaction. Only valid for xa transactions. * Prepares a transaction. Only valid for xa transactions.
* *
* @param context * @param context connection context
* @param xid * @param xid transaction id
* @return id * @return id
* @throws Exception TODO * @throws Exception TODO
*/ */
int prepareTransaction(ConnectionContext context, TransactionId xid) throws Exception; int prepareTransaction(ConnectionContext context, TransactionId xid) throws Exception;
/** /**
* Rollsback a transaction. * Rollback a transaction.
* *
* @param context * @param context connection context
* @param xid * @param xid transaction id
* @throws Exception TODO * @throws Exception TODO
*/ */
void rollbackTransaction(ConnectionContext context, TransactionId xid) throws Exception; void rollbackTransaction(ConnectionContext context, TransactionId xid) throws Exception;
@ -192,9 +192,9 @@ public interface Broker extends Region, Service {
/** /**
* Commits a transaction. * Commits a transaction.
* *
* @param context * @param context connection context
* @param xid * @param xid transaction id
* @param onePhase * @param onePhase is COMMIT_ONE_PHASE
* @throws Exception TODO * @throws Exception TODO
*/ */
void commitTransaction(ConnectionContext context, TransactionId xid, boolean onePhase) throws Exception; void commitTransaction(ConnectionContext context, TransactionId xid, boolean onePhase) throws Exception;
@ -202,9 +202,9 @@ public interface Broker extends Region, Service {
/** /**
* Forgets a transaction. * Forgets a transaction.
* *
* @param context * @param context connection context
* @param transactionId * @param transactionId transaction id
* @throws Exception * @throws Exception TODO
*/ */
void forgetTransaction(ConnectionContext context, TransactionId transactionId) throws Exception; void forgetTransaction(ConnectionContext context, TransactionId transactionId) throws Exception;
@ -218,14 +218,14 @@ public interface Broker extends Region, Service {
/** /**
* Notify the Broker that a dispatch is going to happen * Notify the Broker that a dispatch is going to happen
* *
* @param messageDispatch * @param messageDispatch MessageDispatch object being dispatched
*/ */
void preProcessDispatch(MessageDispatch messageDispatch); void preProcessDispatch(MessageDispatch messageDispatch);
/** /**
* Notify the Broker that a dispatch has happened * Notify the Broker that a dispatch has happened
* *
* @param messageDispatch * @param messageDispatch MessageDispatch that has dispatched
*/ */
void postProcessDispatch(MessageDispatch messageDispatch); void postProcessDispatch(MessageDispatch messageDispatch);
@ -242,24 +242,24 @@ public interface Broker extends Region, Service {
/** /**
* Add and process a DestinationInfo object * Add and process a DestinationInfo object
* *
* @param context * @param context connection context
* @param info * @param info destination info
* @throws Exception * @throws Exception TODO
*/ */
void addDestinationInfo(ConnectionContext context, DestinationInfo info) throws Exception; void addDestinationInfo(ConnectionContext context, DestinationInfo info) throws Exception;
/** /**
* Remove and process a DestinationInfo object * Remove and process a DestinationInfo object
* *
* @param context * @param context connection context
* @param info * @param info destination info
* *
* @throws Exception * @throws Exception TODO
*/ */
void removeDestinationInfo(ConnectionContext context, DestinationInfo info) throws Exception; void removeDestinationInfo(ConnectionContext context, DestinationInfo info) throws Exception;
/** /**
* @return true if fault tolerant * @return true if fault-tolerant
*/ */
boolean isFaultTolerantConfiguration(); boolean isFaultTolerantConfiguration();
@ -273,7 +273,7 @@ public interface Broker extends Region, Service {
* Sets the default administration connection context used when configuring * Sets the default administration connection context used when configuring
* the broker on startup or via JMX * the broker on startup or via JMX
* *
* @param adminConnectionContext * @param adminConnectionContext default administration connection context
*/ */
void setAdminConnectionContext(ConnectionContext adminConnectionContext); void setAdminConnectionContext(ConnectionContext adminConnectionContext);
@ -306,10 +306,10 @@ public interface Broker extends Region, Service {
/** /**
* Determine if a message has expired -allows default behaviour to be * Determine if a message has expired -allows default behaviour to be
* overriden - as the timestamp set by the producer can be out of sync with * overridden - as the timestamp set by the producer can be out of sync with
* the broker * the broker
* *
* @param messageReference * @param messageReference message reference
* @return true if the message is expired * @return true if the message is expired
*/ */
boolean isExpired(MessageReference messageReference); boolean isExpired(MessageReference messageReference);
@ -317,18 +317,18 @@ public interface Broker extends Region, Service {
/** /**
* A Message has Expired * A Message has Expired
* *
* @param context * @param context connection context
* @param messageReference * @param messageReference message reference
* @param subscription (maybe null) * @param subscription (maybe null)
*/ */
void messageExpired(ConnectionContext context, MessageReference messageReference, Subscription subscription); void messageExpired(ConnectionContext context, MessageReference messageReference, Subscription subscription);
/** /**
* A message needs to go the a DLQ * A message needs to go to the DLQ
* *
* *
* @param context * @param context connection context
* @param messageReference * @param messageReference message reference
* @param poisonCause reason for dlq submission, may be null * @param poisonCause reason for dlq submission, may be null
* @return true if Message was placed in a DLQ false if discarded. * @return true if Message was placed in a DLQ false if discarded.
*/ */
@ -341,56 +341,56 @@ public interface Broker extends Region, Service {
/** /**
* called when message is consumed * called when message is consumed
* @param context * @param context connection context
* @param messageReference * @param messageReference message reference
*/ */
void messageConsumed(ConnectionContext context, MessageReference messageReference); void messageConsumed(ConnectionContext context, MessageReference messageReference);
/** /**
* Called when message is delivered to the broker * Called when message is delivered to the broker
* @param context * @param context connection context
* @param messageReference * @param messageReference message reference
*/ */
void messageDelivered(ConnectionContext context, MessageReference messageReference); void messageDelivered(ConnectionContext context, MessageReference messageReference);
/** /**
* Called when message is dispatched to a consumer * Called when message is dispatched to a consumer
* @param context * @param context connection context
* @param sub * @param sub subscription
* @param messageReference * @param messageReference message reference
*/ */
void messageDispatched(ConnectionContext context, Subscription sub, MessageReference messageReference); void messageDispatched(ConnectionContext context, Subscription sub, MessageReference messageReference);
/** /**
* Called when a message is discarded - e.g. running low on memory * Called when a message is discarded - e.g. running low on memory
* This will happen only if the policy is enabled - e.g. non durable topics * This will happen only if the policy is enabled - e.g. non-durable topics
* @param context * @param context connection context
* @param sub * @param sub subscription
* @param messageReference * @param messageReference message reference
*/ */
void messageDiscarded(ConnectionContext context, Subscription sub, MessageReference messageReference); void messageDiscarded(ConnectionContext context, Subscription sub, MessageReference messageReference);
/** /**
* Called when there is a slow consumer * Called when there is a slow consumer
* @param context * @param context connection context
* @param destination * @param destination destination
* @param subs * @param subs subscription
*/ */
void slowConsumer(ConnectionContext context, Destination destination, Subscription subs); void slowConsumer(ConnectionContext context, Destination destination, Subscription subs);
/** /**
* Called to notify a producer is too fast * Called to notify a producer is too fast
* @param context * @param context connection context
* @param producerInfo * @param producerInfo producer info
* @param destination * @param destination destination
*/ */
void fastProducer(ConnectionContext context,ProducerInfo producerInfo,ActiveMQDestination destination); void fastProducer(ConnectionContext context,ProducerInfo producerInfo,ActiveMQDestination destination);
/** /**
* Called when a Usage reaches a limit * Called when a Usage reaches a limit
* @param context * @param context create new scratch file from selection
* @param destination * @param destination destination
* @param usage * @param usage usage
*/ */
void isFull(ConnectionContext context,Destination destination,Usage<?> usage); void isFull(ConnectionContext context,Destination destination,Usage<?> usage);
@ -404,12 +404,28 @@ public interface Broker extends Region, Service {
*/ */
void nowMasterBroker(); void nowMasterBroker();
/**
* called to get scheduler for executing TimerTask
*/
Scheduler getScheduler(); Scheduler getScheduler();
/**
* called to get Java thread pool executor
*/
ThreadPoolExecutor getExecutor(); ThreadPoolExecutor getExecutor();
/**
* called to when a network bridge is started
* @param brokerInfo metadata about the broker
* @param createdByDuplex is created by duplex
* @param remoteIp ip address of the broker
*/
void networkBridgeStarted(BrokerInfo brokerInfo, boolean createdByDuplex, String remoteIp); void networkBridgeStarted(BrokerInfo brokerInfo, boolean createdByDuplex, String remoteIp);
/**
* called to when a network bridge is stopped
* @param brokerInfo metadata about the broker
*/
void networkBridgeStopped(BrokerInfo brokerInfo); void networkBridgeStopped(BrokerInfo brokerInfo);