|
HATS 7.5.1 Web API ReferencePublicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.hats.web.runtime.WebRequest
public class WebRequest
Class Name: WebRequest Provides a wrapper for the HttpServletRequest class.
Class Type: Normal
Base Class: None
Intf Class: IRequest
Description:
| Constructor Summary | |
|---|---|
WebRequest(javax.servlet.http.HttpServletRequest theHttpServletRequest)
The parameter constructor. |
|
| Method Summary | |
|---|---|
boolean |
equals(Object webRequest)
Compares object references for equality. |
String |
getApplicationId()
Retrieve the application ID. |
Object |
getAttribute(String key)
Retrieve the specified attribute. |
String |
getCharacterEncoding()
Return the character encoding. |
String |
getContextPath()
Retrieve the context path. |
String |
getHeader(String key)
Retrieve the specified header. |
Enumeration |
getHeaderNames()
Retrieve an Enumeration of the header names. |
javax.servlet.http.HttpServletRequest |
getHttpServletRequest()
Retrieve the underlying HttpServletRequest. |
Locale |
getLocale()
Retrieve the Locale. |
String |
getParameter(String key)
Retrieve the specified parameter. |
Map |
getParameterMap()
Retrieve the parameter Map. |
Enumeration |
getParameterNames()
Retrieve an Enumeration of the parameter names. |
String[] |
getParameterValues(String key)
Retrieve the specified array containing parameter values. |
String |
getPathInfo()
Retrieve the path information. |
String |
getQueryString()
Retrieve the query string. |
String |
getRemoteAddr()
Retrieve the remote address. |
String |
getRemoteHost()
Retrieve the remote host. |
IRequestDispatcher |
getRequestDispatcher(String key)
Retrieve the specified request dispatcher. |
String |
getRequestedSessionId()
Retrieve the requested session ID. |
String |
getRequestURI()
Retrieve the request URI. |
StringBuffer |
getRequestURL()
Retriee the request URL. |
String |
getServletPath()
Retrieve the servlet path. |
ISession |
getSession()
Retrieve the session. |
ISession |
getSession(boolean create)
Returns the current session associated with this request or, if if there is no current session and create is true, returns a new session. |
ISessionService |
getSessionService()
This method is not implemented and will throw a runtime UnsupportedOperationException if invoked. |
String |
getViewId()
Returns unique ID that identifies the view into the application. |
int |
hashCode()
Retrieve the hash code. |
void |
setAttribute(String key,
Object attribute)
Set the attribute for the key. |
void |
setHttpServletRequest(javax.servlet.http.HttpServletRequest theHttpServletRequest)
Set a new HttpServletRequest. |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public WebRequest(javax.servlet.http.HttpServletRequest theHttpServletRequest)
theHttpServletRequest - The servlet request that is being wrapped.| Method Detail |
|---|
public boolean equals(Object webRequest)
equals in class ObjectwebRequest - The web request.
Object.equals(java.lang.Object)public String getApplicationId()
getApplicationId in interface IRequestIRequest.getApplicationId()public Object getAttribute(String key)
getAttribute in interface IRequestkey - The key of the attribute being retrieved.
ServletRequest.getAttribute(java.lang.String)public String getCharacterEncoding()
getCharacterEncoding in interface IRequestServletRequest.getCharacterEncoding()public String getContextPath()
getContextPath in interface IRequestHttpServletRequest.getContextPath()public String getHeader(String key)
getHeader in interface IRequestkey - The header key.
HttpServletRequest.getHeader(java.lang.String)public Enumeration getHeaderNames()
Enumeration of the header names.
getHeaderNames in interface IRequestEnumeration of the header names.HttpServletRequest.getHeaderNames()public javax.servlet.http.HttpServletRequest getHttpServletRequest()
HttpServletRequest.
HttpServletRequest.public Locale getLocale()
Locale.
getLocale in interface IRequestLocale.ServletRequest.getLocale()public String getParameter(String key)
getParameter in interface IRequestkey - The key for the parameter being retrieved.
ServletRequest.getParameter(java.lang.String)public Map getParameterMap()
Map.
getParameterMap in interface IRequestMap.ServletRequest.getParameterMap()public Enumeration getParameterNames()
Enumeration of the parameter names.
getParameterNames in interface IRequestEnumeration of the parameter names.ServletRequest.getParameterNames()public String[] getParameterValues(String key)
getParameterValues in interface IRequestkey - The key for the array being retrieved.
ServletRequest.getParameterValues(java.lang.String)public String getPathInfo()
getPathInfo in interface IRequestHttpServletRequest.getPathInfo()public String getQueryString()
getQueryString in interface IRequestHttpServletRequest.getQueryString()public String getRemoteAddr()
getRemoteAddr in interface IRequestServletRequest.getRemoteAddr()public String getRemoteHost()
ServletRequest.getRemoteHost()public IRequestDispatcher getRequestDispatcher(String key)
getRequestDispatcher in interface IRequestkey - The key for the requested dispatcher.
ServletRequest.getRequestDispatcher(java.lang.String)public String getRequestedSessionId()
getRequestedSessionId in interface IRequestHttpServletRequest.getRequestedSessionId()public String getRequestURI()
getRequestURI in interface IRequestHttpServletRequest.getRequestURI()public StringBuffer getRequestURL()
getRequestURL in interface IRequestHttpServletRequest.getRequestURL()public String getServletPath()
getServletPath in interface IRequestHttpServletRequest.getServletPath()public ISession getSession()
getSession in interface IRequestHttpServletRequest.getSession()public ISession getSession(boolean create)
getSession in interface IRequestcreate - (true)to create a new session for this request if necessary; (false)to return null if there's no current session
HttpServletRequest.getSession(boolean)public ISessionService getSessionService()
getSessionService in interface IRequestpublic String getViewId()
getViewId in interface IRequestIRequest.getViewId()public int hashCode()
hashCode in class Object
public void setAttribute(String key,
Object attribute)
setAttribute in interface IRequestattribute - The attribute to be set.key - The key used to save the attribute.ServletRequest.setAttribute(java.lang.String, java.lang.Object)public void setHttpServletRequest(javax.servlet.http.HttpServletRequest theHttpServletRequest)
HttpServletRequest.
theHttpServletRequest - The new HttpServletRequest to set.
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||