Package org.actioncontroller.client

Interface ApiClientExchange

All Known Implementing Classes:

FakeJakartaApiClient.FakeApiClientExchange, FakeServletClient.FakeApiClientExchange, HttpURLConnectionApiClient.ClientExchange

public interface ApiClientExchange

Abstracts a HTTP request and response from the client perspective. Can be implemented with various HTTP clients and with fake Servlet classes.

Usage example

 exchange.setTarget("GET", "/index");
 exchange.setRequestParameter("foo", "bar");

 exchange.execute();

 exchange.getResponseBody()
 

Method Summary

Modifier and Type	Method	Description
void	addRequestCookie(String name, Object value)	Sets the specified HTTP cookie value.
void	checkForError()
void	executeRequest()
String	getApiURL()	Returns the path to where the controllers paths are evaluated relative to, that is, the Servlet's context URL.
String	getPathInfo()
String	getRequestMethod()
URL	getRequestURL()
Reader	getResponseBodyReader()
InputStream	getResponseBodyStream()
int	getResponseCode()
List<String>	getResponseCookies(String name)
List<String>	getResponseHeaders(String name)
void	output(String contentType, ApiHttpExchange.OutputStreamConsumer consumer)
void	setClientCertificate(X509Certificate[] certificate)
void	setHeader(String name, Object value)
void	setPathInfo(String pathInfo)
void	setRequestParameter(String name, Object value)	Sets the specified HTTP request parameter to be included in URL query (for GET requests) or application/x-www-form-urlencoded body (for other request methods).
void	setTarget(String method, String pathInfo)
void	write(String contentType, ApiHttpExchange.WriterConsumer consumer)

Method Detail

setTarget

void setTarget(String method,
               String pathInfo)

getRequestMethod

String getRequestMethod()

getPathInfo

String getPathInfo()

setPathInfo

void setPathInfo(String pathInfo)

getRequestURL

URL getRequestURL()

setRequestParameter

void setRequestParameter(String name,
                         Object value)

Sets the specified HTTP request parameter to be included in URL query (for GET requests) or application/x-www-form-urlencoded body (for other request methods).

Parameters:

name - Name of the HTTP request parameter to set

value - If null or Optional.empty, parameter will be unset; if Optional, value will be extracted

getApiURL

String getApiURL()

Returns the path to where the controllers paths are evaluated relative to, that is, the Servlet's context URL. For example, if an ApiServlet is bound as "/api/*" in a webapp mounted at "/app", getApiURL might return https://example.com:7443/app/api.

addRequestCookie

void addRequestCookie(String name,
                      Object value)

Sets the specified HTTP cookie value. The cookie value will be URL encoded before sent in the Cookie-header

Parameters:

name - Name of the HTTP cookie to set

value - If null or Optional.empty, cookie will be unset; if Optional, value will be extracted

setHeader

void setHeader(String name,
               Object value)

executeRequest

void executeRequest()
             throws IOException

Throws:

IOException

getResponseCode

int getResponseCode()
             throws IOException

Throws:

IOException

getResponseHeaders

List<String> getResponseHeaders(String name)

getResponseCookies

List<String> getResponseCookies(String name)

getResponseBodyReader

Reader getResponseBodyReader()
                      throws IOException

Throws:

IOException

getResponseBodyStream

InputStream getResponseBodyStream()
                           throws IOException

Throws:

IOException

checkForError

void checkForError()
            throws HttpClientException,
                   IOException

Throws:

HttpClientException

IOException

setClientCertificate

void setClientCertificate(X509Certificate[] certificate)

write

void write(String contentType,
           ApiHttpExchange.WriterConsumer consumer)
    throws IOException

Throws:

IOException

output

void output(String contentType,
            ApiHttpExchange.OutputStreamConsumer consumer)
     throws IOException

Throws:

IOException