EmbeddedActiveMQBroker (ActiveMQ :: JUnit Rule 5.14.5 API)

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.

Constructor Summary

Constructors
Constructor and Description
`EmbeddedActiveMQBroker()` Create an embedded ActiveMQ broker using defaults The defaults are: - the broker name is 'embedded-broker' - JMX is enabled but no management connector will be created.
`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

All Methods Instance Methods Concrete Methods
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 This method is called before the embedded ActiveMQ broker is started, and can be overridden to this method to customize the broker configuration.
`org.apache.activemq.ActiveMQConnectionFactory`	`createConnectionFactory()` Create an ActiveMQConnectionFactory for the embedded ActiveMQ Broker
`PooledConnectionFactory`	`createPooledConnectionFactory()` Create an PooledConnectionFactory for the embedded ActiveMQ Broker
`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.
`int`	`getMessageCount(String fullDestinationName)` Get the number of messages in a specific JMS Destination.
`String`	`getVmURL()` Get the VM URL for the embedded ActiveMQ Broker NOTE: The option is precreate=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()`
`void`	`setBrokerName(String brokerName)`
`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 enabled but no management connector will be 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
  - 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 org.apache.activemq.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 VM URL for the embedded ActiveMQ Broker
    NOTE: The option is precreate=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
  - 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 int getMessageCount(String fullDestinationName)
                    throws Exception
```
    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:
    
    fullDestinationName - the full name of the JMS Destination
    
    Returns:
    
    the number of messages in the JMS Destination
    
    Throws:
    
    Exception

Class EmbeddedActiveMQBroker

Constructor Summary

Method Summary

Methods inherited from class org.junit.rules.ExternalResource

Methods inherited from class java.lang.Object

Constructor Detail

EmbeddedActiveMQBroker

EmbeddedActiveMQBroker

EmbeddedActiveMQBroker

Method Detail

configure

start

stop

before

after

createConnectionFactory

createPooledConnectionFactory

getBrokerService

getVmURL

getBrokerName

setBrokerName

isStatisticsPluginEnabled

enableStatisticsPlugin

disableStatisticsPlugin

isAdvisoryForDeliveryEnabled

enableAdvisoryForDelivery

disableAdvisoryForDelivery

isAdvisoryForConsumedEnabled

enableAdvisoryForConsumed

disableAdvisoryForConsumed

isAdvisoryForDiscardingMessagesEnabled

enableAdvisoryForDiscardingMessages

disableAdvisoryForDiscardingMessages

isAdvisoryForFastProducersEnabled

enableAdvisoryForFastProducers

disableAdvisoryForFastProducers

isAdvisoryForSlowConsumersEnabled

enableAdvisoryForSlowConsumers

disableAdvisoryForSlowConsumers

getMessageCount