public interface DataControllerRequest extends Cloneable
DataControllerResponse
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.
|
void updateOriginalRequest(Map<String,Object> map)
FOR INTERNAL USE ONLY.
Updates the original underlying request object.map
- The mapString getParameter(String name)
name
- The parameter namegetParameterValues(String)
String[] getParameterValues(String name)
name
- The parameter namegetParameter(String)
<T> T getAttribute(String name)
name
- The attribute name<T> void setAttribute(String name, T value)
name
- The attribute namevalue
- The attribute valueIterator<String> getAttributeNames()
Iterator<String> getParameterNames()
String[] getUploadedFileNames()
File getUploadedFile(String name)
name
- The file name as in Content-Disposition header of the requestFile[] getUploadedFiles()
Session getSession()
Session
Session getSession(boolean createNewIfNotExist)
createNewIfNotExist
- If true, a new session is created and associated
with this request if there is no associated sessionSession
void setSession(Session session)
session
- The session to setSession
boolean containsKeyInRequestContext(String name)
name
- The attribute namegetAttribute(String)
,
setAttribute(String, Object)
boolean containsKeyInRequest(String name)
name
- The parameter namegetParameter(String)
Map<String,String[]> getSource()
@Deprecated Object getOriginalRequest()
String getHeader(String name)
name
- The header nameMap<String,Object> getHeaderMap()
String getRemoteAddr()
Map<String,org.apache.http.cookie.Cookie> getCookies()
DataControllerRequest clone()
void addRequestParam_(String name, String value)
FOR INTERNAL USE ONLY.
Adds a param to the request.name
- The name of the paramvalue
- The value of the paramServicesManager getServicesManager() throws AppRegistryException
Meant for use in Custom code
AppRegistryException
String getQueryString()
Copyright © 2019. All rights reserved.