|
EAF 7.4 Implementation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.lutris.appserver.server.httpPresentation.servlet.ServletHttpPresentationRequest
public class ServletHttpPresentationRequest
Servlet implementation of the object passed to Presentation objects that is used to access HTTP request data.
Constructor Summary | |
---|---|
protected |
ServletHttpPresentationRequest(javax.servlet.http.HttpServletRequest request)
Construct an object associated with a servlet request. |
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()
|
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. |
com.lutris.appserver.server.httpPresentation.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 |
getPath()
Returns the part of the request URI that refers to the presentation object being invoked. |
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. |
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. |
int |
getTotalBytes()
Returns the total number of bytes processed as part of this request. |
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)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected ServletHttpPresentationRequest(javax.servlet.http.HttpServletRequest request)
request
- Servlet request object that this object will front-end.Method Detail |
---|
public javax.servlet.http.HttpServletRequest getHttpServletRequest()
getHttpServletRequest
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
public int getContentLength() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getContentLength
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public java.lang.String getContentType() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getContentType
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public java.lang.String getProtocol() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
<protocol>/<major version>.<minor
version>
. Same as the CGI variable SERVER_PROTOCOL.
getProtocol
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public java.lang.String getScheme()
getScheme
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
public java.lang.String getServerName()
getServerName
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
public int getServerPort()
getServerPort
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
public java.lang.String getRemoteAddr() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getRemoteAddr
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public java.lang.String getRemoteHost() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getRemoteHost
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public com.lutris.appserver.server.httpPresentation.HttpPresentationInputStream getInputStream() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getInputStream
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public java.lang.String getParameter(java.lang.String name) throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getParameter
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
name
- the name of the parameter whose value is required.
com.lutris.appserver.server.httpPresentation.HttpPresentationException
HttpPresentationRequest.getParameterValues(java.lang.String)
public java.lang.String[] getParameterValues(java.lang.String name) throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getParameterValues
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
name
- the name of the parameter whose value is required.
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public java.util.Enumeration getParameterNames() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getParameterNames
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public java.lang.String getMethod() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getMethod
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public java.lang.String getRequestURI() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getRequestURI
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public java.lang.String getPresentationURI() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getPresentationURI
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public java.lang.String getPresentationPath() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getPresentationPath
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public java.lang.String getPresentationObjectPath() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getPresentationObjectPath
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public java.lang.String getPresentationObjectRelativePath() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getPresentationObjectRelativePath
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public java.lang.String getApplicationPath() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getApplicationPath
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public java.lang.String getPathInfo() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getPathInfo
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public java.lang.String getPathTranslated() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getPathTranslated
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public java.lang.String getQueryString() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getQueryString
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public java.lang.String getRemoteUser() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getRemoteUser
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public java.lang.String getAuthType() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getAuthType
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public javax.servlet.http.Cookie[] getCookies() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getCookies
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public void setRequestedSessionIdFromCookie(boolean isFromCookie) throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
setRequestedSessionIdFromCookie
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public boolean isRequestedSessionIdFromCookie() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
isRequestedSessionIdFromCookie
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public void setRequestedSessionIdFromUrl(boolean isFromUrl) throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
setRequestedSessionIdFromUrl
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public boolean isRequestedSessionIdFromUrl() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
isRequestedSessionIdFromUrl
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public java.lang.String getHeader(java.lang.String name) throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getHeader
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
name
- the case-insensitive header field name
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public int getIntHeader(java.lang.String name) throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getIntHeader
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
name
- the case-insensitive header field name
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public long getDateHeader(java.lang.String name) throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getDateHeader
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
name
- the case-insensitive header field name
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public java.util.Enumeration getHeaderNames() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getHeaderNames
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public java.lang.String getAppFileURIPath(java.lang.String file) throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
getAppFileURIPath
in interface com.lutris.appserver.server.httpPresentation.HttpPresentationRequest
file
- File with in the application. Currently this must
be a path relative to the presentation prefix.
/
.
com.lutris.appserver.server.httpPresentation.HttpPresentationException
public int getTotalBytes()
com.lutris.http.debug.DebugRequest
public java.lang.String getPath() throws com.lutris.appserver.server.httpPresentation.HttpPresentationException
com.lutris.appserver.server.httpPresentation.HttpPresentationException
com.lutris.http.debug.DebugRequest
|
EAF 7.4 Implementation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |