com.agapsys.rcf

Class ActionRequest

java.lang.Object

com.agapsys.rcf.ServletExchange

com.agapsys.rcf.ActionRequest

Direct Known Subclasses:

JsonRequest

public class ActionRequest
extends ServletExchange

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ActionRequest(ActionRequest wrappedRequest)

Method Summary

Modifier and Type	Method and Description
String	getCookie(String name) Return cookie value.
String	getFullRequestUrl()
String	getHeader(String name)
Enumeration<String>	getHeaders(String name)
<T> T	getMandatoryParameter(Class<T> targetClass, String paramName)
<T> T	getMandatoryParameter(Class<T> targetClass, String paramName, String errorMsg, Object... errMsgArgs)
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.
Object	getMetadata(String key)
HttpMethod	getMethod() Returns the HTTP method associated with this request.
<T> T	getOptionalParameter(Class<T> targetClass, String paramName, T defaultValue)
String	getOptionalParameter(String paramName, String defaultValue) Returns an optional parameter contained in the request.
String	getOriginIp() Return origin IP.
Map<String,String>	getParameterMap() Return query string parameter map.
String	getPathInfo()
String	getProtocol()
String	getQueryString()
String	getRequestLine()
String	getRequestUri()
String	getRequestUrl()
ActionResponse	getResponse()
String	getUserAgent() Return origin user-agent.
protected ActionRequest	getWrappedRequest()
static void	main(String[] args)
void	putMetadata(String key, Object value)
void	removeMetadata(String key)
String	toString()

Methods inherited from class com.agapsys.rcf.ServletExchange

getServletRequest, getServletResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionRequest

protected ActionRequest(ActionRequest wrappedRequest)

Method Detail

main

public static void main(String[] args)

getMethod

public final HttpMethod getMethod()

Returns the HTTP method associated with this request.

Returns:

the HTTP method associated with this request.

getWrappedRequest

protected final ActionRequest getWrappedRequest()

getRequestUri

public final String getRequestUri()

getPathInfo

public final String getPathInfo()

getOriginIp

public final String getOriginIp()

Return origin IP.

Returns:

origin IP.

getUserAgent

public final String getUserAgent()

Return origin user-agent.

Returns:

origin user-agent.

getCookie

public final String getCookie(String name)

Return cookie value.

Parameters:

name - cookie name

Returns:

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

getOptionalParameter

public final 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

getOptionalParameter

public final <T> T getOptionalParameter(Class<T> targetClass,
                                        String paramName,
                                        T defaultValue)

getHeader

public final String getHeader(String name)

See Also:

HttpServletRequest.getHeader(java.lang.String)

getHeaders

public final Enumeration<String> getHeaders(String name)

See Also:

HttpServletRequest.getHeaders(java.lang.String)

getParameterMap

public final Map<String,String> getParameterMap()

Return query string parameter map.

Returns:

query string parameter map.

getMandatoryParameter

public final 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 final <T> T getMandatoryParameter(Class<T> targetClass,
                                         String paramName)
                                  throws BadRequestException

Throws:

BadRequestException

getMandatoryParameter

public final 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.

getMandatoryParameter

public final <T> T getMandatoryParameter(Class<T> targetClass,
                                         String paramName,
                                         String errorMsg,
                                         Object... errMsgArgs)
                                  throws BadRequestException

Throws:

BadRequestException

getRequestUrl

public final String getRequestUrl()

getFullRequestUrl

public final String getFullRequestUrl()

getQueryString

public final String getQueryString()

putMetadata

public final void putMetadata(String key,
                              Object value)

getMetadata

public final Object getMetadata(String key)

removeMetadata

public final void removeMetadata(String key)

getProtocol

public final String getProtocol()

getRequestLine

public final String getRequestLine()

getResponse

public final ActionResponse getResponse()

toString

public String toString()

Overrides:

toString in class Object