io.arivera.oss.embedded.rabbitmq.bin

Class RabbitMqCommand

java.lang.Object

io.arivera.oss.embedded.rabbitmq.bin.RabbitMqCommand

All Implemented Interfaces:

Callable<org.zeroturnaround.exec.StartedProcess>

public class RabbitMqCommand
extends Object
implements Callable<org.zeroturnaround.exec.StartedProcess>

A generic way of executing any of the commands found under the sbin folder of the RabbitMQ installation.

Example usage:

    RabbitMqCommand command = new RabbitMqCommand(config, "rabbitmq-server", "-detached");
  StartedProcess process = command.call();
  // ...
 
 

To read the output as it happens, use the writeOutputTo(OutputStream) method.

To be notified of the process ending without blocking for the result of the finished process, use listenToEvents(ProcessListener) method.

See Also:

RabbitMqCtl, RabbitMqServer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RabbitMqCommand.ProcessExecutorFactory

Constructor Summary

Constructors

Constructor and Description
RabbitMqCommand(EmbeddedRabbitMqConfig config, String command, String... arguments) Constructs a new instance this class to execute arbitrary RabbitMQ commands with arbitrary arguments.

Method Summary

Methods

Modifier and Type	Method and Description
org.zeroturnaround.exec.StartedProcess	call()
RabbitMqCommand	listenToEvents(org.zeroturnaround.exec.listener.ProcessListener listener) Registers a unique listener to be notified of process events, such as start and finish.
RabbitMqCommand	logStandardErrorOutputAs(org.zeroturnaround.exec.stream.slf4j.Level level) Defines which logging level to use for the processes' standard error output.
RabbitMqCommand	logStandardOutputAs(org.zeroturnaround.exec.stream.slf4j.Level level) Defines which logging level to use for the process' standard output.
RabbitMqCommand	logWith(org.slf4j.Logger logger) Defines which SLF4J logger to use log the process output as it would have been dumped to STDOUT and STDERR.
RabbitMqCommand	storeOutput(boolean storeOutput) Used to define if the output of the process should be stored for retrieval after the ProcessResult future is completed.
RabbitMqCommand	writeErrorOutputTo(OutputStream outputStream) Error output from the process will be written here as it happens.
RabbitMqCommand	writeOutputTo(OutputStream outputStream) Output from the process will be written here as it happens.

Methods inherited from class java.lang.Object

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

Constructor Detail

RabbitMqCommand

public RabbitMqCommand(EmbeddedRabbitMqConfig config,
               String command,
               String... arguments)

Constructs a new instance this class to execute arbitrary RabbitMQ commands with arbitrary arguments. By default:

• the resulting processes's output will be logged using a Logger with a name matching the command. See logWith(Logger) to use another Logger
• the output from STDOUT will be logged as INFO
• the output from STDERR will e logged as WARN
• the output can be programmatically accessed by retrieving the ProcessResult from the resulting call() execution. To disable storing the output see storeOutput(boolean)

  To obtain the output as a stream as it's being produced, see writeOutputTo(OutputStream) and writeErrorOutputTo(OutputStream).

• the process' events will be ignored. See listenToEvents(ProcessListener) to define a listener.

Parameters:

config - the configuration information used to launch the process with the correct context.

command - command name, without any path or extension. For example, for a command like "rabbitmq-plugins.bat list", use "rabbitmq-plugins" as value

arguments - list of arguments to pass to the executable. For example, for a command like "./rabbitmq-plugins enable foo", utilize ["enable", "foo"] as value

Method Detail

writeOutputTo

public RabbitMqCommand writeOutputTo(OutputStream outputStream)

Output from the process will be written here as it happens.

See Also:

writeErrorOutputTo(OutputStream)

writeErrorOutputTo

public RabbitMqCommand writeErrorOutputTo(OutputStream outputStream)

Error output from the process will be written here as it happens.

See Also:

writeOutputTo(OutputStream)

logWith

public RabbitMqCommand logWith(org.slf4j.Logger logger)

Defines which SLF4J logger to use log the process output as it would have been dumped to STDOUT and STDERR.

listenToEvents

public RabbitMqCommand listenToEvents(org.zeroturnaround.exec.listener.ProcessListener listener)

Registers a unique listener to be notified of process events, such as start and finish.

storeOutput

public RabbitMqCommand storeOutput(boolean storeOutput)

Used to define if the output of the process should be stored for retrieval after the ProcessResult future is completed. Default is true

logStandardOutputAs

public RabbitMqCommand logStandardOutputAs(org.zeroturnaround.exec.stream.slf4j.Level level)

Defines which logging level to use for the process' standard output.

Default is INFO

logStandardErrorOutputAs

public RabbitMqCommand logStandardErrorOutputAs(org.zeroturnaround.exec.stream.slf4j.Level level)

Defines which logging level to use for the processes' standard error output.

Default is WARN

call

public org.zeroturnaround.exec.StartedProcess call()
                                            throws RabbitMqCommandException

Specified by:

call in interface Callable<org.zeroturnaround.exec.StartedProcess>

Throws:

RabbitMqCommandException