Package org.apache.activemq.artemis.protocol.amqp.connect.federation

Interface ActiveMQServerAMQPFederationPlugin

    • Method Detail

      • federationStarted

        default void federationStarted​(Federation federation)
                        throws ActiveMQException
        After a federation instance has been started
        Parameters:
        federation - The Federation instance that is being started.
        Throws:
        ActiveMQException - if an error occurs during the call.

      • federationStopped

        default void federationStopped​(Federation federation)
                        throws ActiveMQException
        After a federation instance has been stopped
        Parameters:
        federation - The Federation instance that is being stopped.
        Throws:
        ActiveMQException - if an error occurs during the call.

      • beforeCreateFederationConsumer

        default void beforeCreateFederationConsumer​(FederationConsumerInfo consumerInfo)
                                     throws ActiveMQException
        Before a consumer for a federated resource is created
        Parameters:
        consumerInfo - The information that will be used when creating the federation consumer.
        Throws:
        ActiveMQException - if an error occurs during the call.

      • afterCreateFederationConsumer

        default void afterCreateFederationConsumer​(FederationConsumer consumer)
                                    throws ActiveMQException
        After a consumer for a federated resource is created
        Parameters:
        consumer - The consumer that was created after a matching federated resource is detected.
        Throws:
        ActiveMQException - if an error occurs during the call.

      • beforeCloseFederationConsumer

        default void beforeCloseFederationConsumer​(FederationConsumer consumer)
                                    throws ActiveMQException
        Before a consumer for a federated resource is closed
        Parameters:
        consumer - The federation consumer that is going to be closed.
        Throws:
        ActiveMQException - if an error occurs during the call.

      • afterCloseFederationConsumer

        default void afterCloseFederationConsumer​(FederationConsumer consumer)
                                   throws ActiveMQException
        After a consumer for a federated resource is closed
        Parameters:
        consumer - The federation consumer that has been closed.
        Throws:
        ActiveMQException - if an error occurs during the call.

      • beforeFederationConsumerMessageHandled

        default void beforeFederationConsumerMessageHandled​(FederationConsumer consumer,
                                                    Message message)
                                             throws ActiveMQException
        Before a federation consumer handles a message
        Parameters:
        consumer - The Federation consumer that is handling a new incoming message.
        message - The Message that is being handled
        Throws:
        ActiveMQException - if an error occurs during the call.

      • afterFederationConsumerMessageHandled

        default void afterFederationConsumerMessageHandled​(FederationConsumer consumer,
                                                   Message message)
                                            throws ActiveMQException
        After a federation consumer handles a message
        Parameters:
        consumer - The Federation consumer that is handling a new incoming message.
        message - The Message that is being handled
        Throws:
        ActiveMQException - if an error occurs during the call.

      • shouldCreateFederationConsumerForAddress

        default boolean shouldCreateFederationConsumerForAddress​(org.apache.activemq.artemis.core.server.impl.AddressInfo address)
                                                  throws ActiveMQException
        Conditionally create a federation consumer for an address that matches the configuration of this server federation. This allows custom logic to be inserted to decide when to create federation consumers
        Parameters:
        address - The address that matched the federation configuration
        Returns:
        if true, create the consumer, else if false don't create
        Throws:
        ActiveMQException - if an error occurs during the call.

      • shouldCreateFederationConsumerForQueue

        default boolean shouldCreateFederationConsumerForQueue​(org.apache.activemq.artemis.core.server.Queue queue)
                                                throws ActiveMQException
        Conditionally create a federation consumer for an address that matches the configuration of this server federation. This allows custom logic to be inserted to decide when to create federation consumers
        Parameters:
        queue - The queue that matched the federation configuration
        Returns:
        if true, create the consumer, else if false don't create
        Throws:
        ActiveMQException - if an error occurs during the call.

      • shouldCreateFederationConsumerForDivert

        default boolean shouldCreateFederationConsumerForDivert​(org.apache.activemq.artemis.core.server.Divert divert,
                                                        org.apache.activemq.artemis.core.server.Queue queue)
                                                 throws ActiveMQException
        Conditionally create a federation consumer for an divert binding that matches the configuration of this server federation. This allows custom logic to be inserted to decide when to create federation consumers
        Parameters:
        divert - The Divert that matched the federation configuration
        queue - The Queue that was attached for a divert forwarding address.
        Returns:
        if true, create the consumer, else if false don't create
        Throws:
        ActiveMQException - if an error occurs during the call.