io.arivera.oss.embedded.rabbitmq.bin

Class RabbitMqPlugins

java.lang.Object

io.arivera.oss.embedded.rabbitmq.bin.RabbitMqPlugins

public class RabbitMqPlugins
extends Object

A wrapper around the RabbitMqCommand to execute '' commands.

See Also:

rabbitmq-plugins(1) manual page

Constructor Summary

Constructors

Constructor and Description
RabbitMqPlugins(EmbeddedRabbitMqConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
void	disable(String plugin) Disables the given plugin by executing rabbitmq-plugins disable {plugin} and blocks until the call is finished.
void	enable(String plugin) Executes the command rabbitmq-plugins enable {plugin} and blocks until the call finishes.
Future<org.zeroturnaround.exec.ProcessResult>	execute(String... arguments) This method exposes a way to invoke '' command with any arguments.
Map<Plugin.State,Set<Plugin>>	groupedList() Same as list() but it returns the plugins grouped by state.
Map<String,Plugin>	list() Executes the rabbitmq-plugins list command

Methods inherited from class java.lang.Object

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

Constructor Detail

RabbitMqPlugins

public RabbitMqPlugins(EmbeddedRabbitMqConfig config)

Method Detail

execute

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

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

For example:

 RabbitMqPlugins command = new RabbitMqPlugins(config);
 command.execute("list", "-v", "management");
 

Throws:

RabbitMqCommandException - if the command cannot be executed

groupedList

public Map<Plugin.State,Set<Plugin>> groupedList()
                                          throws RabbitMqCommandException

Same as list() but it returns the plugins grouped by state.

Throws:

RabbitMqCommandException

list

public Map<String,Plugin> list()

Executes the rabbitmq-plugins list command

Returns:

a Map where the key is the plugin name and the value is the full plugin details parsed from the output.

Throws:

RabbitMqCommandException - if the command cannot be executed, it doesn't finish in time or exits unexpectedly

See Also:

groupedList()

enable

public void enable(String plugin)
            throws RabbitMqCommandException

Executes the command rabbitmq-plugins enable {plugin} and blocks until the call finishes.

Parameters:

plugin - the name of the plugin to enable.

Throws:

RabbitMqCommandException - if the command cannot be executed, it doesn't finish in time or exits unexpectedly

disable

public void disable(String plugin)
             throws RabbitMqCommandException

Disables the given plugin by executing rabbitmq-plugins disable {plugin} and blocks until the call is finished.

Parameters:

plugin - the name of the plugin to disable.

Throws:

RabbitMqCommandException - if the command cannot be executed, it doesn't finish in time or exits unexpectedly