Package org.sdase.commons.server.testing

Class DropwizardConfigurationHelper<C extends io.dropwizard.Configuration>

java.lang.Object

org.sdase.commons.server.testing.DropwizardConfigurationHelper<C>

Type Parameters:

C - the type of the Configuration used by an Application

All Implemented Interfaces:

ConfigurationBuilders.CustomizationBuilder<C>, ConfigurationBuilders.PortBuilder<C>

@Deprecated(forRemoval=true)
public class DropwizardConfigurationHelper<C extends io.dropwizard.Configuration>
extends java.lang.Object
implements ConfigurationBuilders.PortBuilder<C>, ConfigurationBuilders.CustomizationBuilder<C>

Deprecated, for removal: This API element is subject to removal in a future version.

Since this class was only used in conjunction with the WeldAppExtension, it is no longer of use and will be removed in the next major release.

A helper that creates a Configuration programmatically.

Method Summary

Modifier and Type	Method	Description
C	build()	Deprecated, for removal: This API element is subject to removal in a future version.
static <C1 extends io.dropwizard.Configuration> ConfigurationBuilders.PortBuilder<C1>	configFrom(java.util.function.Supplier<C1> configurationSupplier)	Deprecated, for removal: This API element is subject to removal in a future version.
ConfigurationBuilders.CustomizationBuilder<C>	withConfigurationModifier(java.util.function.Consumer<C> configurationCustomizer)	Deprecated, for removal: This API element is subject to removal in a future version. Allows to customize the configuration programmatically.
ConfigurationBuilders.CustomizationBuilder<C>	withPorts(int applicationPort, int adminPort)	Deprecated, for removal: This API element is subject to removal in a future version. Sets the given ports as fixed ports.
ConfigurationBuilders.CustomizationBuilder<C>	withRandomPorts()	Deprecated, for removal: This API element is subject to removal in a future version. Configures random application port and the admin port.
ConfigurationBuilders.CustomizationBuilder<C>	withRootPath(java.lang.String rootPath)	Deprecated, for removal: This API element is subject to removal in a future version. Sets the jersey root path, referenced in the config.yaml as

Methods inherited from class java.lang.Object

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

Method Detail

configFrom

public static <C1 extends io.dropwizard.Configuration> ConfigurationBuilders.PortBuilder<C1> configFrom(java.util.function.Supplier<C1> configurationSupplier)

Deprecated, for removal: This API element is subject to removal in a future version.

Type Parameters:

C1 - the type of the Configuration used by an Application

Parameters:

configurationSupplier - a supplier that creates the initial Configuration, e.g. MyAppConfig::new

Returns:

a builder for programmatic configuration

withConfigurationModifier

public ConfigurationBuilders.CustomizationBuilder<C> withConfigurationModifier(java.util.function.Consumer<C> configurationCustomizer)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: ConfigurationBuilders.CustomizationBuilder

Allows to customize the configuration programmatically.

Specified by:

withConfigurationModifier in interface ConfigurationBuilders.CustomizationBuilder<C extends io.dropwizard.Configuration>

Parameters:

configurationCustomizer - a consumer that receives the current Configuration of type C to modify it's internals

Returns:

a builder for further configuration

withRootPath

public ConfigurationBuilders.CustomizationBuilder<C> withRootPath(java.lang.String rootPath)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: ConfigurationBuilders.CustomizationBuilder

Sets the jersey root path, referenced in the config.yaml as

   server:
     rootPath: /*
 

Specified by:

withRootPath in interface ConfigurationBuilders.CustomizationBuilder<C extends io.dropwizard.Configuration>

Parameters:

rootPath - the path to set as root of the API

Returns:

the builder instance

withRandomPorts

public ConfigurationBuilders.CustomizationBuilder<C> withRandomPorts()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: ConfigurationBuilders.PortBuilder

Configures random application port and the admin port. This settings is equal to setting the connector ports in the configuration yaml to 0

Specified by:

withRandomPorts in interface ConfigurationBuilders.PortBuilder<C extends io.dropwizard.Configuration>

Returns:

the builder instance

withPorts

public ConfigurationBuilders.CustomizationBuilder<C> withPorts(int applicationPort,
                                                               int adminPort)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: ConfigurationBuilders.PortBuilder

Sets the given ports as fixed ports. This settings is equal to setting the connector ports in the configuration yaml to the given ports.

Specified by:

withPorts in interface ConfigurationBuilders.PortBuilder<C extends io.dropwizard.Configuration>

Parameters:

applicationPort - the port the application connector listens to

adminPort - the port the admin connector listens to

Returns:

the builder instance

build

public C build()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

build in interface ConfigurationBuilders.CustomizationBuilder<C extends io.dropwizard.Configuration>

Returns:

the Configuration of type C created with this builder