Package org.actioncontroller

Interface ApiHttpExchange

All Known Implementing Classes:

JakartaServletHttpExchange, JdkHttpExchange, ServletHttpExchange, SocketHttpExchange

public interface ApiHttpExchange

Abstracts the interaction with the http request and response. This interface acts as an abstraction that enables Action Controller to work both with both the servlet API and HttpServer. ApiHttpExchange also provides convenience methods used by several HttpParameterMapper and HttpReturnMapping implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ApiHttpExchange.OutputStreamConsumer
static interface	ApiHttpExchange.WriterConsumer

Method Summary

Modifier and Type	Method	Description
default boolean	accept(String contentType)	Returns true if the "Accept" request header matches the argument content type
void	addResponseHeader(String key, String value)
void	authenticate()
Map<String,List<String>>	getAllHeaders()
default URL	getApiURL()	Returns the path to where the controllers paths are evaluated relative to, that is, the Servlet's context URL.
X509Certificate[]	getClientCertificate()
String	getClientIp()
String	getContextPath()	Returns the context path of the server.
default URL	getContextURL()	Returns the scheme, hostname, port and context path of the server
List<String>	getCookies(String name)	Returns all values of this cookie
List<String>	getHeaders(String name)	Returns the values for all instances of this header in the HTTP request
String	getHttpMethod()
InputStream	getInputStream()
List<String>	getParameters(String name)	Returns the specified query string of the requested url for a get request or x-www-form-urlencoded body parameter for a POST or PUT request.
String	getPathInfo()	Returns the part of the URL after getApiURL.
String	getQueryString()	Returns the query string of the requested url.
Reader	getReader()
default String	getRequestURL()
String	getServerURL()	Returns the scheme, hostname and port part of the requesting URL, for example http://www.example.com or https://localhost:8443
default <T> Optional<T>	getSessionAttribute(Class<T> name)
default <T> Optional<T>	getSessionAttribute(Class<T> name, boolean createIfMissing)
default Optional	getSessionAttribute(String name)
Optional	getSessionAttribute(String name, boolean createIfMissing)
Principal	getUserPrincipal()
default boolean	hasParameter(String name)
boolean	isUserInRole(String role)
boolean	isUserLoggedIn()
default Optional<String>	optionalParameter(String name)
void	output(String contentType, ApiHttpExchange.OutputStreamConsumer consumer)	Callback with a OutputStream to generate response body
String	pathParam(String name)
default String	requiredParameter(String name)
void	sendError(int statusCode)
void	sendError(int statusCode, String message)
void	sendRedirect(String path)
default void	setCookie(String name, String value)	Sets a cookie with default values.
default void	setCookie(String name, String value, boolean secure, boolean isHttpOnly)	Sets a cookie with default values.
void	setCookie(String name, String value, boolean secure, boolean isHttpOnly, String contextPath, int maxAge, String domain, String comment)	Sets a cookie with default values.
void	setPathParameters(Map<String,String> pathParameters)
void	setResponseHeader(String key, String value)
void	setSessionAttribute(String name, Object value, boolean invalidate)
void	setStatus(int statusCode)	Sets the http status code, but don't trigger the error handler (servlets)
void	write(String contentType, ApiHttpExchange.WriterConsumer consumer)	Callback with a Writer to generate response body
void	writeBody(String contentType, String body)	Output String directory to the response body

Method Detail

getHttpMethod

String getHttpMethod()

getContextPath

String getContextPath()

Returns the context path of the server. Blank if the server context is the root of the server

getServerURL

String getServerURL()

Returns the scheme, hostname and port part of the requesting URL, for example http://www.example.com or https://localhost:8443

getContextURL

default URL getContextURL()

Returns the scheme, hostname, port and context path of the server

getApiURL

default URL 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.

getPathInfo

String getPathInfo()

Returns the part of the URL after getApiURL. For example if a controller is mounted at https://example.com:7443/app/api and the client requests GET https://example.com:7443/app/api/hello/world getPathInfo returns "/hello/world"

