Package org.actioncontroller.client

Class HttpURLConnectionApiClient.ClientExchange

java.lang.Object

org.actioncontroller.client.HttpURLConnectionApiClient.ClientExchange

All Implemented Interfaces:

ApiClientExchange

Enclosing class:

HttpURLConnectionApiClient

protected class HttpURLConnectionApiClient.ClientExchange
extends Object
implements ApiClientExchange

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ClientExchange()

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	getContentType()
String	getPathInfo()
String	getRequestMethod()
String	getRequestUrl()
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	setContentType(String contentType)
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)
String	toString()
void	write(String contentType, ApiHttpExchange.WriterConsumer consumer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ClientExchange

protected ClientExchange()

Method Detail

setTarget

public void setTarget(String method,
                      String pathInfo)

Specified by:

setTarget in interface ApiClientExchange

setClientCertificate

public void setClientCertificate(X509Certificate[] certificate)

Specified by:

setClientCertificate in interface ApiClientExchange

getRequestMethod

public String getRequestMethod()

Specified by:

getRequestMethod in interface ApiClientExchange

getPathInfo

public String getPathInfo()

Specified by:

getPathInfo in interface ApiClientExchange

getApiURL

public String getApiURL()

Description copied from interface: ApiClientExchange

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.

Specified by:

getApiURL in interface ApiClientExchange

setPathInfo

public void setPathInfo(String pathInfo)

Specified by:

setPathInfo in interface ApiClientExchange

getRequestURL

public URL getRequestURL()

Specified by:

getRequestURL in interface ApiClientExchange

setRequestParameter

public void setRequestParameter(String name,
                                Object value)

Description copied from interface: ApiClientExchange

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).

Specified by:

setRequestParameter in interface ApiClientExchange

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

addRequestCookie

public void addRequestCookie(String name,
                             Object value)

Description copied from interface: ApiClientExchange

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

Specified by:

addRequestCookie in interface ApiClientExchange

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

public void setHeader(String name,
                      Object value)

Specified by:

setHeader in interface ApiClientExchange

executeRequest

public void executeRequest()
                    throws IOException

Specified by:

executeRequest in interface ApiClientExchange

Throws:

IOException

getRequestUrl

public String getRequestUrl()

getResponseCode

public int getResponseCode()
                    throws IOException

Specified by:

getResponseCode in interface ApiClientExchange

Throws:

IOException

getResponseHeaders

public List<String> getResponseHeaders(String name)

Specified by:

getResponseHeaders in interface ApiClientExchange

checkForError

public void checkForError()
                   throws HttpClientException,
                          IOException

Specified by:

checkForError in interface ApiClientExchange

Throws:

HttpClientException

IOException

getResponseCookies

public List<String> getResponseCookies(String name)

Specified by:

getResponseCookies in interface ApiClientExchange

getResponseBodyReader

public Reader getResponseBodyReader()
                             throws IOException

Specified by:

getResponseBodyReader in interface ApiClientExchange

Throws:

IOException

getResponseBodyStream

public InputStream getResponseBodyStream()
                                  throws IOException

Specified by:

getResponseBodyStream in interface ApiClientExchange

Throws:

IOException

write

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

Specified by:

write in interface ApiClientExchange

Throws:

IOException

output

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

Specified by:

output in interface ApiClientExchange

Throws:

IOException

setContentType

public void setContentType(String contentType)

getContentType

public String getContentType()

toString

public String toString()

Overrides:

toString in class Object