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

Interface ActiveMQServerPlugin

All Known Implementing Classes:

LoggingActiveMQServerPlugin, NotificationActiveMQServerPlugin

public interface ActiveMQServerPlugin

Method Summary

Modifier and Type	Method and Description
default void	afterAddAddress(AddressInfo addressInfo, boolean reload) After an address has been added tot he broker
default void	afterAddBinding(Binding binding) After a binding has been added
default void	afterCloseConsumer(ServerConsumer consumer, boolean failed) After a consumer is closed
default void	afterCloseSession(ServerSession session, boolean failed) After a session is closed
default void	afterCreateConnection(RemotingConnection connection) A connection has been created.
default void	afterCreateConsumer(ServerConsumer consumer) After a consumer has been created
default void	afterCreateQueue(Queue queue) After a queue has been created
default void	afterCreateSession(ServerSession session) After a session has been created.
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	afterDeployBridge(Bridge bridge) After a bridge has been deployed
default void	afterDestroyConnection(RemotingConnection connection) A connection has been destroyed.
default void	afterDestroyQueue(Queue queue, SimpleString address, SecurityAuth session, boolean checkConsumerCount, boolean removeConsumers, boolean autoDeleteAddress) After a queue has been destroyed
default void	afterMessageRoute(Message message, RoutingContext context, boolean direct, boolean rejectDuplicates, RoutingStatus result) After a message is routed
default void	afterRemoveAddress(SimpleString address, AddressInfo addressInfo) After an address has been removed
default void	afterRemoveBinding(Binding binding, Transaction tx, boolean deleteData) After a binding is removed
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	afterSessionMetadataAdded(ServerSession session, String key, String data) After session metadata is added to the session
default void	afterUpdateAddress(AddressInfo addressInfo) After an address has been updated
default void	beforeAddAddress(AddressInfo addressInfo, boolean reload) Before an address is added tot he broker
default void	beforeAddBinding(Binding binding) Before a binding is added
default void	beforeCloseConsumer(ServerConsumer consumer, boolean failed) Before a consumer is closed
default void	beforeCloseSession(ServerSession session, boolean failed) Before a session is closed
default void	beforeCreateConsumer(long consumerID, QueueBinding queueBinding, SimpleString filterString, boolean browseOnly, boolean supportLargeMessage) Before a consumer is created
default void	beforeCreateConsumer(long consumerID, SimpleString queueName, SimpleString filterString, boolean browseOnly, boolean supportLargeMessage) Deprecated. use {@link #beforeCreateConsumer(long, QueueBinding, SimpleString, boolean, boolean)
default void	beforeCreateQueue(QueueConfig queueConfig) Before a queue is created
default void	beforeCreateSession(String name, String username, int minLargeMessageSize, RemotingConnection connection, boolean autoCommitSends, boolean autoCommitAcks, boolean preAcknowledge, boolean xa, String defaultAddress, SessionCallback callback, boolean autoCreateQueues, OperationContext context, Map<SimpleString,RoutingType> prefixes) Before a session is created.
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	beforeDeployBridge(BridgeConfiguration config) Before a bridge is deployed
default void	beforeDestroyQueue(SimpleString queueName, SecurityAuth session, boolean checkConsumerCount, boolean removeConsumers, boolean autoDeleteAddress) Before a queue is destroyed
default void	beforeMessageRoute(Message message, RoutingContext context, boolean direct, boolean rejectDuplicates) Before a message is routed
default void	beforeRemoveAddress(SimpleString address) Before an address is removed
default void	beforeRemoveBinding(SimpleString uniqueName, Transaction tx, boolean deleteData) Before a binding is removed
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 void	beforeSessionMetadataAdded(ServerSession session, String key, String data) Before session metadata is added to the session
default void	beforeUpdateAddress(SimpleString address, EnumSet<RoutingType> routingTypes) Before an address is updated
default void	criticalFailure(CriticalComponent components) A Critical failure has been detected.
default void	init(Map<String,String> properties) used to pass configured properties to Plugin
default void	messageAcknowledged(MessageReference ref, AckReason reason) Deprecated. use messageAcknowledged(MessageReference, AckReason, ServerConsumer)
default void	messageAcknowledged(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	registered(ActiveMQServer server) The plugin has been registered with the server
default void	unregistered(ActiveMQServer server) The plugin has been unregistered with the server

Method Detail

registered

default void registered(ActiveMQServer server)

The plugin has been registered with the server

Parameters:

server - The ActiveMQServer the plugin has been registered to

unregistered

default void unregistered(ActiveMQServer server)

The plugin has been unregistered with the server

Parameters:

server - The ActiveMQServer the plugin has been unregistered to

afterCreateConnection

default void afterCreateConnection(RemotingConnection connection)
                            throws ActiveMQException

A connection has been created.

Parameters:

connection - The newly created connection

Throws:

ActiveMQException

afterDestroyConnection

default void afterDestroyConnection(RemotingConnection connection)
                             throws ActiveMQException

A connection has been destroyed.

Parameters:

connection -

Throws:

ActiveMQException

beforeCreateSession

default void beforeCreateSession(String name,
                                 String username,
                                 int minLargeMessageSize,
                                 RemotingConnection connection,
                                 boolean autoCommitSends,
                                 boolean autoCommitAcks,
                                 boolean preAcknowledge,
                                 boolean xa,
                                 String defaultAddress,
                                 SessionCallback callback,
                                 boolean autoCreateQueues,
                                 OperationContext context,
                                 Map<SimpleString,RoutingType> prefixes)
                          throws ActiveMQException

Before a session is created.

Parameters:

name -

username -

minLargeMessageSize -

connection -

autoCommitSends -

autoCommitAcks -

preAcknowledge -

xa -

defaultAddress -

callback -

autoCreateQueues -

context -

prefixes -

Throws:

ActiveMQException

afterCreateSession

default void afterCreateSession(ServerSession session)
                         throws ActiveMQException

After a session has been created.

Parameters:

session - The newly created session

Throws:

ActiveMQException

beforeCloseSession

default void beforeCloseSession(ServerSession session,
                                boolean failed)
                         throws ActiveMQException

Before a session is closed

Parameters:

session -

failed -

Throws:

ActiveMQException

afterCloseSession

default void afterCloseSession(ServerSession session,
                               boolean failed)
                        throws ActiveMQException

After a session is closed

Parameters:

session -

failed -

Throws:

ActiveMQException

beforeSessionMetadataAdded

default void beforeSessionMetadataAdded(ServerSession session,
                                        String key,
                                        String data)
                                 throws ActiveMQException

Before session metadata is added to the session

Parameters:

session -

key -

data -

Throws:

ActiveMQException

afterSessionMetadataAdded

default void afterSessionMetadataAdded(ServerSession session,
                                       String key,
                                       String data)
                                throws ActiveMQException

After session metadata is added to the session

Parameters:

session -

key -

data -

Throws:

ActiveMQException

beforeCreateConsumer

@Deprecated
default void beforeCreateConsumer(long consumerID,
                                              SimpleString queueName,
                                              SimpleString filterString,
                                              boolean browseOnly,
                                              boolean supportLargeMessage)
                                       throws ActiveMQException

Deprecated. use {@link #beforeCreateConsumer(long, QueueBinding, SimpleString, boolean, boolean)

Before a consumer is created

Parameters:

consumerID -

queueName -

filterString -

browseOnly -

supportLargeMessage -

Throws:

ActiveMQException

beforeCreateConsumer

default void beforeCreateConsumer(long consumerID,
                                  QueueBinding queueBinding,
                                  SimpleString filterString,
                                  boolean browseOnly,
                                  boolean supportLargeMessage)
                           throws ActiveMQException

Before a consumer is created

Parameters:

consumerID -

QueueBinding -

filterString -

browseOnly -

supportLargeMessage -

Throws:

ActiveMQException

afterCreateConsumer

default void afterCreateConsumer(ServerConsumer consumer)
                          throws ActiveMQException

After a consumer has been created

Parameters:

consumer - the created consumer

Throws:

ActiveMQException

beforeCloseConsumer

default void beforeCloseConsumer(ServerConsumer consumer,
                                 boolean failed)
                          throws ActiveMQException

Before a consumer is closed

Parameters:

consumer -

failed -

Throws:

ActiveMQException

afterCloseConsumer

default void afterCloseConsumer(ServerConsumer consumer,
                                boolean failed)
                         throws ActiveMQException

After a consumer is closed

Parameters:

consumer -

failed -

Throws:

ActiveMQException

beforeAddAddress

default void beforeAddAddress(AddressInfo addressInfo,
                              boolean reload)
                       throws ActiveMQException

Before an address is added tot he broker

Parameters:

addressInfo - The addressInfo that will be added

reload - If the address is being reloaded

Throws:

ActiveMQException

afterAddAddress

default void afterAddAddress(AddressInfo addressInfo,
                             boolean reload)
                      throws ActiveMQException

After an address has been added tot he broker

Parameters:

addressInfo - The newly added address

reload - If the address is being reloaded

Throws:

ActiveMQException

beforeUpdateAddress

default void beforeUpdateAddress(SimpleString address,
                                 EnumSet<RoutingType> routingTypes)
                          throws ActiveMQException

Before an address is updated

Parameters:

address - The existing address info that is about to be updated

routingTypes - The new routing types that the address will be updated with

Throws:

ActiveMQException

afterUpdateAddress

default void afterUpdateAddress(AddressInfo addressInfo)
                         throws ActiveMQException

After an address has been updated

Parameters:

addressInfo - The newly updated address info

Throws:

ActiveMQException

beforeRemoveAddress

default void beforeRemoveAddress(SimpleString address)
                          throws ActiveMQException

Before an address is removed

Parameters:

address - The address that will be removed

Throws:

ActiveMQException

afterRemoveAddress

default void afterRemoveAddress(SimpleString address,
                                AddressInfo addressInfo)
                         throws ActiveMQException

After an address has been removed

Parameters:

address - The address that has been removed

addressInfo - The address info that has been removed or null if not removed

Throws:

ActiveMQException

beforeCreateQueue

default void beforeCreateQueue(QueueConfig queueConfig)
                        throws ActiveMQException

Before a queue is created

Parameters:

queueConfig -

Throws:

ActiveMQException

afterCreateQueue

default void afterCreateQueue(Queue queue)
                       throws ActiveMQException

After a queue has been created

Parameters:

queue - The newly created queue

Throws:

ActiveMQException

beforeDestroyQueue

default void beforeDestroyQueue(SimpleString queueName,
                                SecurityAuth session,
                                boolean checkConsumerCount,
                                boolean removeConsumers,
                                boolean autoDeleteAddress)
                         throws ActiveMQException

Before a queue is destroyed

Parameters:

queueName -

session -

checkConsumerCount -

removeConsumers -

autoDeleteAddress -

Throws:

ActiveMQException

afterDestroyQueue

default void afterDestroyQueue(Queue queue,
                               SimpleString address,
                               SecurityAuth session,
                               boolean checkConsumerCount,
                               boolean removeConsumers,
                               boolean autoDeleteAddress)
                        throws ActiveMQException

After a queue has been destroyed

Parameters:

queue -

address -

session -

checkConsumerCount -

removeConsumers -

autoDeleteAddress -

Throws:

ActiveMQException

beforeAddBinding

default void beforeAddBinding(Binding binding)
                       throws ActiveMQException

Before a binding is added

Parameters:

binding -

Throws:

ActiveMQException

afterAddBinding

default void afterAddBinding(Binding binding)
                      throws ActiveMQException

After a binding has been added

Parameters:

binding - The newly added binding

Throws:

ActiveMQException

beforeRemoveBinding

default void beforeRemoveBinding(SimpleString uniqueName,
                                 Transaction tx,
                                 boolean deleteData)
                          throws ActiveMQException

Before a binding is removed

Parameters:

uniqueName -

tx -

deleteData -

Throws:

ActiveMQException

afterRemoveBinding

default void afterRemoveBinding(Binding binding,
                                Transaction tx,
                                boolean deleteData)
                         throws ActiveMQException

After a binding is removed

Parameters:

binding -

tx -

deleteData -

Throws:

ActiveMQException

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

tx -

message -

direct -

noAutoCreateQueue -

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

tx -

message -

direct -

noAutoCreateQueue -

result -

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

Parameters:

tx -

message -

direct -

noAutoCreateQueue -

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

Parameters:

tx -

message -

direct -

noAutoCreateQueue -

result -

Throws:

ActiveMQException

beforeMessageRoute

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

Before a message is routed

Parameters:

message -

context -

direct -

rejectDuplicates -

Throws:

ActiveMQException

afterMessageRoute

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

After a message is routed

Parameters:

message -

context -

direct -

rejectDuplicates -

result -

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

Parameters:

reference -

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

Parameters:

reference -

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

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

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

beforeDeployBridge

default void beforeDeployBridge(BridgeConfiguration config)
                         throws ActiveMQException

Before a bridge is deployed

Parameters:

config - The bridge configuration

Throws:

ActiveMQException

afterDeployBridge

default void afterDeployBridge(Bridge bridge)
                        throws ActiveMQException

After a bridge has been deployed

Parameters:

bridge - The newly deployed bridge

Throws:

ActiveMQException

criticalFailure

default void criticalFailure(CriticalComponent components)
                      throws ActiveMQException

A Critical failure has been detected. This will be called before the broker is stopped

Parameters:

components -

Throws:

ActiveMQException

init

default void init(Map<String,String> properties)

used to pass configured properties to Plugin

Parameters:

properties -