getRequestURL

default String getRequestURL()

getQueryString

String getQueryString()

Returns the query string of the requested url. For example if the client requests GET https://example.com:7443/app/api/hello/world?greeting=Hello+There getQueryString() returns greeting=Hello+There.

getParameters

List<String> getParameters(String name)

Returns the specified query string of the requested url for a get request or x-www-form-urlencoded body parameter for a POST or PUT request. For example if the client requests GET https://example.com:7443/app/api/hello/world?greeting=Hello+There&greeting=Hi getParameter("greeting") returns ["Hello There", "Hi"].

Parameters:

name - The query parameter name

Returns:

the non-empty list of parameters matching the name or null if none were provided

optionalParameter

default Optional<String> optionalParameter(String name)

requiredParameter

default String requiredParameter(String name)

hasParameter

default boolean hasParameter(String name)

write

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

Callback with a Writer to generate response body

Throws:

IOException

writeBody

void writeBody(String contentType,
               String body)
        throws IOException

Output String directory to the response body

Throws:

IOException

output

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

Callback with a OutputStream to generate response body

Throws:

IOException

getHeaders

List<String> getHeaders(String name)

Returns the values for all instances of this header in the HTTP request

Parameters:

name - The header name

Returns:

the non-empty list of headers matching the name or null if none were provided

getAllHeaders

Map<String,List<String>> getAllHeaders()

accept

default boolean accept(String contentType)

Returns true if the "Accept" request header matches the argument content type

getClientIp

String getClientIp()

setResponseHeader

void setResponseHeader(String key,
                       String value)

addResponseHeader

void addResponseHeader(String key,
                       String value)

sendRedirect

void sendRedirect(String path)
           throws IOException

Throws:

IOException

pathParam

String pathParam(String name)
          throws HttpActionException

Throws:

HttpActionException - throws 500 if the name was not matched with a path parameter

setPathParameters

void setPathParameters(Map<String,String> pathParameters)

getReader

Reader getReader()
          throws IOException

Throws:

IOException

getInputStream

InputStream getInputStream()
                    throws IOException

Throws:

IOException

setCookie

default void setCookie(String name,
                       String value)

Sets a cookie with default values. If value == null, deletes the cookie

setCookie

default void setCookie(String name,
                       String value,
                       boolean secure,
                       boolean isHttpOnly)

Sets a cookie with default values. If value == null, deletes the cookie

setCookie

void setCookie(String name,
               String value,
               boolean secure,
               boolean isHttpOnly,
               String contextPath,
               int maxAge,
               String domain,
               String comment)

Sets a cookie with default values. If value == null, deletes the cookie

getCookies

List<String> getCookies(String name)

Returns all values of this cookie

Parameters:

name - The cookie name

Returns:

a non-null list of cookies matching the name or empty if none were provided

sendError

void sendError(int statusCode,
               String message)
        throws IOException

Throws:

IOException

sendError

void sendError(int statusCode)
        throws IOException

Throws:

IOException

setStatus

void setStatus(int statusCode)
        throws IOException

Sets the http status code, but don't trigger the error handler (servlets)

Throws:

IOException

isUserLoggedIn

boolean isUserLoggedIn()

isUserInRole

boolean isUserInRole(String role)

setSessionAttribute

void setSessionAttribute(String name,
                         Object value,
                         boolean invalidate)

getSessionAttribute

Optional getSessionAttribute(String name,
                             boolean createIfMissing)

getSessionAttribute

default Optional getSessionAttribute(String name)

getSessionAttribute

default <T> Optional<T> getSessionAttribute(Class<T> name,
                                            boolean createIfMissing)

getSessionAttribute

default <T> Optional<T> getSessionAttribute(Class<T> name)

getClientCertificate

X509Certificate[] getClientCertificate()

getUserPrincipal

Principal getUserPrincipal()

authenticate

void authenticate()
           throws IOException

Throws:

IOException