Class ActiveMQConsumerResource

java.lang.Object

org.junit.rules.ExternalResource

org.apache.activemq.artemis.junit.ActiveMQConsumerResource

All Implemented Interfaces:

ActiveMQConsumerOperations, org.junit.rules.TestRule

public class ActiveMQConsumerResource
extends org.junit.rules.ExternalResource
implements ActiveMQConsumerOperations

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 {
    @Rule
    public ActiveMQConsumerResource client = new ActiveMQProducerResource( "vm://0", "test.queue" );

    @Test
    public void testSomething() throws Exception {
        // Use the embedded client here
        ClientMessage message = client.receiveMessage();
    }
}

Constructor Summary

Constructors

Constructor	Description
ActiveMQConsumerResource(String url, String queueName)
ActiveMQConsumerResource(String url, String queueName, String username, String password)
ActiveMQConsumerResource(String url, SimpleString queueName)
ActiveMQConsumerResource(String url, SimpleString queueName, String username, String password)
ActiveMQConsumerResource(ServerLocator serverLocator, String queueName)
ActiveMQConsumerResource(ServerLocator serverLocator, String queueName, String username, String password)
ActiveMQConsumerResource(ServerLocator serverLocator, SimpleString queueName)
ActiveMQConsumerResource(ServerLocator serverLocator, SimpleString queueName, String username, String password)

Method Summary

Modifier and Type	Method	Description
static void	addMessageProperties(ClientMessage message, Map<String,Object> properties)
protected void	after()
protected void	before()
protected void	createClient()
long	getDefaultReceiveTimeout()
boolean	isAutoCreateQueue()
ClientMessage	receiveMessage()
ClientMessage	receiveMessage(long timeout)
void	setAutoCreateQueue(boolean autoCreateQueue)
void	setDefaultReceiveTimeout(long defaultReceiveTimeout)
protected void	stopClient()

Methods inherited from class org.junit.rules.ExternalResource

apply

Methods inherited from class Object

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

Constructor Details

ActiveMQConsumerResource

public ActiveMQConsumerResource(String url,
 String queueName)

ActiveMQConsumerResource

public ActiveMQConsumerResource(String url,
 String queueName,
 String username,
 String password)

ActiveMQConsumerResource

public ActiveMQConsumerResource(String url,
 SimpleString queueName,
 String username,
 String password)

ActiveMQConsumerResource

public ActiveMQConsumerResource(String url,
 SimpleString queueName)

ActiveMQConsumerResource

public ActiveMQConsumerResource(ServerLocator serverLocator,
 String queueName,
 String username,
 String password)

ActiveMQConsumerResource

public ActiveMQConsumerResource(ServerLocator serverLocator,
 String queueName)

ActiveMQConsumerResource

public ActiveMQConsumerResource(ServerLocator serverLocator,
 SimpleString queueName,
 String username,
 String password)

ActiveMQConsumerResource

public ActiveMQConsumerResource(ServerLocator serverLocator,
 SimpleString queueName)

Method Details

createClient

protected void createClient()

stopClient

protected void stopClient()

isAutoCreateQueue

public boolean isAutoCreateQueue()

Specified by:

isAutoCreateQueue in interface ActiveMQConsumerOperations

setAutoCreateQueue

public void setAutoCreateQueue(boolean autoCreateQueue)

Specified by:

setAutoCreateQueue in interface ActiveMQConsumerOperations

receiveMessage

public ClientMessage receiveMessage()

Specified by:

receiveMessage in interface ActiveMQConsumerOperations

receiveMessage

public ClientMessage receiveMessage(long timeout)

Specified by:

receiveMessage in interface ActiveMQConsumerOperations

before

protected void before()
               throws Throwable

Overrides:

before in class org.junit.rules.ExternalResource

Throws:

Throwable

after

protected void after()

Overrides:

after in class org.junit.rules.ExternalResource

addMessageProperties

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

getDefaultReceiveTimeout

public long getDefaultReceiveTimeout()

Specified by:

getDefaultReceiveTimeout in interface ActiveMQConsumerOperations

setDefaultReceiveTimeout

public void setDefaultReceiveTimeout(long defaultReceiveTimeout)

Specified by:

setDefaultReceiveTimeout in interface ActiveMQConsumerOperations