Package io.micronaut.testresources.client

Class DefaultTestResourcesClient

java.lang.Object

io.micronaut.testresources.client.DefaultTestResourcesClient

All Implemented Interfaces:

io.micronaut.core.order.Ordered, TestResourcesClient, TestResourcesResolver

@Internal
public class DefaultTestResourcesClient
extends Object
implements TestResourcesClient

A simple implementation of the test resources client.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCESS_TOKEN

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Fields inherited from interface io.micronaut.testresources.client.TestResourcesClient

CLIENT_READ_TIMEOUT, ENABLED, SERVER_URI

Fields inherited from interface io.micronaut.testresources.core.TestResourcesResolver

TEST_RESOURCES_PROPERTY

Constructor Summary

Constructors

Constructor	Description
DefaultTestResourcesClient(String baseUri, String accessToken, int clientReadTimeout)

Method Summary

Modifier and Type	Method	Description
boolean	closeAll()	Closes all test resources.
boolean	closeScope(@Nullable String id)	Closes a test resource scope.
List<String>	getRequiredProperties(String expression)	Returns the list of properties which should be read before resolving an expression: this can be used if the resolver itself needs some configuration properties.
List<String>	getRequiredPropertyEntries()
List<String>	getResolvableProperties(Map<String,Collection<String>> propertyEntries, Map<String,Object> testResourcesConfig)	Returns the list of properties that this resolver is able to support.
Optional<String>	resolve(String name, Map<String,Object> properties, Map<String,Object> testResourcesConfig)	Resolves the given property.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.core.order.Ordered

getOrder

Methods inherited from interface io.micronaut.testresources.client.TestResourcesClient

getResolvableProperties

Methods inherited from interface io.micronaut.testresources.core.TestResourcesResolver

getDisplayName, getId

Field Details

ACCESS_TOKEN

public static final String ACCESS_TOKEN

See Also:

• Constant Field Values

Constructor Details

DefaultTestResourcesClient

public DefaultTestResourcesClient(String baseUri,
 String accessToken,
 int clientReadTimeout)

Method Details

getResolvableProperties

public List<String> getResolvableProperties(Map<String,Collection<String>> propertyEntries,
 Map<String,Object> testResourcesConfig)

Description copied from interface: TestResourcesResolver

Returns the list of properties that this resolver is able to support. The property entries map is a map which keys are the property entries retrieved from calling TestResourcesResolver.getRequiredPropertyEntries() and values are those property entries resolved.

Specified by:

getResolvableProperties in interface TestResourcesClient

Specified by:

getResolvableProperties in interface TestResourcesResolver

Parameters:

propertyEntries - the property entries

testResourcesConfig - the test resources configuration

Returns:

the list of properties

resolve

public Optional<String> resolve(String name,
 Map<String,Object> properties,
 Map<String,Object> testResourcesConfig)

Description copied from interface: TestResourcesResolver

Resolves the given property.

Specified by:

resolve in interface TestResourcesClient

Specified by:

resolve in interface TestResourcesResolver

Parameters:

name - the property to resolve

properties - the resolved required properties

testResourcesConfig - the test resources configuration

Returns:

the resolved property or empty if not found

getRequiredProperties

public List<String> getRequiredProperties(String expression)

Description copied from interface: TestResourcesResolver

Returns the list of properties which should be read before resolving an expression: this can be used if the resolver itself needs some configuration properties.

Specified by:

getRequiredProperties in interface TestResourcesClient

Specified by:

getRequiredProperties in interface TestResourcesResolver

Parameters:

expression - the expression which needs to be resolved.

Returns:

the list of configuration properties this resolver requires

getRequiredPropertyEntries

public List<String> getRequiredPropertyEntries()

Specified by:

getRequiredPropertyEntries in interface TestResourcesClient

Specified by:

getRequiredPropertyEntries in interface TestResourcesResolver

closeAll

public boolean closeAll()

Description copied from interface: TestResourcesClient

Closes all test resources.

Specified by:

closeAll in interface TestResourcesClient

Returns:

true if the operation was successful

closeScope

public boolean closeScope(@Nullable
 @Nullable String id)

Description copied from interface: TestResourcesClient

Closes a test resource scope.

Specified by:

closeScope in interface TestResourcesClient

Parameters:

id - the scope id

Returns:

true if the operation was successful