Package org.apache.activemq.artemis.core.server.plugin

Interface ActiveMQServerMessagePlugin

All Superinterfaces:

ActiveMQServerBasePlugin

All Known Subinterfaces:

ActiveMQServerPlugin

All Known Implementing Classes:

BrokerMessageAuthorizationPlugin, LoggingActiveMQServerPlugin, NotificationActiveMQServerPlugin

public interface ActiveMQServerMessagePlugin
extends ActiveMQServerBasePlugin

Method Summary

Modifier and Type	Method	Description
default void	afterDeliver(MessageReference reference)	Deprecated. use afterDeliver(ServerConsumer, MessageReference)
default void	afterDeliver(ServerConsumer consumer, MessageReference reference)	After a message is delivered to a client consumer
default void	afterMessageRoute(Message message, RoutingContext context, boolean direct, boolean rejectDuplicates, RoutingStatus result)	After a message is routed
default void	afterSend(ServerSession session, Transaction tx, Message message, boolean direct, boolean noAutoCreateQueue, RoutingStatus result)	After a message is sent
default void	afterSend(Transaction tx, Message message, boolean direct, boolean noAutoCreateQueue, RoutingStatus result)	Deprecated. use afterSend(ServerSession, Transaction, Message, boolean, boolean, RoutingStatus)
default void	beforeDeliver(MessageReference reference)	Deprecated. use throws ActiveMQException beforeDeliver(ServerConsumer, MessageReference)
default void	beforeDeliver(ServerConsumer consumer, MessageReference reference)	Before a message is delivered to a client consumer
default void	beforeMessageRoute(Message message, RoutingContext context, boolean direct, boolean rejectDuplicates)	Before a message is routed
default void	beforeSend(ServerSession session, Transaction tx, Message message, boolean direct, boolean noAutoCreateQueue)	Before a message is sent
default void	beforeSend(Transaction tx, Message message, boolean direct, boolean noAutoCreateQueue)	Deprecated. use beforeSend(ServerSession, Transaction, Message, boolean, boolean)
default boolean	canAccept(ServerConsumer consumer, MessageReference reference)	Before a message is delivered to a client consumer
default void	messageAcknowledged(MessageReference ref, AckReason reason)	Deprecated. use messageAcknowledged(MessageReference, AckReason, ServerConsumer)
default void	messageAcknowledged(MessageReference ref, AckReason reason, ServerConsumer consumer)	Deprecated.
default void	messageAcknowledged(Transaction tx, MessageReference ref, AckReason reason, ServerConsumer consumer)	A message has been acknowledged
default void	messageExpired(MessageReference message, SimpleString messageExpiryAddress)	Deprecated. use messageExpired(MessageReference, SimpleString, ServerConsumer)
default void	messageExpired(MessageReference message, SimpleString messageExpiryAddress, ServerConsumer consumer)	A message has been expired
default void	messageMoved(Transaction tx, MessageReference ref, AckReason reason, SimpleString destAddress, Long destQueueID, ServerConsumer consumer, Message newMessage, RoutingStatus result)	A message has been moved
default void	onMessageRouteException(Message message, RoutingContext context, boolean direct, boolean rejectDuplicates, Exception e)	When there was an error routing the message
default void	onSendException(ServerSession session, Transaction tx, Message message, boolean direct, boolean noAutoCreateQueue, Exception e)	When there was an exception sending the message

Methods inherited from interface org.apache.activemq.artemis.core.server.plugin.ActiveMQServerBasePlugin

init, registered, setInit, unregistered

Method Details

beforeSend

default void beforeSend(ServerSession session,
 Transaction tx,
 Message message,
 boolean direct,
 boolean noAutoCreateQueue)
                 throws ActiveMQException

Before a message is sent

Parameters:

session - the session that sends the message

Throws:

ActiveMQException

afterSend

default void afterSend(ServerSession session,
 Transaction tx,
 Message message,
 boolean direct,
 boolean noAutoCreateQueue,
 RoutingStatus result)
                throws ActiveMQException

After a message is sent

Parameters:

session - the session that sends the message

Throws:

ActiveMQException

onSendException

default void onSendException(ServerSession session,
 Transaction tx,
 Message message,
 boolean direct,
 boolean noAutoCreateQueue,
 Exception e)
                      throws ActiveMQException

When there was an exception sending the message

Parameters:

e - the exception that occurred when sending the message

Throws:

ActiveMQException

beforeSend

@Deprecated
default void beforeSend(Transaction tx,
 Message message,
 boolean direct,
 boolean noAutoCreateQueue)
                 throws ActiveMQException

Deprecated.

use beforeSend(ServerSession, Transaction, Message, boolean, boolean)

Before a message is sent

Throws:

ActiveMQException

afterSend

@Deprecated
default void afterSend(Transaction tx,
 Message message,
 boolean direct,
 boolean noAutoCreateQueue,
 RoutingStatus result)
                throws ActiveMQException

