org.apache.activemq.artemis.junit

Class ActiveMQConsumerResource

java.lang.Object

org.junit.rules.ExternalResource

org.apache.activemq.artemis.junit.AbstractActiveMQClientResource

org.apache.activemq.artemis.junit.ActiveMQConsumerResource

All Implemented Interfaces:

org.junit.rules.TestRule

public class ActiveMQConsumerResource
extends AbstractActiveMQClientResource

A JUnit Rule that embeds an ActiveMQ Artemis ClientConsumer into a test. This JUnit Rule is designed to simplify using ActiveMQ Artemis clients in unit tests. Adding the rule to a test will startup a ClientConsumer, which can then be used to consume messages from an ActiveMQ Artemis server.

 public class SimpleTest {

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.activemq.artemis.junit.AbstractActiveMQClientResource

AbstractActiveMQClientResource.ActiveMQClientResourceException

Constructor Summary

Constructors

Constructor and Description
ActiveMQConsumerResource(org.apache.activemq.artemis.api.core.client.ServerLocator serverLocator, org.apache.activemq.artemis.api.core.SimpleString queueName)
ActiveMQConsumerResource(org.apache.activemq.artemis.api.core.client.ServerLocator serverLocator, String queueName)
ActiveMQConsumerResource(String url, org.apache.activemq.artemis.api.core.SimpleString queueName)
ActiveMQConsumerResource(String url, String queueName)

Method Summary

Modifier and Type	Method and Description
protected void	createClient()
long	getDefaultReceiveTimeout()
boolean	isAutoCreateQueue()
org.apache.activemq.artemis.api.core.client.ClientMessage	receiveMessage()
org.apache.activemq.artemis.api.core.client.ClientMessage	receiveMessage(long timeout)
void	setAutoCreateQueue(boolean autoCreateQueue) Enable/Disable the automatic creation of non-existent queues.
void	setDefaultReceiveTimeout(long defaultReceiveTimeout) Sets the default timeout in milliseconds used when receiving messages.
protected void	stopClient()

Methods inherited from class org.apache.activemq.artemis.junit.AbstractActiveMQClientResource

addMessageProperties, after, before

Methods inherited from class org.junit.rules.ExternalResource

apply

Methods inherited from class java.lang.Object

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

Constructor Detail

ActiveMQConsumerResource

public ActiveMQConsumerResource(String url,
                                String queueName)

ActiveMQConsumerResource

public ActiveMQConsumerResource(String url,
                                org.apache.activemq.artemis.api.core.SimpleString queueName)

ActiveMQConsumerResource

public ActiveMQConsumerResource(org.apache.activemq.artemis.api.core.client.ServerLocator serverLocator,
                                String queueName)

ActiveMQConsumerResource

public ActiveMQConsumerResource(org.apache.activemq.artemis.api.core.client.ServerLocator serverLocator,
                                org.apache.activemq.artemis.api.core.SimpleString queueName)

Method Detail

getDefaultReceiveTimeout

public long getDefaultReceiveTimeout()

setDefaultReceiveTimeout

public void setDefaultReceiveTimeout(long defaultReceiveTimeout)

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

Parameters:

defaultReceiveTimeout - received timeout in milliseconds

createClient

protected void createClient()

Specified by:

createClient in class AbstractActiveMQClientResource

stopClient

protected void stopClient()

Specified by:

stopClient in class AbstractActiveMQClientResource

isAutoCreateQueue

public boolean isAutoCreateQueue()

Overrides:

isAutoCreateQueue in class AbstractActiveMQClientResource

setAutoCreateQueue

public void setAutoCreateQueue(boolean autoCreateQueue)

Enable/Disable the automatic creation of non-existent queues. The default is to automatically create non-existent queues

Overrides:

setAutoCreateQueue in class AbstractActiveMQClientResource

Parameters:

autoCreateQueue -

receiveMessage

public org.apache.activemq.artemis.api.core.client.ClientMessage receiveMessage()

receiveMessage

public org.apache.activemq.artemis.api.core.client.ClientMessage receiveMessage(long timeout)