Interface ActiveMQServerMessagePlugin

All Superinterfaces:
ActiveMQServerBasePlugin
All Known Subinterfaces:
ActiveMQServerPlugin
public interface ActiveMQServerMessagePlugin extends ActiveMQServerBasePlugin

  • Method Summary

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

    Methods inherited from interface ActiveMQServerBasePlugin

    init, registered, setInit, unregistered

  • Method Details

    • beforeSend

      default void beforeSend(org.apache.activemq.artemis.core.server.ServerSession session, org.apache.activemq.artemis.core.transaction.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(org.apache.activemq.artemis.core.server.ServerSession session, org.apache.activemq.artemis.core.transaction.Transaction tx, Message message, boolean direct, boolean noAutoCreateQueue, org.apache.activemq.artemis.core.postoffice.RoutingStatus result) throws ActiveMQException
      After a message is sent
      Parameters:
      session - the session that sends the message
      Throws:
      ActiveMQException

    • onSendException

      default void onSendException(org.apache.activemq.artemis.core.server.ServerSession session, org.apache.activemq.artemis.core.transaction.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(org.apache.activemq.artemis.core.transaction.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(org.apache.activemq.artemis.core.transaction.Transaction tx, Message message, boolean direct, boolean noAutoCreateQueue, org.apache.activemq.artemis.core.postoffice.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, org.apache.activemq.artemis.core.server.RoutingContext context, boolean direct, boolean rejectDuplicates) throws ActiveMQException
      Before a message is routed
      Throws:
      ActiveMQException

    • afterMessageRoute

      default void afterMessageRoute(Message message, org.apache.activemq.artemis.core.server.RoutingContext context, boolean direct, boolean rejectDuplicates, org.apache.activemq.artemis.core.postoffice.RoutingStatus result) throws ActiveMQException
      After a message is routed
      Throws:
      ActiveMQException

    • onMessageRouteException

      default void onMessageRouteException(Message message, org.apache.activemq.artemis.core.server.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(org.apache.activemq.artemis.core.server.ServerConsumer consumer, org.apache.activemq.artemis.core.server.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(org.apache.activemq.artemis.core.server.ServerConsumer consumer, org.apache.activemq.artemis.core.server.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(org.apache.activemq.artemis.core.server.ServerConsumer consumer, org.apache.activemq.artemis.core.server.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(org.apache.activemq.artemis.core.server.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(org.apache.activemq.artemis.core.server.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(org.apache.activemq.artemis.core.server.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(org.apache.activemq.artemis.core.server.MessageReference message, SimpleString messageExpiryAddress, org.apache.activemq.artemis.core.server.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(org.apache.activemq.artemis.core.server.MessageReference ref, org.apache.activemq.artemis.core.server.impl.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(org.apache.activemq.artemis.core.server.MessageReference ref, org.apache.activemq.artemis.core.server.impl.AckReason reason, org.apache.activemq.artemis.core.server.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(org.apache.activemq.artemis.core.transaction.Transaction tx, org.apache.activemq.artemis.core.server.MessageReference ref, org.apache.activemq.artemis.core.server.impl.AckReason reason, org.apache.activemq.artemis.core.server.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(org.apache.activemq.artemis.core.transaction.Transaction tx, org.apache.activemq.artemis.core.server.MessageReference ref, org.apache.activemq.artemis.core.server.impl.AckReason reason, SimpleString destAddress, Long destQueueID, org.apache.activemq.artemis.core.server.ServerConsumer consumer, Message newMessage, org.apache.activemq.artemis.core.postoffice.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