|
Enhydra 5.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object passed to presentation objects that is used to access HTTP request data.
Method Summary | |
java.lang.String |
getAppFileURIPath(java.lang.String file)
Get the URI path for a file in the application. |
java.lang.String |
getApplicationPath()
Returns the part of the request URI that refers to the application. |
java.lang.String |
getAuthType()
Returns the authentication scheme of the request, or null if none. |
int |
getContentLength()
Returns the size of the request entity data, or -1 if not known. |
java.lang.String |
getContentType()
Returns the Internet Media Type of the request entity data, or null if not known. |
javax.servlet.http.Cookie[] |
getCookies()
Gets the array of cookies found in this request. |
long |
getDateHeader(java.lang.String name)
Returns the value of a date header field, or -1 if not found. |
java.lang.String |
getHeader(java.lang.String name)
Returns the value of a header field, or null if not known. |
java.util.Enumeration |
getHeaderNames()
Returns an enumeration of strings representing the header names for this request. |
javax.servlet.http.HttpServletRequest |
getHttpServletRequest()
Returns the original HttpServletRequest. |
HttpPresentationInputStream |
getInputStream()
Returns an input stream for reading the request body. |
int |
getIntHeader(java.lang.String name)
Returns the value of an integer header field, or -1 if not found. |
java.lang.String |
getMethod()
Returns the method with which the request was made. |
java.lang.String |
getParameter(java.lang.String name)
Returns a string containing the lone value of the specified query parameter, or null if the parameter does not exist. |
java.util.Enumeration |
getParameterNames()
Returns the parameter names for this request as an enumeration of strings, or an empty enumeration if there are no parameters. |
java.lang.String[] |
getParameterValues(java.lang.String name)
Returns the values of the specified query parameter for the request as an array of strings, or a 0 length array if the named parameter does not exist. |
java.lang.String |
getPathInfo()
Returns optional extra path information following the presentation path, but immediately preceding the query string. |
java.lang.String |
getPathTranslated()
Returns extra path information translated to a real path. |
java.lang.String |
getPresentationObjectPath()
Returns the part of the request URI that refers to the presentation object being invoked. |
java.lang.String |
getPresentationObjectRelativePath()
Returns the part of the request URI after the presentation manager servlet, upto and including the presentation object .po, but not any path info. |
java.lang.String |
getPresentationPath()
Deprecated. This method was named in a confusing manner; it returns the application, not presentation object path. Use getApplicationPath(). |
java.lang.String |
getPresentationURI()
Returns the presentation URI. |
java.lang.String |
getProtocol()
Returns the protocol and version of the request as a string of the form <protocol>/<major version>.<minor
version> . |
java.lang.String |
getQueryString()
Returns the query string part of the presentation URI, or null if none. |
java.lang.String |
getRemoteAddr()
Returns the IP address of the agent that sent the request. |
java.lang.String |
getRemoteHost()
Returns the fully qualified host name of the agent that sent the request. |
java.lang.String |
getRemoteUser()
Returns the name of the user making this request, or null if not known. |
java.lang.String |
getRequestURI()
Returns the request URI as a URL. |
java.lang.String |
getScheme()
Returns the scheme of the URL used in this request, for example "http", "https", or "ftp". |
java.lang.String |
getServerName()
Returns the host name of the server that received the request. |
int |
getServerPort()
Returns the port number on which this request was received. |
boolean |
isRequestedSessionIdFromCookie()
Indicates whether client submitted their session id through a cookie |
boolean |
isRequestedSessionIdFromUrl()
Indicates whether client submitted their sessionId through a rewritten url |
void |
setRequestedSessionIdFromCookie(boolean isFromCookie)
|
void |
setRequestedSessionIdFromUrl(boolean isFromUrl)
|
Method Detail |
public javax.servlet.http.HttpServletRequest getHttpServletRequest()
public int getContentLength() throws HttpPresentationException
HttpPresentationException
public java.lang.String getContentType() throws HttpPresentationException
HttpPresentationException
public java.lang.String getProtocol() throws HttpPresentationException
<protocol>/<major version>.<minor
version>
. Same as the CGI variable SERVER_PROTOCOL.
HttpPresentationException
public java.lang.String getScheme()
public java.lang.String getServerName()
public int getServerPort()
public java.lang.String getRemoteAddr() throws HttpPresentationException
HttpPresentationException
public java.lang.String getRemoteHost() throws HttpPresentationException
HttpPresentationException
public HttpPresentationInputStream getInputStream() throws HttpPresentationException
HttpPresentationException
public java.lang.String getParameter(java.lang.String name) throws HttpPresentationException
name
- the name of the parameter whose value is required.
HttpPresentationException
getParameterValues(java.lang.String)
public java.lang.String[] getParameterValues(java.lang.String name) throws HttpPresentationException
name
- the name of the parameter whose value is required.
HttpPresentationException
public java.util.Enumeration getParameterNames() throws HttpPresentationException
HttpPresentationException
public java.lang.String getMethod() throws HttpPresentationException
HttpPresentationException
public java.lang.String getRequestURI() throws HttpPresentationException
HttpPresentationException
public java.lang.String getPresentationURI() throws HttpPresentationException
HttpPresentationException
public java.lang.String getPresentationPath() throws HttpPresentationException
HttpPresentationException
public java.lang.String getPresentationObjectPath() throws HttpPresentationException
HttpPresentationException
public java.lang.String getPresentationObjectRelativePath() throws HttpPresentationException
HttpPresentationException
public java.lang.String getApplicationPath() throws HttpPresentationException
HttpPresentationException
public java.lang.String getPathInfo() throws HttpPresentationException
HttpPresentationException
public java.lang.String getPathTranslated() throws HttpPresentationException
HttpPresentationException
public java.lang.String getQueryString() throws HttpPresentationException
HttpPresentationException
public java.lang.String getRemoteUser() throws HttpPresentationException
HttpPresentationException
public java.lang.String getAuthType() throws HttpPresentationException
HttpPresentationException
public javax.servlet.http.Cookie[] getCookies() throws HttpPresentationException
HttpPresentationException
public boolean isRequestedSessionIdFromCookie() throws HttpPresentationException
HttpPresentationException
public void setRequestedSessionIdFromCookie(boolean isFromCookie) throws HttpPresentationException
HttpPresentationException
public boolean isRequestedSessionIdFromUrl() throws HttpPresentationException
HttpPresentationException
public void setRequestedSessionIdFromUrl(boolean isFromUrl) throws HttpPresentationException
HttpPresentationException
public java.lang.String getHeader(java.lang.String name) throws HttpPresentationException
name
- the case-insensitive header field name
HttpPresentationException
public int getIntHeader(java.lang.String name) throws HttpPresentationException
name
- the case-insensitive header field name
HttpPresentationException
public long getDateHeader(java.lang.String name) throws HttpPresentationException
name
- the case-insensitive header field name
HttpPresentationException
public java.util.Enumeration getHeaderNames() throws HttpPresentationException
HttpPresentationException
public java.lang.String getAppFileURIPath(java.lang.String file) throws HttpPresentationException
file
- File with in the application. Currently this must
be a path relative to the presentation prefix.
/
.
HttpPresentationException
|
Enhydra 5.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |