Package org.apache.activemq.artemis.junit

Class EmbeddedActiveMQDelegate

java.lang.Object

org.apache.activemq.artemis.junit.EmbeddedActiveMQDelegate

All Implemented Interfaces:

EmbeddedActiveMQOperations

public class EmbeddedActiveMQDelegate
extends Object
implements EmbeddedActiveMQOperations

Base class to embed an ActiveMQ Artemis server into a test.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EmbeddedActiveMQDelegate.EmbeddedActiveMQResourceException

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EmbeddedActiveMQDelegate()	Create a default EmbeddedActiveMQResource
protected	EmbeddedActiveMQDelegate(int serverId)	Create a default EmbeddedActiveMQResource with the specified serverId
protected	EmbeddedActiveMQDelegate(String filename)	Creates an EmbeddedActiveMQResource using the specified configuration file
protected	EmbeddedActiveMQDelegate(Configuration configuration)	Creates an EmbeddedActiveMQResource using the specified configuration

Method Summary

Modifier and Type	Method	Description
static void	addMessageProperties(ClientMessage message, Map<String,Object> properties)	Adds properties to a ClientMessage
ClientMessage	browseMessage(String queueName)	Browse a message (receive but do not consume) from the specified queue using the default receive timeout
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
ClientMessage	browseMessage(SimpleString queueName)	Browse a message (receive but do not consume) from the specified queue using the default receive timeout
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
ClientMessage	createMessage()	Create a ClientMessage.
ClientMessage	createMessage(byte[] body)	Create a ClientMessage with the specified body.
ClientMessage	createMessage(String body)	Create a ClientMessage with the specified body.
ClientMessage	createMessageWithProperties(byte[] body, Map<String,Object> properties)	Create a ClientMessage with the specified body and message properties.
ClientMessage	createMessageWithProperties(String body, Map<String,Object> properties)	Create a ClientMessage with the specified body and message properties.
ClientMessage	createMessageWithProperties(Map<String,Object> properties)	Create a ClientMessage with the specified message properties.
org.apache.activemq.artemis.core.server.Queue	createQueue(String name)
org.apache.activemq.artemis.core.server.Queue	createQueue(String address, String name)
org.apache.activemq.artemis.core.server.Queue	createQueue(SimpleString address, SimpleString name)
void	createSharedQueue(String name, String user)
void	createSharedQueue(String address, String name, String user)
void	createSharedQueue(SimpleString address, SimpleString name, SimpleString user)
List<org.apache.activemq.artemis.core.server.Queue>	getBoundQueues(String address)
List<org.apache.activemq.artemis.core.server.Queue>	getBoundQueues(SimpleString address)
long	getDefaultReceiveTimeout()
long	getMessageCount(String queueName)	Get the number of messages in a specific queue.
long	getMessageCount(SimpleString queueName)	Get the number of messages in a specific queue.
org.apache.activemq.artemis.core.server.embedded.EmbeddedActiveMQ	getServer()	Get the EmbeddedActiveMQ server.
String	getServerName()	Get the name of the EmbeddedActiveMQ server
String	getVmURL()	Get the VM URL for the embedded EmbeddedActiveMQ server
boolean	isUseDurableMessage()
boolean	isUseDurableQueue()
org.apache.activemq.artemis.core.server.Queue	locateQueue(String queueName)
org.apache.activemq.artemis.core.server.Queue	locateQueue(SimpleString queueName)
ClientMessage	receiveMessage(String queueName)	Receive a message from the specified queue using the default receive timeout
ClientMessage	receiveMessage(String queueName, long timeout)	Receive a message from the specified queue using the specified receive timeout
ClientMessage	receiveMessage(SimpleString queueName)	Receive a message from the specified queue using the default receive timeout
ClientMessage	receiveMessage(SimpleString queueName, long timeout)	Receive a message from the specified queue using the specified receive timeout
ClientMessage	sendMessage(String address, byte[] body)	Create a new message with the specified body, and send the message to an address
ClientMessage	sendMessage(String address, String body)	Create a new message with the specified body, and send the message to an address
void	sendMessage(String address, ClientMessage message)	Send a message to an address
ClientMessage	sendMessage(SimpleString address, byte[] body)	Create a new message with the specified body, and send the message to an queueName
ClientMessage	sendMessage(SimpleString address, String body)	Create a new message with the specified body, and send the message to an queueName
void	sendMessage(SimpleString address, ClientMessage message)	Send a message to an queueName
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
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
ClientMessage	sendMessageWithProperties(String address, Map<String,Object> properties)	Create a new message with the specified properties, and send the message to an address
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
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
ClientMessage	sendMessageWithProperties(SimpleString address, Map<String,Object> properties)	Create a new message with the specified properties, and send the message to an queueName
void	setDefaultReceiveTimeout(long defaultReceiveTimeout)	Sets the default timeout in milliseconds used when receiving messages.
void	setUseDurableMessage(boolean useDurableMessage)	Disables/Enables creating durable messages.
void	setUseDurableQueue(boolean useDurableQueue)	Disables/Enables creating durable queues.
void	start()	Start the embedded ActiveMQ Artemis server.
void	stop()	Stop the embedded ActiveMQ Artemis server The server will normally be stopped by JUnit using the after() method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EmbeddedActiveMQDelegate

protected EmbeddedActiveMQDelegate()

Create a default EmbeddedActiveMQResource

EmbeddedActiveMQDelegate

protected EmbeddedActiveMQDelegate(int serverId)

Create a default EmbeddedActiveMQResource with the specified serverId

Parameters:

serverId - server id

EmbeddedActiveMQDelegate

protected EmbeddedActiveMQDelegate(Configuration configuration)

Creates an EmbeddedActiveMQResource using the specified configuration

Parameters:

configuration - ActiveMQServer configuration

EmbeddedActiveMQDelegate

protected EmbeddedActiveMQDelegate(String filename)

Creates an EmbeddedActiveMQResource using the specified configuration file

Parameters:

filename - ActiveMQServer configuration file name

Method Detail

addMessageProperties

public static void addMessageProperties(ClientMessage message,
                                        Map<String,Object> properties)

Adds properties to a ClientMessage

Parameters:

message -

properties -

start

public void start()

Description copied from interface: EmbeddedActiveMQOperations

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.

Specified by:

start in interface EmbeddedActiveMQOperations

stop

public void stop()

Description copied from interface: EmbeddedActiveMQOperations

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.

Specified by:

stop in interface EmbeddedActiveMQOperations

isUseDurableMessage

public boolean isUseDurableMessage()

Specified by:

isUseDurableMessage in interface EmbeddedActiveMQOperations

setUseDurableMessage

public void setUseDurableMessage(boolean useDurableMessage)

Description copied from interface: EmbeddedActiveMQOperations

Disables/Enables creating durable messages. By default, durable messages are created

Specified by:

setUseDurableMessage in interface EmbeddedActiveMQOperations

Parameters:

useDurableMessage - if true, durable messages will be created

isUseDurableQueue

public boolean isUseDurableQueue()

Specified by:

isUseDurableQueue in interface EmbeddedActiveMQOperations

setUseDurableQueue

public void setUseDurableQueue(boolean useDurableQueue)

Description copied from interface: EmbeddedActiveMQOperations

Disables/Enables creating durable queues. By default, durable queues are created

Specified by:

setUseDurableQueue in interface EmbeddedActiveMQOperations

Parameters:

useDurableQueue - if true, durable messages will be created

getDefaultReceiveTimeout

public long getDefaultReceiveTimeout()

Specified by:

getDefaultReceiveTimeout in interface EmbeddedActiveMQOperations

setDefaultReceiveTimeout

public void setDefaultReceiveTimeout(long defaultReceiveTimeout)

Description copied from interface: EmbeddedActiveMQOperations

Sets the default timeout in milliseconds used when receiving messages. Defaults to 50 milliseconds

Specified by:

setDefaultReceiveTimeout in interface EmbeddedActiveMQOperations

Parameters:

defaultReceiveTimeout - received timeout in milliseconds

getServer

public org.apache.activemq.artemis.core.server.embedded.EmbeddedActiveMQ getServer()

Description copied from interface: EmbeddedActiveMQOperations

Get the EmbeddedActiveMQ server. This may be required for advanced configuration of the EmbeddedActiveMQ server.

Specified by:

getServer in interface EmbeddedActiveMQOperations

Returns:

the embedded ActiveMQ broker

getServerName

public String getServerName()

Description copied from interface: EmbeddedActiveMQOperations

Get the name of the EmbeddedActiveMQ server

Specified by:

getServerName in interface EmbeddedActiveMQOperations

Returns:

name of the embedded server

getVmURL

public String getVmURL()

Description copied from interface: EmbeddedActiveMQOperations

Get the VM URL for the embedded EmbeddedActiveMQ server

Specified by:

getVmURL in interface EmbeddedActiveMQOperations

Returns:

the VM URL for the embedded server

getMessageCount

public long getMessageCount(String queueName)

Description copied from interface: EmbeddedActiveMQOperations

Get the number of messages in a specific queue.

Specified by:

getMessageCount in interface EmbeddedActiveMQOperations

Parameters:

queueName - the name of the queue

Returns:

the number of messages in the queue; -1 if queue is not found

getMessageCount

public long getMessageCount(SimpleString queueName)

Description copied from interface: EmbeddedActiveMQOperations

Get the number of messages in a specific queue.

Specified by:

getMessageCount in interface EmbeddedActiveMQOperations

Parameters:

queueName - the name of the queue

Returns:

the number of messages in the queue; -1 if queue is not found

locateQueue

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

Specified by:

locateQueue in interface EmbeddedActiveMQOperations

locateQueue

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

Specified by:

locateQueue in interface EmbeddedActiveMQOperations

getBoundQueues

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

Specified by:

getBoundQueues in interface EmbeddedActiveMQOperations

getBoundQueues

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

Specified by:

getBoundQueues in interface EmbeddedActiveMQOperations

createQueue

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

Specified by:

createQueue in interface EmbeddedActiveMQOperations

createQueue

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

Specified by:

createQueue in interface EmbeddedActiveMQOperations

createQueue

public org.apache.activemq.artemis.core.server.Queue createQueue(SimpleString address,
                                                                 SimpleString name)

Specified by:

createQueue in interface EmbeddedActiveMQOperations

createSharedQueue

public void createSharedQueue(String name,
                              String user)

Specified by:

createSharedQueue in interface EmbeddedActiveMQOperations

createSharedQueue

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

Specified by:

createSharedQueue in interface EmbeddedActiveMQOperations

createSharedQueue

public void createSharedQueue(SimpleString address,
                              SimpleString name,
                              SimpleString user)

Specified by:

createSharedQueue in interface EmbeddedActiveMQOperations

createMessage

public ClientMessage createMessage()

Description copied from interface: EmbeddedActiveMQOperations

Create a ClientMessage.

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

Specified by:

createMessage in interface EmbeddedActiveMQOperations

Returns:

a new ClientMessage

createMessage

public ClientMessage createMessage(byte[] body)

Description copied from interface: EmbeddedActiveMQOperations

Create a ClientMessage with the specified body.

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

Specified by:

createMessage in interface EmbeddedActiveMQOperations

Parameters:

body - the body for the new message

Returns:

a new ClientMessage with the specified body

createMessage

public ClientMessage createMessage(String body)

Description copied from interface: EmbeddedActiveMQOperations

Create a ClientMessage with the specified body.

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

Specified by:

createMessage in interface EmbeddedActiveMQOperations

Parameters:

body - the body for the new message

Returns:

a new ClientMessage with the specified body

createMessageWithProperties

public ClientMessage createMessageWithProperties(Map<String,Object> properties)

Description copied from interface: EmbeddedActiveMQOperations

Create a ClientMessage with the specified message properties.

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

Specified by:

createMessageWithProperties in interface EmbeddedActiveMQOperations

Parameters:

properties - message properties for the new message

Returns:

a new ClientMessage with the specified message properties

createMessageWithProperties

public ClientMessage createMessageWithProperties(byte[] body,
                                                 Map<String,Object> properties)

Description copied from interface: EmbeddedActiveMQOperations

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.

Specified by:

createMessageWithProperties in interface EmbeddedActiveMQOperations

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

public ClientMessage createMessageWithProperties(String body,
                                                 Map<String,Object> properties)

Description copied from interface: EmbeddedActiveMQOperations

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.

Specified by:

createMessageWithProperties in interface EmbeddedActiveMQOperations

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

public void sendMessage(String address,
                        ClientMessage message)

Description copied from interface: EmbeddedActiveMQOperations

Send a message to an address

Specified by:

sendMessage in interface EmbeddedActiveMQOperations

Parameters:

address - the target queueName for the message

message - the message to send

sendMessage

public ClientMessage sendMessage(String address,
                                 byte[] body)

Description copied from interface: EmbeddedActiveMQOperations

Create a new message with the specified body, and send the message to an address

Specified by:

sendMessage in interface EmbeddedActiveMQOperations

Parameters:

address - the target queueName for the message

body - the body for the new message

Returns:

the message that was sent

sendMessage

public ClientMessage sendMessage(String address,
                                 String body)

Description copied from interface: EmbeddedActiveMQOperations

Create a new message with the specified body, and send the message to an address

Specified by:

sendMessage in interface EmbeddedActiveMQOperations

Parameters:

address - the target queueName for the message

body - the body for the new message

Returns:

the message that was sent

sendMessageWithProperties

public ClientMessage sendMessageWithProperties(String address,
                                               Map<String,Object> properties)

Description copied from interface: EmbeddedActiveMQOperations

Create a new message with the specified properties, and send the message to an address

Specified by:

sendMessageWithProperties in interface EmbeddedActiveMQOperations

Parameters:

address - the target queueName for the message

properties - message properties for the new message

Returns:

the message that was sent

sendMessageWithProperties

public ClientMessage sendMessageWithProperties(String address,
                                               byte[] body,
                                               Map<String,Object> properties)

Description copied from interface: EmbeddedActiveMQOperations

Create a new message with the specified body and properties, and send the message to an address

Specified by:

sendMessageWithProperties in interface EmbeddedActiveMQOperations

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

public ClientMessage sendMessageWithProperties(String address,
                                               String body,
                                               Map<String,Object> properties)

Description copied from interface: EmbeddedActiveMQOperations

Create a new message with the specified body and properties, and send the message to an address

Specified by:

sendMessageWithProperties in interface EmbeddedActiveMQOperations

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

public void sendMessage(SimpleString address,
                        ClientMessage message)

Description copied from interface: EmbeddedActiveMQOperations

Send a message to an queueName

Specified by:

sendMessage in interface EmbeddedActiveMQOperations

Parameters:

address - the target queueName for the message

message - the message to send

sendMessage

public ClientMessage sendMessage(SimpleString address,
                                 byte[] body)

Description copied from interface: EmbeddedActiveMQOperations

Create a new message with the specified body, and send the message to an queueName

Specified by:

sendMessage in interface EmbeddedActiveMQOperations

Parameters:

address - the target queueName for the message

body - the body for the new message

Returns:

the message that was sent

sendMessage

public ClientMessage sendMessage(SimpleString address,
                                 String body)

Description copied from interface: EmbeddedActiveMQOperations

Create a new message with the specified body, and send the message to an queueName

Specified by:

sendMessage in interface EmbeddedActiveMQOperations

Parameters:

address - the target queueName for the message

body - the body for the new message

Returns:

the message that was sent

sendMessageWithProperties

public ClientMessage sendMessageWithProperties(SimpleString address,
                                               Map<String,Object> properties)

Description copied from interface: EmbeddedActiveMQOperations

Create a new message with the specified properties, and send the message to an queueName

Specified by:

sendMessageWithProperties in interface EmbeddedActiveMQOperations

Parameters:

address - the target queueName for the message

properties - message properties for the new message

Returns:

the message that was sent

sendMessageWithProperties

public ClientMessage sendMessageWithProperties(SimpleString address,
                                               byte[] body,
                                               Map<String,Object> properties)

Description copied from interface: EmbeddedActiveMQOperations

Create a new message with the specified body and properties, and send the message to an queueName

Specified by:

sendMessageWithProperties in interface EmbeddedActiveMQOperations

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

public ClientMessage sendMessageWithProperties(SimpleString address,
                                               String body,
                                               Map<String,Object> properties)

Description copied from interface: EmbeddedActiveMQOperations

Create a new message with the specified body and properties, and send the message to an queueName

Specified by:

sendMessageWithProperties in interface EmbeddedActiveMQOperations

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

public ClientMessage receiveMessage(String queueName)

Description copied from interface: EmbeddedActiveMQOperations

Receive a message from the specified queue using the default receive timeout

Specified by:

receiveMessage in interface EmbeddedActiveMQOperations

Parameters:

queueName - name of the source queue

Returns:

the received ClientMessage, null if the receive timed-out

receiveMessage

public ClientMessage receiveMessage(String queueName,
                                    long timeout)

Description copied from interface: EmbeddedActiveMQOperations

Receive a message from the specified queue using the specified receive timeout

Specified by:

receiveMessage in interface EmbeddedActiveMQOperations

Parameters:

queueName - name of the source queue

timeout - receive timeout in milliseconds

Returns:

the received ClientMessage, null if the receive timed-out

receiveMessage

public ClientMessage receiveMessage(SimpleString queueName)

Description copied from interface: EmbeddedActiveMQOperations

Receive a message from the specified queue using the default receive timeout

Specified by:

receiveMessage in interface EmbeddedActiveMQOperations

Parameters:

queueName - name of the source queue

Returns:

the received ClientMessage, null if the receive timed-out

receiveMessage

public ClientMessage receiveMessage(SimpleString queueName,
                                    long timeout)

Description copied from interface: EmbeddedActiveMQOperations

Receive a message from the specified queue using the specified receive timeout

Specified by:

receiveMessage in interface EmbeddedActiveMQOperations

Parameters:

queueName - name of the source queue

timeout - receive timeout in milliseconds

Returns:

the received ClientMessage, null if the receive timed-out

browseMessage

public ClientMessage browseMessage(String queueName)

Description copied from interface: EmbeddedActiveMQOperations

Browse a message (receive but do not consume) from the specified queue using the default receive timeout

Specified by:

browseMessage in interface EmbeddedActiveMQOperations

Parameters:

queueName - name of the source queue

Returns:

the received ClientMessage, null if the receive timed-out

browseMessage

public ClientMessage browseMessage(String queueName,
                                   long timeout)

Description copied from interface: EmbeddedActiveMQOperations

Browse a message (receive but do not consume) a message from the specified queue using the specified receive timeout

Specified by:

browseMessage in interface EmbeddedActiveMQOperations

Parameters:

queueName - name of the source queue

timeout - receive timeout in milliseconds

Returns:

the received ClientMessage, null if the receive timed-out

browseMessage

public ClientMessage browseMessage(SimpleString queueName)

Description copied from interface: EmbeddedActiveMQOperations

Browse a message (receive but do not consume) from the specified queue using the default receive timeout

Specified by:

browseMessage in interface EmbeddedActiveMQOperations

Parameters:

queueName - name of the source queue

Returns:

the received ClientMessage, null if the receive timed-out

browseMessage

public ClientMessage browseMessage(SimpleString queueName,
                                   long timeout)

Description copied from interface: EmbeddedActiveMQOperations

Browse a message (receive but do not consume) a message from the specified queue using the specified receive timeout

Specified by:

browseMessage in interface EmbeddedActiveMQOperations

Parameters:

queueName - name of the source queue

timeout - receive timeout in milliseconds

Returns:

the received ClientMessage, null if the receive timed-out