org.apache.commons.cactus.server
Class HttpServletRequestWrapper
java.lang.Object
|
+--org.apache.commons.cactus.server.HttpServletRequestWrapper
- All Implemented Interfaces:
- javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest
- public class HttpServletRequestWrapper
- extends java.lang.Object
- implements javax.servlet.http.HttpServletRequest
Encapsulation class for the Servlet 2.2 API HttpServletRequest
.
This is an implementation that delegates all the call to the
HttpServletRequest
object passed in the constructor except for
some overridden methods which are use to simulate a URL. This is to be able to
simulate any URL that would have been used to call the test method : if this
was not done, the URL that would be returned (by calling the
getRequestURI()
method or others alike) would be the URL of the
server redirector servlet or JSP and not a URL that the test case want to
simulate.
- Version:
- 1.1
Constructor Summary |
HttpServletRequestWrapper(javax.servlet.http.HttpServletRequest theRequest,
ServletURL theURL)
Construct an HttpServletRequest instance that delegates
it's method calls to the request object passed as parameter and that
uses the URL passed as parameter to simulate a URL from which the request
would come from. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
HttpServletRequestWrapper
public HttpServletRequestWrapper(javax.servlet.http.HttpServletRequest theRequest,
ServletURL theURL)
- Construct an
HttpServletRequest
instance that delegates
it's method calls to the request object passed as parameter and that
uses the URL passed as parameter to simulate a URL from which the request
would come from.
- Parameters:
theRequest
- the real HTTP requesttheURL
- the URL to simulate or null
if none
getOriginalRequest
public javax.servlet.http.HttpServletRequest getOriginalRequest()
isRequestedSessionIdFromURL
public boolean isRequestedSessionIdFromURL()
- Specified by:
isRequestedSessionIdFromURL
in interface javax.servlet.http.HttpServletRequest
getLocales
public java.util.Enumeration getLocales()
- Specified by:
getLocales
in interface javax.servlet.ServletRequest
getHeader
public java.lang.String getHeader(java.lang.String theName)
- Specified by:
getHeader
in interface javax.servlet.http.HttpServletRequest
getContextPath
public java.lang.String getContextPath()
- Specified by:
getContextPath
in interface javax.servlet.http.HttpServletRequest
- Returns:
- the context path from the simulated URL or the real context path
if a simulation URL has not been defined.
getScheme
public java.lang.String getScheme()
- Specified by:
getScheme
in interface javax.servlet.ServletRequest
getPathInfo
public java.lang.String getPathInfo()
- Specified by:
getPathInfo
in interface javax.servlet.http.HttpServletRequest
- Returns:
- the path info from the simulated URL or the real path info
if a simulation URL has not been defined.
getAuthType
public java.lang.String getAuthType()
- Specified by:
getAuthType
in interface javax.servlet.http.HttpServletRequest
getServerName
public java.lang.String getServerName()
- Specified by:
getServerName
in interface javax.servlet.ServletRequest
- Returns:
- the server name from the simulated URL or the real server name
if a simulation URL has not been defined.
getRealPath
public java.lang.String getRealPath(java.lang.String thePath)
- Specified by:
getRealPath
in interface javax.servlet.ServletRequest
getSession
public javax.servlet.http.HttpSession getSession()
- Specified by:
getSession
in interface javax.servlet.http.HttpServletRequest
getSession
public javax.servlet.http.HttpSession getSession(boolean isCreate)
- Specified by:
getSession
in interface javax.servlet.http.HttpServletRequest
getRemoteHost
public java.lang.String getRemoteHost()
- Specified by:
getRemoteHost
in interface javax.servlet.ServletRequest
getHeaderNames
public java.util.Enumeration getHeaderNames()
- Specified by:
getHeaderNames
in interface javax.servlet.http.HttpServletRequest
isUserInRole
public boolean isUserInRole(java.lang.String theRole)
- Specified by:
isUserInRole
in interface javax.servlet.http.HttpServletRequest
getServerPort
public int getServerPort()
- Specified by:
getServerPort
in interface javax.servlet.ServletRequest
- Returns:
- the server port number from the simulated URL or the real server
port number if a simulation URL has not been defined. If not
port is defined, then port 80 is returned.
getReader
public java.io.BufferedReader getReader()
throws java.io.IOException
- Specified by:
getReader
in interface javax.servlet.ServletRequest
getContentLength
public int getContentLength()
- Specified by:
getContentLength
in interface javax.servlet.ServletRequest
getRequestURI
public java.lang.String getRequestURI()
- Specified by:
getRequestURI
in interface javax.servlet.http.HttpServletRequest
- Returns:
- the URI from the simulated URL or the real URI
if a simulation URL has not been defined.
getParameterValues
public java.lang.String[] getParameterValues(java.lang.String theName)
- Specified by:
getParameterValues
in interface javax.servlet.ServletRequest
isRequestedSessionIdFromUrl
public boolean isRequestedSessionIdFromUrl()
- Specified by:
isRequestedSessionIdFromUrl
in interface javax.servlet.http.HttpServletRequest
getContentType
public java.lang.String getContentType()
- Specified by:
getContentType
in interface javax.servlet.ServletRequest
getLocale
public java.util.Locale getLocale()
- Specified by:
getLocale
in interface javax.servlet.ServletRequest
removeAttribute
public void removeAttribute(java.lang.String theName)
- Specified by:
removeAttribute
in interface javax.servlet.ServletRequest
getParameter
public java.lang.String getParameter(java.lang.String theName)
- Specified by:
getParameter
in interface javax.servlet.ServletRequest
getServletPath
public java.lang.String getServletPath()
- Specified by:
getServletPath
in interface javax.servlet.http.HttpServletRequest
- Returns:
- the servlet path from the simulated URL or the real servlet path
if a simulation URL has not been defined.
isRequestedSessionIdFromCookie
public boolean isRequestedSessionIdFromCookie()
- Specified by:
isRequestedSessionIdFromCookie
in interface javax.servlet.http.HttpServletRequest
getInputStream
public javax.servlet.ServletInputStream getInputStream()
throws java.io.IOException
- Specified by:
getInputStream
in interface javax.servlet.ServletRequest
getUserPrincipal
public java.security.Principal getUserPrincipal()
- Specified by:
getUserPrincipal
in interface javax.servlet.http.HttpServletRequest
isSecure
public boolean isSecure()
- Specified by:
isSecure
in interface javax.servlet.ServletRequest
getPathTranslated
public java.lang.String getPathTranslated()
- Specified by:
getPathTranslated
in interface javax.servlet.http.HttpServletRequest
getRemoteAddr
public java.lang.String getRemoteAddr()
- Specified by:
getRemoteAddr
in interface javax.servlet.ServletRequest
getCharacterEncoding
public java.lang.String getCharacterEncoding()
- Specified by:
getCharacterEncoding
in interface javax.servlet.ServletRequest
getParameterNames
public java.util.Enumeration getParameterNames()
- Specified by:
getParameterNames
in interface javax.servlet.ServletRequest
getMethod
public java.lang.String getMethod()
- Specified by:
getMethod
in interface javax.servlet.http.HttpServletRequest
setAttribute
public void setAttribute(java.lang.String theName,
java.lang.Object theAttribute)
- Specified by:
setAttribute
in interface javax.servlet.ServletRequest
getAttribute
public java.lang.Object getAttribute(java.lang.String theName)
- Specified by:
getAttribute
in interface javax.servlet.ServletRequest
getIntHeader
public int getIntHeader(java.lang.String theName)
- Specified by:
getIntHeader
in interface javax.servlet.http.HttpServletRequest
isRequestedSessionIdValid
public boolean isRequestedSessionIdValid()
- Specified by:
isRequestedSessionIdValid
in interface javax.servlet.http.HttpServletRequest
getQueryString
public java.lang.String getQueryString()
- Specified by:
getQueryString
in interface javax.servlet.http.HttpServletRequest
- Returns:
- the query string from the simulated URL or the real query
string if a simulation URL has not been defined.
getDateHeader
public long getDateHeader(java.lang.String theName)
- Specified by:
getDateHeader
in interface javax.servlet.http.HttpServletRequest
getAttributeNames
public java.util.Enumeration getAttributeNames()
- Specified by:
getAttributeNames
in interface javax.servlet.ServletRequest
getRemoteUser
public java.lang.String getRemoteUser()
- Specified by:
getRemoteUser
in interface javax.servlet.http.HttpServletRequest
getProtocol
public java.lang.String getProtocol()
- Specified by:
getProtocol
in interface javax.servlet.ServletRequest
getHeaders
public java.util.Enumeration getHeaders(java.lang.String theName)
- Specified by:
getHeaders
in interface javax.servlet.http.HttpServletRequest
getRequestedSessionId
public java.lang.String getRequestedSessionId()
- Specified by:
getRequestedSessionId
in interface javax.servlet.http.HttpServletRequest
getRequestDispatcher
public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String thePath)
- Specified by:
getRequestDispatcher
in interface javax.servlet.ServletRequest
getCookies
public javax.servlet.http.Cookie[] getCookies()
- Specified by:
getCookies
in interface javax.servlet.http.HttpServletRequest
Copyright © 2000-2001 Apache Software Foundation. All Rights Reserved.