io.arivera.oss.embedded.rabbitmq

Class EmbeddedRabbitMqConfig.Builder

java.lang.Object

io.arivera.oss.embedded.rabbitmq.EmbeddedRabbitMqConfig.Builder

Enclosing class:

EmbeddedRabbitMqConfig

public static class EmbeddedRabbitMqConfig.Builder
extends Object

A user-friendly way to create a new EmbeddedRabbitMqConfig instance.

Example use:

 EmbeddedRabbitMqConfig config = new EmbeddedRabbitMqConfig.Builder()
      .version(...);
      .downloadFrom(...)
      ...
      .build();
 
 

See Also:

EmbeddedRabbitMqConfig

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOWNLOAD_FOLDER

Constructor Summary

Constructors

Constructor and Description
EmbeddedRabbitMqConfig.Builder() Creates a new instance of the Configuration Builder.

Method Summary

Methods

Modifier and Type	Method and Description
EmbeddedRabbitMqConfig	build() Builds an immutable instance of EmbeddedRabbitMqConfig using smart defaults.
EmbeddedRabbitMqConfig.Builder	defaultRabbitMqCtlTimeoutInMillis(long defaultRabbitMqCtlTimeoutInMillis)
EmbeddedRabbitMqConfig.Builder	deleteDownloadedFileOnErrors(boolean deleteCachedFile) If there's an issue downloading or extracting the artifact, automatically delete from downloaded file to prevent future re-use.
EmbeddedRabbitMqConfig.Builder	downloadConnectionTimeoutInMillis(long downloadConnectionTimeoutInMillis)
EmbeddedRabbitMqConfig.Builder	downloadFolder(File downloadFolder) Use this method to define a location where the compressed artifact will be downloaded to.
EmbeddedRabbitMqConfig.Builder	downloadFrom(ArtifactRepository repository) Defines where the artifact should be downloaded from and characteristics of the downloaded artifact.
EmbeddedRabbitMqConfig.Builder	downloadFrom(URL downloadSource, String appFolderName)
EmbeddedRabbitMqConfig.Builder	downloadProxy(Proxy downloadProxy)
EmbeddedRabbitMqConfig.Builder	downloadProxy(String hostname, int port)
EmbeddedRabbitMqConfig.Builder	downloadReadTimeoutInMillis(long downloadReadTimeoutInMillis)
EmbeddedRabbitMqConfig.Builder	downloadTarget(File downloadTarget) Use this method to specify a file which should be used to store the downloaded artifact.
EmbeddedRabbitMqConfig.Builder	envVar(RabbitMqEnvVar key, String value) Defines an environment variable value to use for the execution of all RabbitMQ commands.
EmbeddedRabbitMqConfig.Builder	envVar(String key, String value) Defines an environment variable value to use for the execution of all RabbitMQ commands.
EmbeddedRabbitMqConfig.Builder	envVars(Map<String,String> map) A helper method to define several variables at once.
EmbeddedRabbitMqConfig.Builder	erlangCheckTimeoutInMillis(long erlangCheckTimeoutInMillis)
EmbeddedRabbitMqConfig.Builder	extractionFolder(File extractionFolder) Define a folder where the artifact should be extracted to.
EmbeddedRabbitMqConfig.Builder	port(int port) Defines the port that this RabbitMQ broker node will run on.
EmbeddedRabbitMqConfig.Builder	processExecutorFactory(RabbitMqCommand.ProcessExecutorFactory factory)
EmbeddedRabbitMqConfig.Builder	rabbitMqServerInitializationTimeoutInMillis(long rabbitMqServerInitializationTimeoutInMillis)
EmbeddedRabbitMqConfig.Builder	randomPort() Defines the port that this RabbitMQ broker node will run on.
EmbeddedRabbitMqConfig.Builder	useCachedDownload(boolean cacheDownload) If the artifact is already present in the filesystem, setting this as {code true} will prevent re-downloading it.
EmbeddedRabbitMqConfig.Builder	version(Version version) Use a specific version of RabbitMQ.

Methods inherited from class java.lang.Object

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

Field Detail

DOWNLOAD_FOLDER

public static final String DOWNLOAD_FOLDER

See Also:

Constant Field Values

Constructor Detail

EmbeddedRabbitMqConfig.Builder

public EmbeddedRabbitMqConfig.Builder()

Creates a new instance of the Configuration Builder.

This class uses the Builder pattern where you can chain several methods and invoke build() at the end.

Method Detail

downloadReadTimeoutInMillis

@Beta
public EmbeddedRabbitMqConfig.Builder downloadReadTimeoutInMillis(long downloadReadTimeoutInMillis)

downloadConnectionTimeoutInMillis

@Beta
public EmbeddedRabbitMqConfig.Builder downloadConnectionTimeoutInMillis(long downloadConnectionTimeoutInMillis)

defaultRabbitMqCtlTimeoutInMillis

@Beta
public EmbeddedRabbitMqConfig.Builder defaultRabbitMqCtlTimeoutInMillis(long defaultRabbitMqCtlTimeoutInMillis)

rabbitMqServerInitializationTimeoutInMillis

