org.testifyproject

Interface ClientProvider<T,C,P>

Type Parameters:

T - the client configuration type

C - the client type

P - the client supplier type, should be if not applicable Void

public interface ClientProvider<T,C,P>

A contract that defines methods for configuring, initializing and destroying a client used to communicate with the server.

Author:

saden

Method Summary

Modifier and Type	Method and Description
T	configure(TestContext testContext, Application application, URI baseURI) Configure the client using the given server instance.
ClientInstance<C,P>	create(TestContext testContext, Application application, URI baseURI, T configuration) Create and initialize the client instance using the given base URI and configuration object.
void	destroy(ClientInstance<C,P> clientInstance) This method will dispose of client instance that was created.
default Class<P>	getClientSupplierType() The type of client supplier.
Class<C>	getClientType() The type of the client.

Method Detail

configure

T configure(TestContext testContext,
            Application application,
            URI baseURI)

Configure the client using the given server instance.

Parameters:

testContext - the test context

application - the application annotation

baseURI - the base server URI

Returns:

client configuration object

create

ClientInstance<C,P> create(TestContext testContext,
                           Application application,
                           URI baseURI,
                           T configuration)

Create and initialize the client instance using the given base URI and configuration object.

Parameters:

testContext - the test context

application - the application annotation

baseURI - the base server URI

configuration - client configuration object

Returns:

a client instance.

destroy

void destroy(ClientInstance<C,P> clientInstance)

This method will dispose of client instance that was created.

Parameters:

clientInstance - the client instance to dispose of

getClientType

Class<C> getClientType()

The type of the client.

Returns:

the client type.

getClientSupplierType

default Class<P> getClientSupplierType()

The type of client supplier. If a client supplier is not applicable this method returns null;

Returns:

the client supplier type.