com.hcl.voltmx.middleware.controller

Interface DataControllerRequest

All Superinterfaces:

Cloneable

public interface DataControllerRequest
extends Cloneable

An abstraction over actual client request.

See Also:

DataControllerResponse

Method Summary

Modifier and Type	Method and Description
void	addRequestParam_(String name, String value) FOR INTERNAL USE ONLY.
DataControllerRequest	clone() Creates a copy (clone) of this request.
boolean	containsKeyInRequest(String name) Gets whether a parameter exists or not.
boolean	containsKeyInRequestContext(String name) Gets whether an attribute (an Object scoped to this request) exists or not.
<T> T	getAttribute(String name) Gets an attribute value, an Object previously stored in the scope of this request.
Iterator<String>	getAttributeNames() Gets name of all the attributes stored in the scope of this request.
Map<String,org.apache.http.cookie.Cookie>	getCookies() Gets the cookies from of the request.
String	getHeader(String name) Gets the header value of the specified header name.
Map<String,Object>	getHeaderMap() Gets the map of all headers.
Object	getOriginalRequest() Deprecated.
String	getParameter(String name) Gets the request parameter passed in as post parameter or query string.
Iterator<String>	getParameterNames() Gets name of all the request parameters.
String[]	getParameterValues(String name) Gets the request parameter passed in as post parameter or query string.
String	getQueryString()
String	getRemoteAddr() Gets the IP address of the client or last proxy that sent the request.
ServicesManager	getServicesManager() Meant for use in Custom code
Session	getSession() Gets the session associated with the request.
Session	getSession(boolean createNewIfNotExist) Gets the session associated with the request.
Map<String,String[]>	getSource() Gets a map of parameter key and parameter values.
File	getUploadedFile(String name) Gets the specified file that was uploaded.
String[]	getUploadedFileNames() Gets name of all the files that have been received in this request.
File[]	getUploadedFiles() Gets all the uploaded files.
<T> void	setAttribute(String name, T value) Sets an attribute value, an Object storied in the scope of this request.
void	setSession(Session session) Sets a session for this request.
void	updateOriginalRequest(Map<String,Object> map) FOR INTERNAL USE ONLY.

Method Detail

updateOriginalRequest

void updateOriginalRequest(Map<String,Object> map)

FOR INTERNAL USE ONLY.

Updates the original underlying request object.

Parameters:

map - The map

getParameter

String getParameter(String name)

Gets the request parameter passed in as post parameter or query string. If the parameter has multiple values, this method will return the first value. The returned value will be URL decoded.

Parameters:

name - The parameter name

Returns:

URL decoded parameter value if parameter exists, null otherwise.

See Also:

getParameterValues(String)

getParameterValues

String[] getParameterValues(String name)

Gets the request parameter passed in as post parameter or query string. This method returns all the values for the given parameter as String array. The returned values will be URL decoded.

Parameters:

name - The parameter name

Returns:

URL decoded parameter values if parameter exists, null otherwise.

See Also:

getParameter(String)

getAttribute

<T> T getAttribute(String name)

Gets an attribute value, an Object previously stored in the scope of this request.

Parameters:

name - The attribute name

Returns:

The attribute value

setAttribute

<T> void setAttribute(String name,
                      T value)

Sets an attribute value, an Object storied in the scope of this request.

Parameters:

name - The attribute name

value - The attribute value

getAttributeNames

Iterator<String> getAttributeNames()

Gets name of all the attributes stored in the scope of this request.

Returns:

Name of all attributes

getParameterNames

Iterator<String> getParameterNames()

Gets name of all the request parameters.

Returns:

Name of all the request parameters

getUploadedFileNames

String[] getUploadedFileNames()

Gets name of all the files that have been received in this request.

Returns:

Name of all the files

getUploadedFile

File getUploadedFile(String name)

Gets the specified file that was uploaded.

Parameters:

name - The file name as in Content-Disposition header of the request

Returns:

The uploaded file

getUploadedFiles

File[] getUploadedFiles()

Gets all the uploaded files.

Returns:

All the uploaded files

getSession

Session getSession()

Gets the session associated with the request. Creates new session if one is not created.

Returns:

The associated session

See Also:

Session

getSession

Session getSession(boolean createNewIfNotExist)

Gets the session associated with the request. Creates new session if the flag is set to true.

Parameters:

createNewIfNotExist - If true, a new session is created and associated with this request if there is no associated session

Returns:

The associated session

See Also:

Session

setSession

void setSession(Session session)

Sets a session for this request.

Parameters:

session - The session to set

See Also:

Session

containsKeyInRequestContext

boolean containsKeyInRequestContext(String name)

Gets whether an attribute (an Object scoped to this request) exists or not.

Parameters:

name - The attribute name

Returns:

True if the attribute with given name exists, false otherwise

See Also:

getAttribute(String), setAttribute(String, Object)

containsKeyInRequest

boolean containsKeyInRequest(String name)

Gets whether a parameter exists or not.

Parameters:

name - The parameter name

Returns:

True if the parameter with given name exists, false otherwise

See Also:

getParameter(String)

getSource

Map<String,String[]> getSource()

Gets a map of parameter key and parameter values.

Returns:

An immutable map containing parameter names and parameter values as keys of type String and values of type String[] of the map.

getOriginalRequest

@Deprecated
Object getOriginalRequest()

Deprecated.

Gets the actual underlying request object. It is recommended to operate on this wrapper object instead of doing any direct operation on the underlying object.

Returns:

The actual underlying request object

getHeader

String getHeader(String name)

Gets the header value of the specified header name.

Parameters:

name - The header name

Returns:

The header value

getHeaderMap

Map<String,Object> getHeaderMap()

Gets the map of all headers.

Returns:

The map of all headers

getRemoteAddr

String getRemoteAddr()

Gets the IP address of the client or last proxy that sent the request.

Returns:

The IP address

getCookies

Map<String,org.apache.http.cookie.Cookie> getCookies()

Gets the cookies from of the request.

Returns:

The map of all cookies

clone

DataControllerRequest clone()

Creates a copy (clone) of this request.

Returns:

A copy of this request

addRequestParam_

void addRequestParam_(String name,
                      String value)

FOR INTERNAL USE ONLY.

Adds a param to the request.

Parameters:

name - The name of the param

value - The value of the param

getServicesManager

ServicesManager getServicesManager()
                            throws AppRegistryException

Meant for use in Custom code

Returns:

A generic helper object which can be used to access other helper classes in custom code.

Throws:

AppRegistryException

getQueryString

String getQueryString()

Returns:

query string of the underlying original request