BrokerRunningSupport (Spring AMQP 2.2.12.RELEASE API)

java.lang.Object
- org.springframework.amqp.rabbit.junit.BrokerRunningSupport

```
public final class BrokerRunningSupport
extends Object
```
A class that can be used to prevent integration tests from failing if the Rabbit broker application is not running or not accessible. If the Rabbit broker is not running in the background all the tests here will simply be skipped (by default) because of a violated assumption (showing as successful).
If you wish to enforce the broker being available, for example, on a CI server, set the environment variable "RABBITMQ_SERVER_REQUIRED" to true and the tests will fail fast.

Since:

2.2

Author:

Dave Syer, Gary Russell

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`BrokerRunningSupport.BrokerNotAliveException` The `RuntimeException` thrown when broker is not available on the provided host port.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BROKER_ADMIN_PW`
`static String`	`BROKER_ADMIN_URI`
`static String`	`BROKER_ADMIN_USER`
`static String`	`BROKER_HOSTNAME`
`static String`	`BROKER_PORT`
`static String`	`BROKER_PW`
`static String`	`BROKER_REQUIRED`
`static String`	`BROKER_USER`
`static String`	`DEFAULT_QUEUE_NAME`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`clearEnvironmentVariableOverrides()` Clear any environment variable overrides set in `setEnvironmentVariableOverrides(Map)`.
`void`	`deleteExchanges(String... exchanges)` Delete arbitrary exchanges from the broker.
`void`	`deleteQueues(String... queuesToDelete)` Delete arbitrary queues from the broker.
`static boolean`	`fatal()`
`String`	`generateId()` Generate the connection id for the connection used by the rule's connection factory.
`String`	`getAdminPassword()` Return the admin password.
`String`	`getAdminUri()` Return the admin uri.
`String`	`getAdminUser()` Return the admin user.
`com.rabbitmq.client.ConnectionFactory`	`getConnectionFactory()` Get the connection factory used by this rule.
`String`	`getHostName()` Return the port.
`String`	`getPassword()` Return the password.
`int`	`getPort()` Return the port.
`String`	`getUser()` Return the user.
`static BrokerRunningSupport`	`isBrokerAndManagementRunning()`
`static BrokerRunningSupport`	`isBrokerAndManagementRunningWithEmptyQueues(String... queues)`
`static BrokerRunningSupport`	`isNotRunning()`
`boolean`	`isPurgeAfterEach()`
`static BrokerRunningSupport`	`isRunning()`
`static BrokerRunningSupport`	`isRunningWithEmptyQueues(String... names)` Ensure the broker is running and has a empty queue(s) with the specified name(s) in the default exchange.
`void`	`purgeTestQueues()` Delete and re-declare all the configured queues.
`void`	`removeTestQueues(String... additionalQueues)` Remove any test queues that were created by an `isRunningWithEmptyQueues(String...)` method.
`void`	`setAdminPassword(String password)` Set the password for the management REST API connection default "guest".
`void`	`setAdminUri(String adminUri)` Set the uri for the REST API.
`void`	`setAdminUser(String user)` Set the user for the management REST API connection default "guest".
`static void`	`setEnvironmentVariableOverrides(Map<String,String> environmentVariables)` Set environment variable overrides for host, port etc.
`void`	`setHostName(String hostName)`
`void`	`setPassword(String password)` Set the password for the amqp connection default "guest".
`void`	`setPort(int port)`
`void`	`setPurgeAfterEach(boolean purgeAfterEach)` Purge the test queues after each test (JUnit 5).
`void`	`setUser(String user)` Set the user for the amqp connection default "guest".
`void`	`test()` Check connectivity to the broker and create any queues.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BROKER_ADMIN_URI
```
public static final String BROKER_ADMIN_URI
```
    See Also:
    
    Constant Field Values
  - BROKER_HOSTNAME
```
public static final String BROKER_HOSTNAME
```
    See Also:
    
    Constant Field Values
  - BROKER_PORT
```
public static final String BROKER_PORT
```
    See Also:
    
    Constant Field Values
  - BROKER_USER
```
public static final String BROKER_USER
```
    See Also:
    
    Constant Field Values
  - BROKER_PW
```
public static final String BROKER_PW
```
    See Also:
    
    Constant Field Values
  - BROKER_ADMIN_USER
```
public static final String BROKER_ADMIN_USER
```
    See Also:
    
    Constant Field Values
  - BROKER_ADMIN_PW
```
public static final String BROKER_ADMIN_PW
```
    See Also:
    
    Constant Field Values
  - BROKER_REQUIRED
```
public static final String BROKER_REQUIRED
```
    See Also:
    
    Constant Field Values
  - DEFAULT_QUEUE_NAME
```
public static final String DEFAULT_QUEUE_NAME
```
- Method Detail
  - setEnvironmentVariableOverrides
```
public static void setEnvironmentVariableOverrides(Map<String,String> environmentVariables)
```
    Set environment variable overrides for host, port etc. Will override any real environment variables, if present.
    The variables will only apply to rule instances that are created after this method is called. The overrides will remain until
    
    Parameters:
    
    environmentVariables - the variables.
  - clearEnvironmentVariableOverrides
```
public static void clearEnvironmentVariableOverrides()
```
    Clear any environment variable overrides set in setEnvironmentVariableOverrides(Map).
  - isRunningWithEmptyQueues
```
public static BrokerRunningSupport isRunningWithEmptyQueues(String... names)
```
    Ensure the broker is running and has a empty queue(s) with the specified name(s) in the default exchange.
    
    Parameters:
    
    names - the queues to declare for the test.
    
    Returns:
    
    a new rule that assumes an existing running broker
  - isRunning
```
public static BrokerRunningSupport isRunning()
```
    Returns:
    
    a new rule that assumes an existing running broker
  - isNotRunning
```
public static BrokerRunningSupport isNotRunning()
```
    Returns:
    
    a new rule that assumes there is no existing broker
  - isBrokerAndManagementRunning
```
public static BrokerRunningSupport isBrokerAndManagementRunning()
```
    Returns:
    
    a new rule that assumes an existing broker with the management plugin
  - isBrokerAndManagementRunningWithEmptyQueues
```
public static BrokerRunningSupport isBrokerAndManagementRunningWithEmptyQueues(String... queues)
```
    Parameters:
    
    queues - the queues.
    
    Returns:
    
    a new rule that assumes an existing broker with the management plugin with the provided queues declared (and emptied if needed)..
  - setPort
```
public void setPort(int port)
```
    Parameters:
    
    port - the port to set
  - setHostName
```
public void setHostName(String hostName)
```
    Parameters:
    
    hostName - the hostName to set
  - setUser
```
public void setUser(String user)
```
    Set the user for the amqp connection default "guest".
    
    Parameters:
    
    user - the user.
  - setPassword
```
public void setPassword(String password)
```
    Set the password for the amqp connection default "guest".
    
    Parameters:
    
    password - the password.
  - setAdminUri
```
public void setAdminUri(String adminUri)
```
    Set the uri for the REST API.
    
    Parameters:
    
    adminUri - the uri.
  - setAdminUser
```
public void setAdminUser(String user)
```
    Set the user for the management REST API connection default "guest".
    
    Parameters:
    
    user - the user.
  - setAdminPassword
```
public void setAdminPassword(String password)
```
    Set the password for the management REST API connection default "guest".
    
    Parameters:
    
    password - the password.
  - getPort
```
public int getPort()
```
    Return the port.
    
    Returns:
    
    the port.
  - getHostName
```
public String getHostName()
```
    Return the port.
    
    Returns:
    
    the port.
  - getUser
```
public String getUser()
```
    Return the user.
    
    Returns:
    
    the user.
  - getPassword
```
public String getPassword()
```
    Return the password.
    
    Returns:
    
    the password.
  - getAdminUser
```
public String getAdminUser()
```
    Return the admin user.
    
    Returns:
    
    the user.
  - getAdminPassword
```
public String getAdminPassword()
```
    Return the admin password.
    
    Returns:
    
    the password.
  - isPurgeAfterEach
```
public boolean isPurgeAfterEach()
```
  - setPurgeAfterEach
```
public void setPurgeAfterEach(boolean purgeAfterEach)
```
    Purge the test queues after each test (JUnit 5).
    
    Parameters:
    
    purgeAfterEach - true to purge.
  - test
```
public void test()
          throws BrokerRunningSupport.BrokerNotAliveException
