|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objecthelma.framework.RequestTrans
public class RequestTrans
A Transmitter for a request from the servlet client. Objects of this class are directly exposed to JavaScript as global property req.
Field Summary | |
---|---|
static java.lang.String |
DELETE
|
static java.lang.String |
EXTERNAL
|
static java.lang.String |
GET
|
static java.lang.String |
HEAD
|
static java.lang.String |
INTERNAL
|
static java.lang.String |
OPTIONS
|
static java.lang.String |
POST
|
static java.lang.String |
PUT
|
static java.lang.String |
TRACE
|
static java.lang.String |
XMLRPC
|
Constructor Summary | |
---|---|
RequestTrans(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
java.lang.String path)
Create a new request transmitter with the given data map. |
|
RequestTrans(java.lang.String method,
java.lang.String path)
Create a new Request transmitter with an empty data map. |
Method Summary | |
---|---|
void |
addPostParam(java.lang.String name,
java.lang.Object value)
Add a post parameter to the request |
boolean |
checkXmlRpc()
Return true if we should try to handle this as XML-RPC request. |
boolean |
equals(java.lang.Object what)
A request is considered equal to another one if it has the same method, path, session, request data, and conditional get data. |
java.lang.Object |
get(java.lang.String name)
Get a value from the requests map by key. |
java.lang.String |
getAction()
Get the request's action. |
java.lang.Object |
getActionHandler()
Get the request's action handler. |
java.util.Map |
getCookies()
|
long |
getDateHeader(java.lang.String name)
Proxy to HttpServletRequest.getDateHeader(), fails silently by returning -1. |
java.util.Set |
getETags()
|
java.lang.String |
getHeader(java.lang.String name)
Proxy to HttpServletRequest.getHeader(). |
java.lang.String[] |
getHeaders(java.lang.String name)
Proxy to HttpServletRequest.getHeaders(), returns header values as string array. |
long |
getIfModifiedSince()
|
int |
getIntHeader(java.lang.String name)
Proxy to HttpServletRequest.getIntHeader(), fails silently by returning -1. |
java.lang.String |
getMethod()
Return the method of the request. |
java.util.Map |
getParams()
|
java.lang.String |
getPassword()
|
java.lang.String |
getPath()
Get the request's path |
java.util.Map |
getPostParams()
|
java.util.Map |
getQueryParams()
|
java.util.Map |
getRequestData()
Get the data map for this request transmitter. |
javax.servlet.http.HttpServletRequest |
getServletRequest()
Returns the Servlet request represented by this RequestTrans instance. |
javax.servlet.http.HttpServletResponse |
getServletResponse()
Returns the Servlet response for this request. |
java.lang.String |
getSession()
Get the request's session id |
long |
getStartTime()
Get the time the request was created. |
java.lang.String |
getUri()
Get the request's path |
java.lang.String |
getUsername()
|
boolean |
hasETag(java.lang.String etag)
|
int |
hashCode()
The hash code is computed from the session id if available. |
boolean |
isGet()
Return true if this object represents a HTTP GET Request. |
boolean |
isPost()
Return true if this object represents a HTTP GET Request. |
boolean |
isXmlRpc()
Return true if this request is in fact handled as XML-RPC request. |
void |
set(java.lang.String name,
java.lang.Object value)
Set a parameter value in this request transmitter. |
void |
setAction(java.lang.String action)
Set the request's action. |
void |
setActionHandler(java.lang.Object handler)
Set the request's action handler. |
void |
setCookie(java.lang.String name,
javax.servlet.http.Cookie cookie)
Set a cookie |
void |
setETags(java.lang.String etagHeader)
|
void |
setIfModifiedSince(long since)
|
void |
setMethod(java.lang.String method)
Set the method of this request. |
void |
setParameters(java.util.Map parameters,
boolean isPost)
set the request parameters |
void |
setSession(java.lang.String session)
Set the request's session id |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String GET
public static final java.lang.String POST
public static final java.lang.String DELETE
public static final java.lang.String HEAD
public static final java.lang.String OPTIONS
public static final java.lang.String PUT
public static final java.lang.String TRACE
public static final java.lang.String XMLRPC
public static final java.lang.String EXTERNAL
public static final java.lang.String INTERNAL
Constructor Detail |
---|
public RequestTrans(java.lang.String method, java.lang.String path)
public RequestTrans(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String path)
Method Detail |
---|
public boolean checkXmlRpc()
public boolean isXmlRpc()
checkXmlRpc()
returns true and a matching
XML-RPC action was found.
public void setCookie(java.lang.String name, javax.servlet.http.Cookie cookie)
name
- the cookie namecookie
- the cookiepublic java.util.Map getCookies()
public java.util.Map getParams()
public java.util.Map getQueryParams()
public java.util.Map getPostParams()
public void setParameters(java.util.Map parameters, boolean isPost)
public void addPostParam(java.lang.String name, java.lang.Object value)
name
- the parameter namevalue
- the parameter valuepublic void set(java.lang.String name, java.lang.Object value)
public java.lang.Object get(java.lang.String name)
public java.util.Map getRequestData()
public javax.servlet.http.HttpServletRequest getServletRequest()
public java.lang.String getHeader(java.lang.String name)
name
- the header name
public java.lang.String[] getHeaders(java.lang.String name)
name
- the header name
public int getIntHeader(java.lang.String name)
name
- the header name
public long getDateHeader(java.lang.String name)
name
- the header name
public javax.servlet.http.HttpServletResponse getServletResponse()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object what)
equals
in class java.lang.Object
public java.lang.String getMethod()
public void setMethod(java.lang.String method)
method
- the method.public boolean isGet()
public boolean isPost()
public java.lang.String getSession()
public void setSession(java.lang.String session)
public java.lang.String getPath()
public java.lang.String getUri()
public java.lang.String getAction()
public void setAction(java.lang.String action)
public java.lang.Object getActionHandler()
public void setActionHandler(java.lang.Object handler)
handler
- the action handlerpublic long getStartTime()
public void setIfModifiedSince(long since)
since
- ...public long getIfModifiedSince()
public void setETags(java.lang.String etagHeader)
etagHeader
- ...public java.util.Set getETags()
public boolean hasETag(java.lang.String etag)
etag
- ...
public java.lang.String getUsername()
public java.lang.String getPassword()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |