Package org.testcontainers.hivemq

Class HiveMQExtension.Builder

java.lang.Object

org.testcontainers.hivemq.HiveMQExtension.Builder

Enclosing class:

HiveMQExtension

public static final class HiveMQExtension.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
@NotNull HiveMQExtension.Builder	addAdditionalClass(@NotNull Class<?> clazz)	Adds an additional class to the .jar file of the HiveMQExtension.
@NotNull HiveMQExtension	build()	Builds the HiveMQExtension with the provided values or default values.
@NotNull HiveMQExtension.Builder	disabledOnStartup(boolean disabledOnStartup)	Flag, that indicates whether the HiveMQExtension should be disabled when HiveMQ starts.
@NotNull HiveMQExtension.Builder	id(@NotNull String id)	Sets the identifier of the HiveMQExtension.
@NotNull HiveMQExtension.Builder	mainClass(@NotNull Class<?> mainClass)	The main class of the HiveMQExtension.
@NotNull HiveMQExtension.Builder	name(@NotNull String name)	Sets the name of the HiveMQExtension.
@NotNull HiveMQExtension.Builder	priority(int priority)	Sets the priority of the HiveMQExtension.
@NotNull HiveMQExtension.Builder	startPriority(int startPriority)	Sets the start-priority of the HiveMQExtension.
@NotNull HiveMQExtension.Builder	version(@NotNull String version)	Sets the version of the HiveMQExtension.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

build

@NotNull
public @NotNull HiveMQExtension build()

Builds the HiveMQExtension with the provided values or default values.

Returns:

the HiveMQ Extension

id

@NotNull
public @NotNull HiveMQExtension.Builder id(@NotNull
 @NotNull String id)

Sets the identifier of the HiveMQExtension.

Parameters:

id - the identifier, must not be empty

Returns:

the HiveMQExtension.Builder

name

@NotNull
public @NotNull HiveMQExtension.Builder name(@NotNull
 @NotNull String name)

Sets the name of the HiveMQExtension.

Parameters:

name - the identifier, must not be empty

Returns:

the HiveMQExtension.Builder

version

@NotNull
public @NotNull HiveMQExtension.Builder version(@NotNull
 @NotNull String version)

Sets the version of the HiveMQExtension.

Parameters:

version - the version, must not be empty

Returns:

the HiveMQExtension.Builder

priority

@NotNull
public @NotNull HiveMQExtension.Builder priority(int priority)

Sets the priority of the HiveMQExtension.

Parameters:

priority - the priority

Returns:

the HiveMQExtension.Builder

startPriority

@NotNull
public @NotNull HiveMQExtension.Builder startPriority(int startPriority)

Sets the start-priority of the HiveMQExtension.

Parameters:

startPriority - the start-priority

Returns:

the HiveMQExtension.Builder

disabledOnStartup

@NotNull
public @NotNull HiveMQExtension.Builder disabledOnStartup(boolean disabledOnStartup)

Flag, that indicates whether the HiveMQExtension should be disabled when HiveMQ starts. Disabling on startup is achieved by placing a DISABLED file in the HiveMQExtension's directory before coping it to the container.

Parameters:

disabledOnStartup - if the HiveMQExtension should be disabled when HiveMQ starts

Returns:

the HiveMQExtension.Builder

mainClass

@NotNull
public @NotNull HiveMQExtension.Builder mainClass(@NotNull
 @NotNull Class<?> mainClass)

The main class of the HiveMQExtension. This class MUST implement com.hivemq.extension.sdk.api.ExtensionMain.

Parameters:

mainClass - the main class

Returns:

the HiveMQExtension.Builder

Throws:

IllegalArgumentException - if the provides class does not implement com.hivemq.extension.sdk.api.ExtensionMain}

IllegalStateException - if com.hivemq.extension.sdk.api.ExtensionMain is not found in the classpath

addAdditionalClass

@NotNull
public @NotNull HiveMQExtension.Builder addAdditionalClass(@NotNull
 @NotNull Class<?> clazz)

Adds an additional class to the .jar file of the HiveMQExtension.

Parameters:

clazz - the additional class

Returns:

the HiveMQExtension.Builder