Package io.micronaut.testresources.client

Interface TestResourcesClient

All Superinterfaces:

io.micronaut.core.order.Ordered, TestResourcesResolver

All Known Implementing Classes:

DefaultTestResourcesClient

public interface TestResourcesClient
extends TestResourcesResolver

A client responsible for connecting to a test resources server.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCESS_TOKEN
static final String	CLIENT_READ_TIMEOUT
static final String	ENABLED
static final String	SERVER_URI

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

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

TEST_RESOURCES_PROPERTY

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()
default List<String>	getResolvableProperties()
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 interface io.micronaut.core.order.Ordered

getOrder

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

getDisplayName, getId

Field Details

ENABLED

static final String ENABLED

See Also:

• Constant Field Values

SERVER_URI

static final String SERVER_URI

See Also:

• Constant Field Values

ACCESS_TOKEN

static final String ACCESS_TOKEN

See Also:

• Constant Field Values

CLIENT_READ_TIMEOUT

static final String CLIENT_READ_TIMEOUT

See Also:

• Constant Field Values

Method Details

getResolvableProperties

@Get("/list")
default List<String> getResolvableProperties()

getResolvableProperties

@Post("/list")
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 TestResourcesResolver

Parameters:

propertyEntries - the property entries

testResourcesConfig - the test resources configuration

Returns:

the list of properties

resolve

@Post("/resolve")
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 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

@Get("/requirements/expr/{expression}")
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 TestResourcesResolver

Parameters:

expression - the expression which needs to be resolved.

Returns:

the list of configuration properties this resolver requires

getRequiredPropertyEntries

@Get("/requirements/entries")
List<String> getRequiredPropertyEntries()

Specified by:

getRequiredPropertyEntries in interface TestResourcesResolver

closeAll

@Get("/close/all")
boolean closeAll()

Closes all test resources.

Returns:

true if the operation was successful

closeScope

@Get("/close/{id}")
boolean closeScope(@Nullable
 @Nullable String id)

Closes a test resource scope.

Parameters:

id - the scope id

Returns:

true if the operation was successful