Deprecated.

use afterSend(ServerSession, Transaction, Message, boolean, boolean, RoutingStatus)

After a message is sent

Throws:

ActiveMQException

beforeMessageRoute

default void beforeMessageRoute(Message message,
 RoutingContext context,
 boolean direct,
 boolean rejectDuplicates)
                         throws ActiveMQException

Before a message is routed

Throws:

ActiveMQException

afterMessageRoute

default void afterMessageRoute(Message message,
 RoutingContext context,
 boolean direct,
 boolean rejectDuplicates,
 RoutingStatus result)
                        throws ActiveMQException

After a message is routed

Throws:

ActiveMQException

onMessageRouteException

default void onMessageRouteException(Message message,
 RoutingContext context,
 boolean direct,
 boolean rejectDuplicates,
 Exception e)
                              throws ActiveMQException

When there was an error routing the message

Parameters:

e - the exception that occurred during message routing

Throws:

ActiveMQException

canAccept

default boolean canAccept(ServerConsumer consumer,
 MessageReference reference)
                   throws ActiveMQException

Before a message is delivered to a client consumer

Parameters:

consumer - the consumer the message will be delivered to

reference - message reference

Throws:

ActiveMQException

beforeDeliver

default void beforeDeliver(ServerConsumer consumer,
 MessageReference reference)
                    throws ActiveMQException

Before a message is delivered to a client consumer

Parameters:

consumer - the consumer the message will be delivered to

reference - message reference

Throws:

ActiveMQException

afterDeliver

default void afterDeliver(ServerConsumer consumer,
 MessageReference reference)
                   throws ActiveMQException

After a message is delivered to a client consumer

Parameters:

consumer - the consumer the message was delivered to

reference - message reference

Throws:

ActiveMQException

beforeDeliver

@Deprecated
default void beforeDeliver(MessageReference reference)
                    throws ActiveMQException

Deprecated.

use throws ActiveMQException beforeDeliver(ServerConsumer, MessageReference)

Before a message is delivered to a client consumer

Throws:

ActiveMQException

afterDeliver

@Deprecated
default void afterDeliver(MessageReference reference)
                   throws ActiveMQException

Deprecated.

use afterDeliver(ServerConsumer, MessageReference)

After a message is delivered to a client consumer

Throws:

ActiveMQException

messageExpired

@Deprecated
default void messageExpired(MessageReference message,
 SimpleString messageExpiryAddress)
                     throws ActiveMQException

Deprecated.

use messageExpired(MessageReference, SimpleString, ServerConsumer)

A message has been expired

Parameters:

message - The expired message

messageExpiryAddress - The message expiry address if exists

Throws:

ActiveMQException

messageExpired

default void messageExpired(MessageReference message,
 SimpleString messageExpiryAddress,
 ServerConsumer consumer)
                     throws ActiveMQException

A message has been expired

Parameters:

message - The expired message

messageExpiryAddress - The message expiry address if exists

consumer - the Consumer that acknowledged the message - this field is optional and can be null

Throws:

ActiveMQException

messageAcknowledged

@Deprecated
default void messageAcknowledged(MessageReference ref,
 AckReason reason)
                          throws ActiveMQException

Deprecated.

use messageAcknowledged(MessageReference, AckReason, ServerConsumer)

A message has been acknowledged

Parameters:

ref - The acked message

reason - The ack reason

Throws:

ActiveMQException

messageAcknowledged

@Deprecated
default void messageAcknowledged(MessageReference ref,
 AckReason reason,
 ServerConsumer consumer)
                          throws ActiveMQException

Deprecated.

A message has been acknowledged

Parameters:

ref - The acked message

reason - The ack reason

consumer - the Consumer that acknowledged the message - this field is optional and can be null

Throws:

ActiveMQException

messageAcknowledged

default void messageAcknowledged(Transaction tx,
 MessageReference ref,
 AckReason reason,
 ServerConsumer consumer)
                          throws ActiveMQException

A message has been acknowledged

Parameters:

tx - The transaction associated with the ack

ref - The acked message

reason - The ack reason

consumer - the Consumer that acknowledged the message - this field is optional and can be null

Throws:

ActiveMQException

messageMoved

default void messageMoved(Transaction tx,
 MessageReference ref,
 AckReason reason,
 SimpleString destAddress,
 Long destQueueID,
 ServerConsumer consumer,
 Message newMessage,
 RoutingStatus result)
                   throws ActiveMQException

A message has been moved

Parameters:

tx - The transaction associated with the move

ref - The ref of the message moved

reason - The move reason

destAddress - the destination address for the move operation

destQueueID - the destination queueID for the move operation - this field is optional and can be null

consumer - the consumer that moved the message - this field is optional and can be null

newMessage - the new message created by the move operation

result - routing status of the move operation

Throws:

ActiveMQException