```
    Check connectivity to the broker and create any queues.
    
    Throws:
    
    BrokerRunningSupport.BrokerNotAliveException - if the broker is not available.
  - fatal
```
public static boolean fatal()
```
  - generateId
```
public String generateId()
```
    Generate the connection id for the connection used by the rule's connection factory.
    
    Returns:
    
    the id.
  - removeTestQueues
```
public void removeTestQueues(String... additionalQueues)
```
    Remove any test queues that were created by an isRunningWithEmptyQueues(String...) method.
    
    Parameters:
    
    additionalQueues - additional queues to remove that might have been created by tests.
  - purgeTestQueues
```
public void purgeTestQueues()
```
    Delete and re-declare all the configured queues. Can be used between tests when a test might leave stale data and multiple tests use the same queue.
  - deleteQueues
```
public void deleteQueues(String... queuesToDelete)
```
    Delete arbitrary queues from the broker.
    
    Parameters:
    
    queuesToDelete - the queues to delete.
  - deleteExchanges
```
public void deleteExchanges(String... exchanges)
```
    Delete arbitrary exchanges from the broker.
    
    Parameters:
    
    exchanges - the exchanges to delete.
  - getConnectionFactory
```
public com.rabbitmq.client.ConnectionFactory getConnectionFactory()
```
    Get the connection factory used by this rule.
    
    Returns:
    
    the connection factory.
  - getAdminUri
```
public String getAdminUri()
```
    Return the admin uri.
    
    Returns:
    
    the uri.

Class BrokerRunningSupport

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BROKER_ADMIN_URI

BROKER_HOSTNAME

BROKER_PORT

BROKER_USER

BROKER_PW

BROKER_ADMIN_USER

BROKER_ADMIN_PW

BROKER_REQUIRED

DEFAULT_QUEUE_NAME

Method Detail

setEnvironmentVariableOverrides

clearEnvironmentVariableOverrides

isRunningWithEmptyQueues

isRunning

isNotRunning

isBrokerAndManagementRunning

isBrokerAndManagementRunningWithEmptyQueues

setPort

setHostName

setUser

setPassword

setAdminUri

setAdminUser

setAdminPassword

getPort

getHostName

getUser

getPassword

getAdminUser

getAdminPassword

isPurgeAfterEach

setPurgeAfterEach

test

fatal

generateId

removeTestQueues

purgeTestQueues

deleteQueues

deleteExchanges

getConnectionFactory

getAdminUri