org.apache.activemq.junit

Class EmbeddedActiveMQBroker

java.lang.Object

org.junit.rules.ExternalResource

org.apache.activemq.junit.EmbeddedActiveMQBroker

All Implemented Interfaces:

org.junit.rules.TestRule

public class EmbeddedActiveMQBroker
extends org.junit.rules.ExternalResource

A JUnit Rule that embeds an ActiveMQ broker into a test.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmbeddedActiveMQBroker.EmbeddedActiveMQBrokerException

Constructor Summary

Constructors

Constructor and Description
EmbeddedActiveMQBroker() Create an embedded ActiveMQ broker using defaults
EmbeddedActiveMQBroker(String configurationURI) Create an embedded ActiveMQ broker using a configuration URI
EmbeddedActiveMQBroker(URI configurationURI) Create an embedded ActiveMQ broker using a configuration URI

Method Summary

Modifier and Type	Method and Description
protected void	after() Stop the embedded ActiveMQ Broker Invoked by JUnit to tear down the resource
protected void	before() Start the embedded ActiveMQ Broker Invoked by JUnit to setup the resource
protected void	configure() Customize the configuration of the embedded ActiveMQ broker
javax.jms.BytesMessage	createBytesMessage()
ActiveMQConnectionFactory	createConnectionFactory() Create an ActiveMQConnectionFactory for the embedded ActiveMQ Broker
javax.jms.MapMessage	createMapMessage()
javax.jms.BytesMessage	createMessage(byte[] body)
javax.jms.BytesMessage	createMessage(byte[] body, Map<String,Object> properties)
javax.jms.MapMessage	createMessage(Map<String,Object> body)
javax.jms.MapMessage	createMessage(Map<String,Object> body, Map<String,Object> properties)
javax.jms.ObjectMessage	createMessage(Serializable body)
javax.jms.ObjectMessage	createMessage(Serializable body, Map<String,Object> properties)
javax.jms.TextMessage	createMessage(String body)
javax.jms.TextMessage	createMessage(String body, Map<String,Object> properties)
javax.jms.ObjectMessage	createObjectMessage()
PooledConnectionFactory	createPooledConnectionFactory() Create an PooledConnectionFactory for the embedded ActiveMQ Broker
javax.jms.StreamMessage	createStreamMessage()
javax.jms.TextMessage	createTextMessage()
void	disableAdvisoryForConsumed()
void	disableAdvisoryForDelivery()
void	disableAdvisoryForDiscardingMessages()
void	disableAdvisoryForFastProducers()
void	disableAdvisoryForSlowConsumers()
void	disableStatisticsPlugin()
void	enableAdvisoryForConsumed()
void	enableAdvisoryForDelivery()
void	enableAdvisoryForDiscardingMessages()
void	enableAdvisoryForFastProducers()
void	enableAdvisoryForSlowConsumers()
void	enableStatisticsPlugin()
String	getBrokerName() Get the name of the embedded ActiveMQ Broker
BrokerService	getBrokerService() Get the BrokerService for the embedded ActiveMQ broker.
Destination	getDestination(String destinationName) Get the ActiveMQ destination The full name of the JMS destination including the prefix should be provided - i.e.
long	getMessageCount(String destinationName) Get the number of messages in a specific JMS Destination.
URI	getVmURI() Get the failover VM URI for the embedded ActiveMQ Broker NOTE: The create=false option is appended to the URI to avoid the automatic creation of brokers and the resulting duplicate broker errors
URI	getVmURI(boolean failoverURI) Get the VM URI for the embedded ActiveMQ Broker NOTE: The create=false option is appended to the URI to avoid the automatic creation of brokers and the resulting duplicate broker errors
String	getVmURL() Get the failover VM URL for the embedded ActiveMQ Broker NOTE: The create=false option is appended to the URL to avoid the automatic creation of brokers and the resulting duplicate broker errors
String	getVmURL(boolean failoverURL) Get the VM URL for the embedded ActiveMQ Broker NOTE: The create=false option is appended to the URL to avoid the automatic creation of brokers and the resulting duplicate broker errors
boolean	isAdvisoryForConsumedEnabled()
boolean	isAdvisoryForDeliveryEnabled()
boolean	isAdvisoryForDiscardingMessagesEnabled()
boolean	isAdvisoryForFastProducersEnabled()
boolean	isAdvisoryForSlowConsumersEnabled()
boolean	isStatisticsPluginEnabled()
javax.jms.BytesMessage	peekBytesMessage(String destinationName)
javax.jms.MapMessage	peekMapMessage(String destinationName)
javax.jms.Message	peekMessage(String destinationName)
javax.jms.ObjectMessage	peekObjectMessage(String destinationName)
javax.jms.StreamMessage	peekStreamMessage(String destinationName)
javax.jms.TextMessage	peekTextMessage(String destinationName)
javax.jms.BytesMessage	pushMessage(String destinationName, byte[] body)
javax.jms.MapMessage	pushMessage(String destinationName, Map<String,Object> body)
void	pushMessage(String destinationName, javax.jms.Message message)
javax.jms.ObjectMessage	pushMessage(String destinationName, Serializable body)
javax.jms.TextMessage	pushMessage(String destinationName, String body)
javax.jms.BytesMessage	pushMessageWithProperties(String destinationName, byte[] body, Map<String,Object> properties)
javax.jms.MapMessage	pushMessageWithProperties(String destinationName, Map<String,Object> body, Map<String,Object> properties)
javax.jms.ObjectMessage	pushMessageWithProperties(String destinationName, Serializable body, Map<String,Object> properties)
javax.jms.TextMessage	pushMessageWithProperties(String destinationName, String body, Map<String,Object> properties)
void	setBrokerName(String brokerName)
static void	setMessageProperties(javax.jms.Message message, Map<String,Object> properties)
void	start() Start the embedded ActiveMQ broker, blocking until the broker has successfully started.
void	stop() Stop the embedded ActiveMQ broker, blocking until the broker has stopped.

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

