Package org.actioncontroller.jakarta

Class JakartaServletHttpExchange

java.lang.Object

org.actioncontroller.jakarta.JakartaServletHttpExchange

All Implemented Interfaces:

ApiHttpExchange

public class JakartaServletHttpExchange
extends Object
implements ApiHttpExchange

Nested Class Summary

Nested classes/interfaces inherited from interface org.actioncontroller.ApiHttpExchange

ApiHttpExchange.OutputStreamConsumer, ApiHttpExchange.WriterConsumer

Field Summary

Fields

Modifier and Type	Field	Description
static Charset	CHARSET

Constructor Summary

Constructors

Constructor	Description
JakartaServletHttpExchange(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse resp)

Method Summary

Modifier and Type	Method	Description
void	addResponseHeader(String key, String value)
void	authenticate()
Map<String,List<String>>	getAllHeaders()
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.
static List<String>	getCookie(String name, jakarta.servlet.http.HttpServletRequest req)
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()
jakarta.servlet.http.HttpServletRequest	getRequest()	Break the encapsulation of ApiHttpExchange and access the underlying implementation directory.
jakarta.servlet.http.HttpServletResponse	getResponse()	Break the encapsulation of ApiHttpExchange and access the underlying implementation directory.
String	getServerURL()	Returns the scheme, hostname and port part of the requesting URL, for example http://www.example.com or https://localhost:8443
Optional<?>	getSessionAttribute(String name, boolean createIfMissing)
Principal	getUserPrincipal()
boolean	isUserInRole(String role)
boolean	isUserLoggedIn()
void	output(String contentType, ApiHttpExchange.OutputStreamConsumer consumer)	Callback with a OutputStream to generate response body
String	pathParam(String name)
void	sendError(int statusCode)
void	sendError(int statusCode, String message)
void	sendRedirect(String location)
void	setCookie(String name, String value, boolean secure, boolean isHttpOnly, String path, 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)
String	toString()
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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.actioncontroller.ApiHttpExchange

accept, getContextURL, getRequestURL, getSessionAttribute, getSessionAttribute, getSessionAttribute, hasParameter, optionalParameter, requiredParameter, setCookie, setCookie

Field Detail

CHARSET

public static final Charset CHARSET

Constructor Detail

JakartaServletHttpExchange

public JakartaServletHttpExchange(jakarta.servlet.http.HttpServletRequest req,
                                  jakarta.servlet.http.HttpServletResponse resp)

Method Detail

getRequest

public jakarta.servlet.http.HttpServletRequest getRequest()

Break the encapsulation of ApiHttpExchange and access the underlying implementation directory. Should be avoided - prefer to improve ApiHttpExchange

getResponse

public jakarta.servlet.http.HttpServletResponse getResponse()

Break the encapsulation of ApiHttpExchange and access the underlying implementation directory. Should be avoided - prefer to improve ApiHttpExchange

getHttpMethod

public String getHttpMethod()

Specified by:

getHttpMethod in interface ApiHttpExchange

getServerURL

public String getServerURL()

Description copied from interface: ApiHttpExchange

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

Specified by:

getServerURL in interface ApiHttpExchange

getContextPath

public String getContextPath()

Description copied from interface: ApiHttpExchange

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

Specified by:

getContextPath in interface ApiHttpExchange

getApiURL

public URL getApiURL()

Description copied from interface: ApiHttpExchange

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 ApiHttpExchange

getPathInfo

public String getPathInfo()

Description copied from interface: ApiHttpExchange

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"

Specified by:

getPathInfo in interface ApiHttpExchange

write

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

Description copied from interface: ApiHttpExchange

Callback with a Writer to generate response body

Specified by:

write in interface ApiHttpExchange

Throws:

IOException

writeBody

public void writeBody(String contentType,
                      String body)
               throws IOException

Description copied from interface: ApiHttpExchange

Output String directory to the response body

Specified by:

writeBody in interface ApiHttpExchange

Throws:

IOException

output

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

Description copied from interface: ApiHttpExchange

Callback with a OutputStream to generate response body

Specified by:

output in interface ApiHttpExchange

Throws:

IOException

setResponseHeader

public void setResponseHeader(String key,
                              String value)

Specified by:

setResponseHeader in interface ApiHttpExchange

addResponseHeader

public void addResponseHeader(String key,
                              String value)

Specified by:

addResponseHeader in interface ApiHttpExchange

sendRedirect

public void sendRedirect(String location)
                  throws IOException

Specified by:

sendRedirect in interface ApiHttpExchange

Throws:

IOException

pathParam

public String pathParam(String name)
                 throws HttpActionException

Specified by:

pathParam in interface ApiHttpExchange

Throws:

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

setPathParameters

public void setPathParameters(Map<String,String> pathParameters)

Specified by:

setPathParameters in interface ApiHttpExchange

getParameters

public List<String> getParameters(String name)

Description copied from interface: ApiHttpExchange

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"].

Specified by:

getParameters in interface ApiHttpExchange

Parameters:

name - The query parameter name

Returns:

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

getQueryString

public String getQueryString()

Description copied from interface: ApiHttpExchange

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.

Specified by:

getQueryString in interface ApiHttpExchange

getReader

public Reader getReader()
                 throws IOException

Specified by:

getReader in interface ApiHttpExchange

Throws:

IOException

getInputStream

public InputStream getInputStream()
                           throws IOException

Specified by:

getInputStream in interface ApiHttpExchange

Throws:

IOException

getClientIp

public String getClientIp()

Specified by:

getClientIp in interface ApiHttpExchange

setCookie

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

Description copied from interface: ApiHttpExchange

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

Specified by:

setCookie in interface ApiHttpExchange

getCookies

public List<String> getCookies(String name)

Description copied from interface: ApiHttpExchange

Returns all values of this cookie

Specified by:

getCookies in interface ApiHttpExchange

Parameters:

name - The cookie name

Returns:

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

getCookie

public static List<String> getCookie(String name,
                                     jakarta.servlet.http.HttpServletRequest req)

getHeaders

public List<String> getHeaders(String name)

Description copied from interface: ApiHttpExchange

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

Specified by:

getHeaders in interface ApiHttpExchange

Parameters:

name - The header name

Returns:

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

getAllHeaders

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

Specified by:

getAllHeaders in interface ApiHttpExchange

sendError

public void sendError(int statusCode,
                      String message)
               throws IOException

Specified by:

sendError in interface ApiHttpExchange

Throws:

IOException

sendError

public void sendError(int statusCode)
               throws IOException

Specified by:

sendError in interface ApiHttpExchange

Throws:

IOException

isUserInRole

public boolean isUserInRole(String role)

Specified by:

isUserInRole in interface ApiHttpExchange

isUserLoggedIn

public boolean isUserLoggedIn()

Specified by:

isUserLoggedIn in interface ApiHttpExchange

setSessionAttribute

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

Specified by:

setSessionAttribute in interface ApiHttpExchange

getSessionAttribute

public Optional<?> getSessionAttribute(String name,
                                       boolean createIfMissing)

Specified by:

getSessionAttribute in interface ApiHttpExchange

getClientCertificate

public X509Certificate[] getClientCertificate()

Specified by:

getClientCertificate in interface ApiHttpExchange

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface ApiHttpExchange

setStatus

public void setStatus(int statusCode)

Description copied from interface: ApiHttpExchange

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

Specified by:

setStatus in interface ApiHttpExchange

authenticate

public void authenticate()
                  throws IOException

Specified by:

authenticate in interface ApiHttpExchange

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object