Package org.apache.activemq.artemis.junit

Interface EmbeddedActiveMQOperations

    • Method Detail

      • start

        void start()
        Start the embedded ActiveMQ Artemis server. The server will normally be started by JUnit using the before() method. This method allows the server to be started manually to support advanced testing scenarios.

      • stop

        void stop()
        Stop the embedded ActiveMQ Artemis server The server will normally be stopped by JUnit using the after() method. This method allows the server to be stopped manually to support advanced testing scenarios.

      • isUseDurableMessage

        boolean isUseDurableMessage()

      • setUseDurableMessage

        void setUseDurableMessage​(boolean useDurableMessage)
        Disables/Enables creating durable messages. By default, durable messages are created
        Parameters:
        useDurableMessage - if true, durable messages will be created

      • isUseDurableQueue

        boolean isUseDurableQueue()

      • setUseDurableQueue

        void setUseDurableQueue​(boolean useDurableQueue)
        Disables/Enables creating durable queues. By default, durable queues are created
        Parameters:
        useDurableQueue - if true, durable messages will be created

      • getDefaultReceiveTimeout

        long getDefaultReceiveTimeout()

      • setDefaultReceiveTimeout

        void setDefaultReceiveTimeout​(long defaultReceiveTimeout)
        Sets the default timeout in milliseconds used when receiving messages. Defaults to 50 milliseconds
        Parameters:
        defaultReceiveTimeout - received timeout in milliseconds

      • getServer

        org.apache.activemq.artemis.core.server.embedded.EmbeddedActiveMQ getServer()
        Get the EmbeddedActiveMQ server. This may be required for advanced configuration of the EmbeddedActiveMQ server.
        Returns:
        the embedded ActiveMQ broker

      • getServerName

        String getServerName()
        Get the name of the EmbeddedActiveMQ server
        Returns:
        name of the embedded server

      • getVmURL

        String getVmURL()
        Get the VM URL for the embedded EmbeddedActiveMQ server
        Returns:
        the VM URL for the embedded server

      • getMessageCount

        long getMessageCount​(String queueName)
        Get the number of messages in a specific queue.
        Parameters:
        queueName - the name of the queue
        Returns:
        the number of messages in the queue; -1 if queue is not found

      • getMessageCount

        long getMessageCount​(SimpleString queueName)
        Get the number of messages in a specific queue.
        Parameters:
        queueName - the name of the queue
        Returns:
        the number of messages in the queue; -1 if queue is not found

      • locateQueue

        org.apache.activemq.artemis.core.server.Queue locateQueue​(String queueName)

      • locateQueue

        org.apache.activemq.artemis.core.server.Queue locateQueue​(SimpleString queueName)

      • getBoundQueues

        List<org.apache.activemq.artemis.core.server.Queue> getBoundQueues​(String address)

      • getBoundQueues

        List<org.apache.activemq.artemis.core.server.Queue> getBoundQueues​(SimpleString address)

      • createQueue

        org.apache.activemq.artemis.core.server.Queue createQueue​(String name)

      • createQueue

        org.apache.activemq.artemis.core.server.Queue createQueue​(String address,
                                                          String name)

      • createSharedQueue

        void createSharedQueue​(String name,
                       String user)

      • createSharedQueue

        void createSharedQueue​(String address,
                       String name,
                       String user)

      • createMessage

        ClientMessage createMessage()
        Create a ClientMessage.

        If useDurableMessage is false, a non-durable message is created. Otherwise, a durable message is created.

        Returns:
        a new ClientMessage

      • createMessage

        ClientMessage createMessage​(byte[] body)
        Create a ClientMessage with the specified body.

        If useDurableMessage is false, a non-durable message is created. Otherwise, a durable message is created.

        Parameters:
        body - the body for the new message
        Returns:
        a new ClientMessage with the specified body

      • createMessage

        ClientMessage createMessage​(String body)
        Create a ClientMessage with the specified body.

        If useDurableMessage is false, a non-durable message is created. Otherwise, a durable message is created.

        Parameters:
        body - the body for the new message
        Returns:
        a new ClientMessage with the specified body

      • createMessageWithProperties

        ClientMessage createMessageWithProperties​(Map<String,​Object> properties)
        Create a ClientMessage with the specified message properties.

        If useDurableMessage is false, a non-durable message is created. Otherwise, a durable message is created.

        Parameters:
        properties - message properties for the new message
        Returns:
        a new ClientMessage with the specified message properties

      • createMessageWithProperties

        ClientMessage createMessageWithProperties​(byte[] body,
                                          Map<String,​Object> properties)
        Create a ClientMessage with the specified body and message properties.

        If useDurableMessage is false, a non-durable message is created. Otherwise, a durable message is created.

        Parameters:
        body - the body for the new message
        properties - message properties for the new message
        Returns:
        a new ClientMessage with the specified body and message properties

      • createMessageWithProperties

        ClientMessage createMessageWithProperties​(String body,
                                          Map<String,​Object> properties)
        Create a ClientMessage with the specified body and message properties.

        If useDurableMessage is false, a non-durable message is created. Otherwise, a durable message is created.

        Parameters:
        body - the body for the new message
        properties - message properties for the new message
        Returns:
        a new ClientMessage with the specified body and message properties

      • sendMessage

        void sendMessage​(String address,
                 ClientMessage message)
        Send a message to an address
        Parameters:
        address - the target queueName for the message
        message - the message to send

      • sendMessage

        ClientMessage sendMessage​(String address,
                          byte[] body)
        Create a new message with the specified body, and send the message to an address
        Parameters:
        address - the target queueName for the message
        body - the body for the new message
        Returns:
        the message that was sent

      • sendMessage

        ClientMessage sendMessage​(String address,
                          String body)
        Create a new message with the specified body, and send the message to an address
        Parameters:
        address - the target queueName for the message
        body - the body for the new message
        Returns:
        the message that was sent

      • sendMessageWithProperties

        ClientMessage sendMessageWithProperties​(String address,
                                        Map<String,​Object> properties)
        Create a new message with the specified properties, and send the message to an address
        Parameters:
        address - the target queueName for the message
        properties - message properties for the new message
        Returns:
        the message that was sent

      • sendMessageWithProperties

        ClientMessage sendMessageWithProperties​(String address,
                                        byte[] body,
                                        Map<String,​Object> properties)
        Create a new message with the specified body and properties, and send the message to an address
        Parameters:
        address - the target queueName for the message
        body - the body for the new message
        properties - message properties for the new message
        Returns:
        the message that was sent

      • sendMessageWithProperties

        ClientMessage sendMessageWithProperties​(String address,
                                        String body,
                                        Map<String,​Object> properties)
        Create a new message with the specified body and properties, and send the message to an address
        Parameters:
        address - the target queueName for the message
        body - the body for the new message
        properties - message properties for the new message
        Returns:
        the message that was sent

      • sendMessage

        void sendMessage​(SimpleString address,
                 ClientMessage message)
        Send a message to an queueName
        Parameters:
        address - the target queueName for the message
        message - the message to send

      • sendMessage

        ClientMessage sendMessage​(SimpleString address,
                          byte[] body)
        Create a new message with the specified body, and send the message to an queueName
        Parameters:
        address - the target queueName for the message
        body - the body for the new message
        Returns:
        the message that was sent

      • sendMessage

        ClientMessage sendMessage​(SimpleString address,
                          String body)
        Create a new message with the specified body, and send the message to an queueName
        Parameters:
        address - the target queueName for the message
        body - the body for the new message
        Returns:
        the message that was sent

      • sendMessageWithProperties

        ClientMessage sendMessageWithProperties​(SimpleString address,
                                        Map<String,​Object> properties)
        Create a new message with the specified properties, and send the message to an queueName
        Parameters:
        address - the target queueName for the message
        properties - message properties for the new message
        Returns:
        the message that was sent

      • sendMessageWithProperties

        ClientMessage sendMessageWithProperties​(SimpleString address,
                                        byte[] body,
                                        Map<String,​Object> properties)
        Create a new message with the specified body and properties, and send the message to an queueName
        Parameters:
        address - the target queueName for the message
        body - the body for the new message
        properties - message properties for the new message
        Returns:
        the message that was sent

      • sendMessageWithProperties

        ClientMessage sendMessageWithProperties​(SimpleString address,
                                        String body,
                                        Map<String,​Object> properties)
        Create a new message with the specified body and properties, and send the message to an queueName
        Parameters:
        address - the target queueName for the message
        body - the body for the new message
        properties - message properties for the new message
        Returns:
        the message that was sent

      • receiveMessage

        ClientMessage receiveMessage​(String queueName)
        Receive a message from the specified queue using the default receive timeout
        Parameters:
        queueName - name of the source queue
        Returns:
        the received ClientMessage, null if the receive timed-out

      • receiveMessage

        ClientMessage receiveMessage​(String queueName,
                             long timeout)
        Receive a message from the specified queue using the specified receive timeout
        Parameters:
        queueName - name of the source queue
        timeout - receive timeout in milliseconds
        Returns:
        the received ClientMessage, null if the receive timed-out

      • receiveMessage

        ClientMessage receiveMessage​(SimpleString queueName)
        Receive a message from the specified queue using the default receive timeout
        Parameters:
        queueName - name of the source queue
        Returns:
        the received ClientMessage, null if the receive timed-out

      • receiveMessage

        ClientMessage receiveMessage​(SimpleString queueName,
                             long timeout)
        Receive a message from the specified queue using the specified receive timeout
        Parameters:
        queueName - name of the source queue
        timeout - receive timeout in milliseconds
        Returns:
        the received ClientMessage, null if the receive timed-out

      • browseMessage

        ClientMessage browseMessage​(String queueName)
        Browse a message (receive but do not consume) from the specified queue using the default receive timeout
        Parameters:
        queueName - name of the source queue
        Returns:
        the received ClientMessage, null if the receive timed-out

      • browseMessage

        ClientMessage browseMessage​(String queueName,
                            long timeout)
        Browse a message (receive but do not consume) a message from the specified queue using the specified receive timeout
        Parameters:
        queueName - name of the source queue
        timeout - receive timeout in milliseconds
        Returns:
        the received ClientMessage, null if the receive timed-out

      • browseMessage

        ClientMessage browseMessage​(SimpleString queueName)
        Browse a message (receive but do not consume) from the specified queue using the default receive timeout
        Parameters:
        queueName - name of the source queue
        Returns:
        the received ClientMessage, null if the receive timed-out

      • browseMessage

        ClientMessage browseMessage​(SimpleString queueName,
                            long timeout)
        Browse a message (receive but do not consume) a message from the specified queue using the specified receive timeout
        Parameters:
        queueName - name of the source queue
        timeout - receive timeout in milliseconds
        Returns:
        the received ClientMessage, null if the receive timed-out