org.testifyproject

Interface ServerInstance<T>

Type Parameters:

T - the underlying server instance type.

All Superinterfaces:

PropertiesReader, PropertiesTrait

public interface ServerInstance<T>
extends PropertiesReader

A contract that defines methods for retrieving information about the running server.

Author:

saden

Method Summary

Modifier and Type	Method and Description
default void	command(BiConsumer<T,URI> consumer) Execute the given consumer function with the getServer() value and getBaseURI() as its parameters.
Application	getApplication() Get the application annotation associated with the server instance.
URI	getBaseURI() The server base URI.
String	getFqn() Get a unique fully qualified name associated with the server instance.
Instance<T>	getServer() Get the underlying server instance.
default <R> R	query(BiFunction<T,URI,R> function) Execute the given function with the getServer() value and getBaseURI() 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 server instance.

Returns:

the server instance's fully qualified name

getApplication

Application getApplication()

Get the application annotation associated with the server instance.

Returns:

the application annotation

getBaseURI

URI getBaseURI()

The server base URI.

Returns:

the base URI

getServer

Instance<T> getServer()

Get the underlying server instance.

Returns:

the underlying server instance

query

default <R> R query(BiFunction<T,URI,R> function)

Execute the given function with the getServer() value and getBaseURI() as its parameters.

Type Parameters:

R - function return type

Parameters:

function - the function

Returns:

the result of executing the function

command

default void command(BiConsumer<T,URI> consumer)

Execute the given consumer function with the getServer() value and getBaseURI() as its parameters.

Parameters:

consumer - the consumer function