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 and Description
static java.lang.String	ACCESS_TOKEN
static java.lang.String	CLIENT_READ_TIMEOUT
static java.lang.String	SERVER_URI

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

TEST_RESOURCES_PROPERTY

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method and Description
void	closeAll() Closes all test resources.
void	closeScope(java.lang.String id)
java.util.List<java.lang.String>	getRequiredProperties(java.lang.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.
java.util.List<java.lang.String>	getRequiredPropertyEntries()
default java.util.List<java.lang.String>	getResolvableProperties()
java.util.List<java.lang.String>	getResolvableProperties(java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> propertyEntries, java.util.Map<java.lang.String,java.lang.Object> testResourcesConfig) Returns the list of properties that this resolver is able to support.
java.util.Optional<java.lang.String>	resolve(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> properties, java.util.Map<java.lang.String,java.lang.Object> testResourcesConfiguration) Resolves the given property.

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

getOrder

Field Detail

SERVER_URI

static final java.lang.String SERVER_URI

See Also:

Constant Field Values

ACCESS_TOKEN

static final java.lang.String ACCESS_TOKEN

See Also:

Constant Field Values

CLIENT_READ_TIMEOUT

static final java.lang.String CLIENT_READ_TIMEOUT

See Also:

Constant Field Values

Method Detail

getResolvableProperties

@Get(value="/list")
default java.util.List<java.lang.String> getResolvableProperties()

getResolvableProperties

@Post(value="/list")
java.util.List<java.lang.String> getResolvableProperties(java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> propertyEntries,
                                                                              java.util.Map<java.lang.String,java.lang.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(value="/resolve")
java.util.Optional<java.lang.String> resolve(java.lang.String name,
                                                                     java.util.Map<java.lang.String,java.lang.Object> properties,
                                                                     java.util.Map<java.lang.String,java.lang.Object> testResourcesConfiguration)

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

testResourcesConfiguration - the test resources configuration

Returns:

the resolved property or empty if not found

getRequiredProperties

@Get(value="/requirements/expr/{expression}")
java.util.List<java.lang.String> getRequiredProperties(java.lang.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(value="/requirements/entries")
java.util.List<java.lang.String> getRequiredPropertyEntries()

Specified by:

getRequiredPropertyEntries in interface TestResourcesResolver

closeAll

@Get(value="/close/all")
void closeAll()

Closes all test resources.

closeScope

@Get(value="/close/{id}")
void closeScope(java.lang.String id)