@Beta
public EmbeddedRabbitMqConfig.Builder rabbitMqServerInitializationTimeoutInMillis(long rabbitMqServerInitializationTimeoutInMillis)

erlangCheckTimeoutInMillis

@Beta
public EmbeddedRabbitMqConfig.Builder erlangCheckTimeoutInMillis(long erlangCheckTimeoutInMillis)

downloadFrom

public EmbeddedRabbitMqConfig.Builder downloadFrom(ArtifactRepository repository)

Defines where the artifact should be downloaded from and characteristics of the downloaded artifact.

Default is OfficialArtifactRepository.RABBITMQ

See Also:

OfficialArtifactRepository

downloadFrom

public EmbeddedRabbitMqConfig.Builder downloadFrom(URL downloadSource,
                                          String appFolderName)

Parameters:

downloadSource - the URL from which to download the OS-specific artifact. For example: https://github.com/rabbitmq/rabbitmq-server/releases/download/rabbitmq_v3_6_5/rabbitmq-server-generic-unix-3.6.5.tar.xz

appFolderName - this is the name of the folder under which all application files are found. For example, rabbitmq-server-generic-unix-3.6.5.tar.xz extracts everything into to rabbitmq_server-3.6.5/*. Therefore, the value here should be "rabbitmq_server-3.6.5"

See Also:

version(Version)

version

public EmbeddedRabbitMqConfig.Builder version(Version version)

Use a specific version of RabbitMQ.

PredefinedVersion establishes the download URL using the official RabbitMQ artifact repository, the appropriate artifact type depending on the current Operating System, and information about the extraction folder. Use BaseVersion if the version you look for isn't predefined but the artifact still follows the expected distribution conventions.

Default value if none is specified: PredefinedVersion.LATEST

See Also:

downloadFrom(URL, String)

downloadFolder

public EmbeddedRabbitMqConfig.Builder downloadFolder(File downloadFolder)

Use this method to define a location where the compressed artifact will be downloaded to.

If the folder doesn't already exist, it will be created.

By default, the download folder will be: ~/".embeddedrabbitmq", while the file name will match the remote artifact's name (as defined by the download URL).

Use the downloadTarget(File) method to specify a file as destination instead of a folder, but not both.

downloadTarget

public EmbeddedRabbitMqConfig.Builder downloadTarget(File downloadTarget)

Use this method to specify a file which should be used to store the downloaded artifact.

If the file already exists, it will be overwritten.

Use downloadFolder(File) to define a folder instead of a file if necessary, but not both.

By default, the download folder will be: ~/".embeddedrabbitmq", while the file name will match the remote artifact's name (as defined by the download URL).

extractionFolder

public EmbeddedRabbitMqConfig.Builder extractionFolder(File extractionFolder)

Define a folder where the artifact should be extracted to.

By default, the artifact will be extracted to Java's Temp folder.

See Also:

SystemUtils.JAVA_IO_TMPDIR

useCachedDownload

public EmbeddedRabbitMqConfig.Builder useCachedDownload(boolean cacheDownload)

If the artifact is already present in the filesystem, setting this as {code true} will prevent re-downloading it.

Default value is true

deleteDownloadedFileOnErrors

public EmbeddedRabbitMqConfig.Builder deleteDownloadedFileOnErrors(boolean deleteCachedFile)

If there's an issue downloading or extracting the artifact, automatically delete from downloaded file to prevent future re-use.

Default value is true

envVar

public EmbeddedRabbitMqConfig.Builder envVar(String key,
                                    String value)

Defines an environment variable value to use for the execution of all RabbitMQ commands.

See Also:

RabbitMQ Environment Variables, envVar(RabbitMqEnvVar, String)

envVar

public EmbeddedRabbitMqConfig.Builder envVar(RabbitMqEnvVar key,
                                    String value)

Defines an environment variable value to use for the execution of all RabbitMQ commands.

Use envVar(String, String) to define a variable that's not predefined in the RabbitMqEnvVar enum

port

public EmbeddedRabbitMqConfig.Builder port(int port)

Defines the port that this RabbitMQ broker node will run on.

The port is defined by setting the environment variable RabbitMqEnvVar.NODE_PORT

Parameters:

port - any valid port number or -1 to use any random available port (same as randomPort())

randomPort

public EmbeddedRabbitMqConfig.Builder randomPort()

Defines the port that this RabbitMQ broker node will run on.

The port is defined by setting the environment variable RabbitMqEnvVar.NODE_PORT

envVars

public EmbeddedRabbitMqConfig.Builder envVars(Map<String,String> map)

A helper method to define several variables at once.

See Also:

envVar(String, String), envVar(RabbitMqEnvVar, String)

processExecutorFactory

public EmbeddedRabbitMqConfig.Builder processExecutorFactory(RabbitMqCommand.ProcessExecutorFactory factory)

downloadProxy

public EmbeddedRabbitMqConfig.Builder downloadProxy(String hostname,
                                           int port)

downloadProxy

public EmbeddedRabbitMqConfig.Builder downloadProxy(Proxy downloadProxy)

build

public EmbeddedRabbitMqConfig build()

Builds an immutable instance of EmbeddedRabbitMqConfig using smart defaults.