org.testifyproject

Interface ClientInstance<C,P>

Type Parameters:

C - the client type

P - the client supplier type

All Superinterfaces:

PropertiesReader, PropertiesTrait

public interface ClientInstance<C,P>
extends PropertiesReader

A contract that defines methods for retrieving information about a client and communicating with the application under test.

Author:

saden

Method Summary

Modifier and Type	Method and Description
default void	command(BiConsumer<C,P> consumer) Execute the given consumer function with the getClient() value and getClientSupplier() value as its parameters.
Application	getApplication() Get the application annotation associated with the client instance.
Instance<C>	getClient() Get client instance.
Optional<Instance<P>>	getClientSupplier() Get the client supplier instance.
String	getFqn() Get a unique fully qualified name associated with the virtual resource.
default <R> R	query(BiFunction<C,P,R> function) Execute the given function with the getClient() value and getClientSupplier() value as its parameters.

Methods inherited from interface org.testifyproject.trait.PropertiesReader

findCollection, findMap, findProperty, getPropertiesReader, getProperty

Methods inherited from interface org.testifyproject.trait.PropertiesTrait

getProperties, isEmpty

Method Detail

getFqn

String getFqn()

Get a unique fully qualified name associated with the virtual resource.

Returns:

the virtual resource's fully qualified name

getApplication

Application getApplication()

Get the application annotation associated with the client instance.

Returns:

the application annotation

getClient

Instance<C> getClient()

Get client instance.

Returns:

the client instance

getClientSupplier

Optional<Instance<P>> getClientSupplier()

Get the client supplier instance.

Returns:

optional with the client supplier, empty optional otherwise

query

default <R> R query(BiFunction<C,P,R> function)

Execute the given function with the getClient() value and getClientSupplier() value as its parameters. If client supplier is not present null will passed in as client supplier value.

Type Parameters:

R - function return type

Parameters:

function - the function

Returns:

the result of executing the function

command

default void command(BiConsumer<C,P> consumer)

Execute the given consumer function with the getClient() value and getClientSupplier() value as its parameters. If client supplier is not present null will passed in as client supplier value.

Parameters:

consumer - the consumer function