EmbeddedActiveMQBroker

public EmbeddedActiveMQBroker()

Create an embedded ActiveMQ broker using defaults

The defaults are: - the broker name is 'embedded-broker' - JMX is enable but no management connector is created. - Persistence is disabled

EmbeddedActiveMQBroker

public EmbeddedActiveMQBroker(String configurationURI)

Create an embedded ActiveMQ broker using a configuration URI

EmbeddedActiveMQBroker

public EmbeddedActiveMQBroker(URI configurationURI)

Create an embedded ActiveMQ broker using a configuration URI

Method Detail

setMessageProperties

public static void setMessageProperties(javax.jms.Message message,
                                        Map<String,Object> properties)

configure

protected void configure()

Customize the configuration of the embedded ActiveMQ broker

This method is called before the embedded ActiveMQ broker is started, and can be overridden to this method to customize the broker configuration.

start

public void start()

Start the embedded ActiveMQ broker, blocking until the broker has successfully started.

The broker will normally be started by JUnit using the before() method. This method allows the broker to be started manually to support advanced testing scenarios.

stop

public void stop()

Stop the embedded ActiveMQ broker, blocking until the broker has stopped.

The broker will normally be stopped by JUnit using the after() method. This method allows the broker to be stopped manually to support advanced testing scenarios.

before

protected void before()
               throws Throwable

Start the embedded ActiveMQ Broker

Invoked by JUnit to setup the resource

Overrides:

before in class org.junit.rules.ExternalResource

Throws:

Throwable

after

protected void after()

Stop the embedded ActiveMQ Broker

Invoked by JUnit to tear down the resource

Overrides:

after in class org.junit.rules.ExternalResource

createConnectionFactory

public ActiveMQConnectionFactory createConnectionFactory()

Create an ActiveMQConnectionFactory for the embedded ActiveMQ Broker

Returns:

a new ActiveMQConnectionFactory

createPooledConnectionFactory

public PooledConnectionFactory createPooledConnectionFactory()

Create an PooledConnectionFactory for the embedded ActiveMQ Broker

Returns:

a new PooledConnectionFactory

getBrokerService

public BrokerService getBrokerService()

Get the BrokerService for the embedded ActiveMQ broker.

This may be required for advanced configuration of the BrokerService.

Returns:

the embedded ActiveMQ broker

getVmURL

public String getVmURL()

Get the failover VM URL for the embedded ActiveMQ Broker

NOTE: The create=false option is appended to the URL to avoid the automatic creation of brokers and the resulting duplicate broker errors

Returns:

the VM URL for the embedded broker

getVmURL

public String getVmURL(boolean failoverURL)

Get the VM URL for the embedded ActiveMQ Broker

NOTE: The create=false option is appended to the URL to avoid the automatic creation of brokers and the resulting duplicate broker errors

Parameters:

failoverURL - if true a failover URL will be returned

Returns:

the VM URL for the embedded broker

getVmURI

public URI getVmURI()

Get the failover VM URI for the embedded ActiveMQ Broker

NOTE: The create=false option is appended to the URI to avoid the automatic creation of brokers and the resulting duplicate broker errors

Returns:

the VM URI for the embedded broker

getVmURI

public URI getVmURI(boolean failoverURI)

Get the VM URI for the embedded ActiveMQ Broker

NOTE: The create=false option is appended to the URI to avoid the automatic creation of brokers and the resulting duplicate broker errors

Parameters:

failoverURI - if true a failover URI will be returned

Returns:

the VM URI for the embedded broker

getBrokerName

public String getBrokerName()

Get the name of the embedded ActiveMQ Broker

Returns:

name of the embedded broker

setBrokerName

public void setBrokerName(String brokerName)

isStatisticsPluginEnabled

public boolean isStatisticsPluginEnabled()

enableStatisticsPlugin

public void enableStatisticsPlugin()

disableStatisticsPlugin

public void disableStatisticsPlugin()

isAdvisoryForDeliveryEnabled

