com.agapsys.rcf

Class HttpRequest

java.lang.Object

com.agapsys.rcf.HttpRequest

public class HttpRequest
extends Object

Author:

Leandro Oliveira (leandro@agapsys.com)

Constructor Summary

Constructors

Constructor and Description
HttpRequest(HttpExchange exchange, javax.servlet.http.HttpServletRequest coreRequest)

Method Summary

Modifier and Type	Method and Description
String	getCookieValue(String name) Return cookie value.
javax.servlet.http.HttpServletRequest	getCoreRequest()
HttpExchange	getExchange()
String	getMandatoryParameter(String paramName) Returns a mandatory parameter contained in the request.
String	getMandatoryParameter(String paramName, String errorMessage, Object... errMsgArgs) Returns a mandatory parameter contained in the request.
String	getOptionalParameter(String paramName, String defaultValue) Returns an optional parameter contained in the request.
String	getOriginIp() Return origin IP.
String	getUri() Return request URI.
String	getUserAgent() Return origin user-agent.
<T> T	readObject(Class<T> targetClass) Reads an objected send with the request using exchange default serializer.
<T> T	readObject(HttpObjectSerializer serializer, Class<T> targetClass) Reads an objected contained in the request.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpRequest

public HttpRequest(HttpExchange exchange,
                   javax.servlet.http.HttpServletRequest coreRequest)

Method Detail

getCoreRequest

public javax.servlet.http.HttpServletRequest getCoreRequest()

getExchange

public HttpExchange getExchange()

getOriginIp

public String getOriginIp()

Return origin IP.

Returns:

origin IP.

getUserAgent

public String getUserAgent()

Return origin user-agent.

Returns:

origin user-agent.

getUri

public String getUri()

Return request URI.

Returns:

request URI.

getCookieValue

public String getCookieValue(String name)

Return cookie value.

Parameters:

name - cookie name

Returns:

cookie value. If there is no such cookie, returns null.

getOptionalParameter

public String getOptionalParameter(String paramName,
                                   String defaultValue)

Returns an optional parameter contained in the request.

Parameters:

paramName - parameter name

defaultValue - default value if given parameter is not contained in the request

Returns:

parameter value

getMandatoryParameter

public String getMandatoryParameter(String paramName)
                             throws BadRequestException

Returns a mandatory parameter contained in the request.

Parameters:

paramName - parameter name

Returns:

parameter value.

Throws:

BadRequestException - if parameter is not contained in given request.

getMandatoryParameter

public String getMandatoryParameter(String paramName,
                                    String errorMessage,
                                    Object... errMsgArgs)
                             throws BadRequestException

Returns a mandatory parameter contained in the request.

Parameters:

paramName - parameter name

errorMessage - error message if parameter is not found.

errMsgArgs - optional error message args if error message is a formatted string.

Returns:

parameter value.

Throws:

BadRequestException - if parameter is not contained in given request.

readObject

public <T> T readObject(HttpObjectSerializer serializer,
                        Class<T> targetClass)
                 throws BadRequestException,
                        IOException

Reads an objected contained in the request.

Type Parameters:

T - object type.

Parameters:

targetClass - object class.

serializer - serializer used to get the object.

Returns:

read object.

Throws:

BadRequestException - if it was not possible to read an object of given type.

IOException - if there was an error while reading the object.

readObject

public final <T> T readObject(Class<T> targetClass)
                       throws BadRequestException,
                              IOException

Reads an objected send with the request using exchange default serializer.

Type Parameters:

T - object type.

Parameters:

targetClass - object class.

Returns:

read object.

Throws:

BadRequestException - if it was not possible to read an object of given type.

IOException - if there was an error while reading the object.