io.arivera.oss.embedded.rabbitmq.bin

Class RabbitMqCtl

java.lang.Object

io.arivera.oss.embedded.rabbitmq.bin.RabbitMqCtl

public class RabbitMqCtl
extends Object

This is a wrapper around RabbitMqCommand to make it easier to execute ""rabbitmqctl"" commands.

The methods contained in this class aren't exhaustive. Please refer to the manual for a complete list.

See Also:

rabbitmqctl(1) manual page

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMAND

Constructor Summary

Constructors

Constructor and Description
RabbitMqCtl(EmbeddedRabbitMqConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
Future<org.zeroturnaround.exec.ProcessResult>	execute(String... arguments) This method exposes a way to invoke "rabbitmqctl" with any arguments.
Future<org.zeroturnaround.exec.ProcessResult>	forceReset() Forcefully return a RabbitMQ node to its virgin state.
Future<org.zeroturnaround.exec.ProcessResult>	reset() Return a RabbitMQ node to its virgin state.
Future<org.zeroturnaround.exec.ProcessResult>	startApp() Starts the RabbitMQ application.
Future<org.zeroturnaround.exec.ProcessResult>	stop() Stops the Erlang node on which RabbitMQ is running.
Future<org.zeroturnaround.exec.ProcessResult>	stopApp() Stops the RabbitMQ application, leaving the Erlang node running.

Methods inherited from class java.lang.Object

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

Field Detail

COMMAND

public static final String COMMAND

See Also:

Constant Field Values

Constructor Detail

RabbitMqCtl

public RabbitMqCtl(EmbeddedRabbitMqConfig config)

Method Detail

execute

public Future<org.zeroturnaround.exec.ProcessResult> execute(String... arguments)
                                                      throws RabbitMqCommandException

This method exposes a way to invoke "rabbitmqctl" with any arguments. This is useful when the class methods don't expose the desired functionality.

For example:

 RabbitMqCtl command = new RabbitMqCtl(config);
 command.execute("list_users");
 

Throws:

RabbitMqCommandException

stop

public Future<org.zeroturnaround.exec.ProcessResult> stop()
                                                   throws RabbitMqCommandException

Stops the Erlang node on which RabbitMQ is running.

Throws:

RabbitMqCommandException

stopApp

public Future<org.zeroturnaround.exec.ProcessResult> stopApp()
                                                      throws RabbitMqCommandException

Stops the RabbitMQ application, leaving the Erlang node running.

This command is typically run prior to performing other management actions that require the RabbitMQ application to be stopped, e.g. reset().

Throws:

RabbitMqCommandException

startApp

public Future<org.zeroturnaround.exec.ProcessResult> startApp()
                                                       throws RabbitMqCommandException

Starts the RabbitMQ application.

This command is typically run after performing other management actions that required the RabbitMQ application to be stopped, e.g. reset().

Throws:

RabbitMqCommandException

reset

public Future<org.zeroturnaround.exec.ProcessResult> reset()
                                                    throws RabbitMqCommandException

Return a RabbitMQ node to its virgin state.

Removes the node from any cluster it belongs to, removes all data from the management database, such as configured users and vhosts, and deletes all persistent messages.

For reset and force_reset to succeed the RabbitMQ application must have been stopped, e.g. with stopApp()

Throws:

RabbitMqCommandException

forceReset

public Future<org.zeroturnaround.exec.ProcessResult> forceReset()
                                                         throws RabbitMqCommandException

Forcefully return a RabbitMQ node to its virgin state.

The force_reset command differs from reset in that it resets the node unconditionally, regardless of the current management database state and cluster configuration. It should only be used as a last resort if the database or cluster configuration has been corrupted.

For reset and force_reset to succeed the RabbitMQ application must have been stopped, e.g. with stopApp()

Throws:

RabbitMqCommandException