Package com.spec.web.expresso.message

Class HttpRequest

java.lang.Object

com.spec.web.expresso.message.HttpRequest

All Implemented Interfaces:

Request

public class HttpRequest
extends Object
implements Request

Wrapper class over HttpServletRequest. Helps in handling of Http request.

Constructor Summary

Constructors

Constructor	Description
HttpRequest(jakarta.servlet.http.HttpServletRequest req)	Constructs an instance of HttpRequest wrapping an HttpServletRequest.

Method Summary

Modifier and Type	Method	Description
String	body()	Returns the Http body of the HttpRequest as String.
jakarta.servlet.http.Cookie[]	getCookies()	Returns list of cookies sent by the client
String	getHeader(String headerName)	Returns the value of header for the specified header name.
jakarta.servlet.http.HttpServletRequest	getHttpServletRequest()	Return http servlet request which is used internally by Expresso.
String	getMimeType(String fileName)	Returns the mime type of file name passed to it.
Reader	getReader()	Returns a reader object to read request body.
String	getRequestPath()	Retrives the path of the current request url.
String	getRouteParams(String name)	Get the route parameter value against the given name
String	getUrlParams(String name)	Return the query parameter value against the name
void	setCurrentUrlPattern(String currentUrlPattern)	Sets the current url pattern

Methods inherited from class java.lang.Object

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

Constructor Details

HttpRequest

public HttpRequest(jakarta.servlet.http.HttpServletRequest req)

Constructs an instance of HttpRequest wrapping an HttpServletRequest.

Parameters:

req - HttpServlet to wrap

Method Details

body

public String body()
            throws IOException

Returns the Http body of the HttpRequest as String.

Specified by:

body in interface Request

Returns:

payload in string format

Throws:

IOException - May throw and IOException if it cannot read the body of response.

getRouteParams

public String getRouteParams(String name)

Get the route parameter value against the given name

Specified by:

getRouteParams in interface Request

Parameters:

name - name of the route parameter , this name should be same as the name of the parameter mentioned in the url pattern. Ex: /user/:id so parameter name will be 'id'.

Returns:

value of the parameter

getUrlParams

public String getUrlParams(String name)

Return the query parameter value against the name

Specified by:

getUrlParams in interface Request

Parameters:

name - name of the query parameter

Returns:

value of the query parameter

setCurrentUrlPattern

public void setCurrentUrlPattern(String currentUrlPattern)

Sets the current url pattern

Parameters:

currentUrlPattern - Url pattern on which the current middlware is executing on.

getHttpServletRequest

public jakarta.servlet.http.HttpServletRequest getHttpServletRequest()

Return http servlet request which is used internally by Expresso.

Returns:

HttpServletRequest

getRequestPath

public String getRequestPath()

Retrives the path of the current request url.

Specified by:

getRequestPath in interface Request

Returns:

the path of the current request

getMimeType

public String getMimeType(String fileName)

Returns the mime type of file name passed to it.

Specified by:

getMimeType in interface Request

Parameters:

fileName - The file for which the mime type should be found out.

Returns:

MIME type of the file

getCookies

public jakarta.servlet.http.Cookie[] getCookies()

Returns list of cookies sent by the client

Specified by:

getCookies in interface Request

Returns:

List of cookies

getReader

public Reader getReader()
                 throws IOException

Returns a reader object to read request body.

Specified by:

getReader in interface Request

Returns:

Reader instance to read request body.

Throws:

IOException - IOException

getHeader

public String getHeader(String headerName)

Returns the value of header for the specified header name.

Specified by:

getHeader in interface Request

Parameters:

headerName - The name of the header.

Returns:

Value of the header.