public boolean isAdvisoryForDeliveryEnabled()

enableAdvisoryForDelivery

public void enableAdvisoryForDelivery()

disableAdvisoryForDelivery

public void disableAdvisoryForDelivery()

isAdvisoryForConsumedEnabled

public boolean isAdvisoryForConsumedEnabled()

enableAdvisoryForConsumed

public void enableAdvisoryForConsumed()

disableAdvisoryForConsumed

public void disableAdvisoryForConsumed()

isAdvisoryForDiscardingMessagesEnabled

public boolean isAdvisoryForDiscardingMessagesEnabled()

enableAdvisoryForDiscardingMessages

public void enableAdvisoryForDiscardingMessages()

disableAdvisoryForDiscardingMessages

public void disableAdvisoryForDiscardingMessages()

isAdvisoryForFastProducersEnabled

public boolean isAdvisoryForFastProducersEnabled()

enableAdvisoryForFastProducers

public void enableAdvisoryForFastProducers()

disableAdvisoryForFastProducers

public void disableAdvisoryForFastProducers()

isAdvisoryForSlowConsumersEnabled

public boolean isAdvisoryForSlowConsumersEnabled()

enableAdvisoryForSlowConsumers

public void enableAdvisoryForSlowConsumers()

disableAdvisoryForSlowConsumers

public void disableAdvisoryForSlowConsumers()

getMessageCount

public long getMessageCount(String destinationName)

Get the number of messages in a specific JMS Destination.

The full name of the JMS destination including the prefix should be provided - i.e. queue://myQueue or topic://myTopic. If the destination type prefix is not included in the destination name, a prefix of "queue://" is assumed.

Parameters:

destinationName - the full name of the JMS Destination

Returns:

the number of messages in the JMS Destination

getDestination

public Destination getDestination(String destinationName)

Get the ActiveMQ destination

The full name of the JMS destination including the prefix should be provided - i.e. queue://myQueue or topic://myTopic. If the destination type prefix is not included in the destination name, a prefix of "queue://" is assumed.

Parameters:

destinationName - the full name of the JMS Destination

Returns:

the ActiveMQ destination, null if not found

createBytesMessage

public javax.jms.BytesMessage createBytesMessage()

createTextMessage

public javax.jms.TextMessage createTextMessage()

createMapMessage

public javax.jms.MapMessage createMapMessage()

createObjectMessage

public javax.jms.ObjectMessage createObjectMessage()

createStreamMessage

public javax.jms.StreamMessage createStreamMessage()

createMessage

public javax.jms.BytesMessage createMessage(byte[] body)

createMessage

public javax.jms.TextMessage createMessage(String body)

createMessage

public javax.jms.MapMessage createMessage(Map<String,Object> body)

createMessage

public javax.jms.ObjectMessage createMessage(Serializable body)

createMessage

public javax.jms.BytesMessage createMessage(byte[] body,
                                            Map<String,Object> properties)

createMessage

public javax.jms.TextMessage createMessage(String body,
                                           Map<String,Object> properties)

createMessage

public javax.jms.MapMessage createMessage(Map<String,Object> body,
                                          Map<String,Object> properties)

createMessage

public javax.jms.ObjectMessage createMessage(Serializable body,
                                             Map<String,Object> properties)

pushMessage

public void pushMessage(String destinationName,
                        javax.jms.Message message)

pushMessage

public javax.jms.BytesMessage pushMessage(String destinationName,
                                          byte[] body)

pushMessage

public javax.jms.TextMessage pushMessage(String destinationName,
                                         String body)

pushMessage

public javax.jms.MapMessage pushMessage(String destinationName,
                                        Map<String,Object> body)

pushMessage

public javax.jms.ObjectMessage pushMessage(String destinationName,
                                           Serializable body)

pushMessageWithProperties

public javax.jms.BytesMessage pushMessageWithProperties(String destinationName,
                                                        byte[] body,
                                                        Map<String,Object> properties)

pushMessageWithProperties

public javax.jms.TextMessage pushMessageWithProperties(String destinationName,
                                                       String body,
                                                       Map<String,Object> properties)

pushMessageWithProperties

public javax.jms.MapMessage pushMessageWithProperties(String destinationName,
                                                      Map<String,Object> body,
                                                      Map<String,Object> properties)

pushMessageWithProperties

public javax.jms.ObjectMessage pushMessageWithProperties(String destinationName,
                                                         Serializable body,
                                                         Map<String,Object> properties)

peekMessage

public javax.jms.Message peekMessage(String destinationName)

peekBytesMessage

public javax.jms.BytesMessage peekBytesMessage(String destinationName)

peekTextMessage

public javax.jms.TextMessage peekTextMessage(String destinationName)

peekMapMessage

public javax.jms.MapMessage peekMapMessage(String destinationName)

peekObjectMessage

public javax.jms.ObjectMessage peekObjectMessage(String destinationName)

peekStreamMessage

public javax.jms.StreamMessage peekStreamMessage(String destinationName)