Package com.spec.web.expresso.message

Interface Request

All Known Implementing Classes:

HttpRequest

public interface Request

Represent a Http request

Method Summary

Modifier and Type	Method	Description
String	body()	Returns the body(payload) of the Http request
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.
String	getMimeType(String fileName)	Returns the mime type of file 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/search parameter value against the name

Method Details

body

String body()
     throws IOException

Returns the body(payload) of the Http request

Returns:

The body of the request

Throws:

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

getRouteParams

String getRouteParams(String name)

Get the route parameter value against the given name.

Parameters:

name - name of the parameter , this name should be same as the name of the parameter mentioned in the url pattern

Returns:

value of the parameter

getUrlParams

String getUrlParams(String name)

Return the query/search parameter value against the name

Parameters:

name - name of the query parameter

Returns:

value of the query parameter

getRequestPath

String getRequestPath()

Retrives the path of the current request url.

Returns:

the path of the current request

getMimeType

String getMimeType(String fileName)

Returns the mime type of file passed to it.

Parameters:

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

Returns:

MIME type of file

getCookies

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

Returns list of cookies sent by the client

Returns:

List of cookies

getReader

Reader getReader()
          throws IOException

Returns a reader object to read request body.

Returns:

Reader instance to read request body.

Throws:

IOException - IOException

getHeader

String getHeader(String headerName)

Returns the value of header for the specified header name.

Parameters:

headerName - The name of the header.

Returns:

Value of the header.