Package org.apache.activemq.artemis.junit

Class ActiveMQConsumerExtension

java.lang.Object

org.apache.activemq.artemis.junit.ActiveMQConsumerExtension

All Implemented Interfaces:

ActiveMQConsumerOperations, org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.Extension

public class ActiveMQConsumerExtension
extends Object
implements org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.AfterAllCallback, ActiveMQConsumerOperations

A JUnit Extension that embeds an ActiveMQ Artemis ClientConsumer into a test.

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

 public class SimpleTest {
     @RegisterExtension
     private ActiveMQConsumerExtension client = new ActiveMQConsumerExtension( "vm://0", "test.queue" );

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static void	addMessageProperties(ClientMessage message, Map<String,Object> properties)
void	afterAll(org.junit.jupiter.api.extension.ExtensionContext context)
void	beforeAll(org.junit.jupiter.api.extension.ExtensionContext context)
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 java.lang.Object

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

Constructor Detail

ActiveMQConsumerExtension

public ActiveMQConsumerExtension(String url,
                                 String queueName)

ActiveMQConsumerExtension

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

ActiveMQConsumerExtension

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

ActiveMQConsumerExtension

public ActiveMQConsumerExtension(String url,
                                 SimpleString queueName)

ActiveMQConsumerExtension

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

ActiveMQConsumerExtension

public ActiveMQConsumerExtension(ServerLocator serverLocator,
                                 String queueName)

ActiveMQConsumerExtension

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

ActiveMQConsumerExtension

public ActiveMQConsumerExtension(ServerLocator serverLocator,
                                 SimpleString queueName)

Method Detail

beforeAll

public void beforeAll(org.junit.jupiter.api.extension.ExtensionContext context)
               throws Exception

Specified by:

beforeAll in interface org.junit.jupiter.api.extension.BeforeAllCallback

Throws:

Exception

afterAll

public void afterAll(org.junit.jupiter.api.extension.ExtensionContext context)
              throws Exception

Specified by:

afterAll in interface org.junit.jupiter.api.extension.AfterAllCallback

Throws:

Exception

getDefaultReceiveTimeout

public long getDefaultReceiveTimeout()

Specified by:

getDefaultReceiveTimeout in interface ActiveMQConsumerOperations

setDefaultReceiveTimeout

public void setDefaultReceiveTimeout(long defaultReceiveTimeout)

Specified by:

setDefaultReceiveTimeout in interface ActiveMQConsumerOperations

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

addMessageProperties

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