org.apache.cactus.server
Class AbstractHttpServletRequestWrapper

java.lang.Object
  |
  +--org.apache.cactus.server.AbstractHttpServletRequestWrapper
All Implemented Interfaces:
javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest
Direct Known Subclasses:
HttpServletRequestWrapper

public abstract class AbstractHttpServletRequestWrapper
extends java.lang.Object
implements javax.servlet.http.HttpServletRequest

Abstract wrapper around HttpServletRequest. This class provides a common implementation of the wrapper for the different servlet API.

Version:
$Id: AbstractHttpServletRequestWrapper.java,v 1.2 2001/09/22 14:18:32 vmassol Exp $
Author:
Vincent Massol

Constructor Summary
AbstractHttpServletRequestWrapper(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.
 
Method Summary
 java.lang.Object getAttribute(java.lang.String theName)
           
 java.util.Enumeration getAttributeNames()
           
 java.lang.String getAuthType()
           
 java.lang.String getCharacterEncoding()
           
 int getContentLength()
           
 java.lang.String getContentType()
           
 java.lang.String getContextPath()
           
 javax.servlet.http.Cookie[] getCookies()
           
 long getDateHeader(java.lang.String theName)
           
 java.lang.String getHeader(java.lang.String theName)
           
 java.util.Enumeration getHeaderNames()
           
 java.util.Enumeration getHeaders(java.lang.String theName)
           
 javax.servlet.ServletInputStream getInputStream()
           
 int getIntHeader(java.lang.String theName)
           
 java.util.Locale getLocale()
           
 java.util.Enumeration getLocales()
           
 java.lang.String getMethod()
           
 javax.servlet.http.HttpServletRequest getOriginalRequest()
           
 java.lang.String getParameter(java.lang.String theName)
           
 java.util.Enumeration getParameterNames()
           
 java.lang.String[] getParameterValues(java.lang.String theName)
           
 java.lang.String getPathInfo()
           
 java.lang.String getPathTranslated()
           
 java.lang.String getProtocol()
           
 java.lang.String getQueryString()
           
 java.io.BufferedReader getReader()
           
 java.lang.String getRealPath(java.lang.String thePath)
           
 java.lang.String getRemoteAddr()
           
 java.lang.String getRemoteHost()
           
 java.lang.String getRemoteUser()
           
 javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String thePath)
           
 java.lang.String getRequestedSessionId()
           
 java.lang.String getRequestURI()
           
 java.lang.String getScheme()
           
 java.lang.String getServerName()
           
 int getServerPort()
           
 java.lang.String getServletPath()
           
 javax.servlet.http.HttpSession getSession()
           
 javax.servlet.http.HttpSession getSession(boolean isCreate)
           
 java.security.Principal getUserPrincipal()
           
 boolean isRequestedSessionIdFromCookie()
           
 boolean isRequestedSessionIdFromUrl()
           
 boolean isRequestedSessionIdFromURL()
           
 boolean isRequestedSessionIdValid()
           
 boolean isSecure()
           
 boolean isUserInRole(java.lang.String theRole)
           
 void removeAttribute(java.lang.String theName)
           
 void setAttribute(java.lang.String theName, java.lang.Object theAttribute)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractHttpServletRequestWrapper

public AbstractHttpServletRequestWrapper(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 request
theURL - the URL to simulate or null if none
Method Detail

getOriginalRequest

public javax.servlet.http.HttpServletRequest getOriginalRequest()
Returns:
the original request object

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.

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.

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.

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.

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.

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.

getPathTranslated

public java.lang.String getPathTranslated()
Specified by:
getPathTranslated in interface javax.servlet.http.HttpServletRequest
Returns:
any extra path information after the servlet name but before the query string, and translates it to a real path. Takes into account the simulated URL (if any).

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.

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String thePath)
Specified by:
getRequestDispatcher in interface javax.servlet.ServletRequest
Returns:
a wrapped request dispatcher instead of the real one, so that forward() and include() calls will use the wrapped dispatcher passing it the *original* request [this is needed for some servlet engine like Tomcat 3.x which do not support the new mechanism introduced by Servlet 2.3 Filters].

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()
Specified by:
isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdFromUrl

public boolean isRequestedSessionIdFromUrl()
Specified by:
isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest

isUserInRole

public boolean isUserInRole(java.lang.String theRole)
Specified by:
isUserInRole in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()
Specified by:
isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()
Specified by:
isRequestedSessionIdFromCookie 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

getHeaders

public java.util.Enumeration getHeaders(java.lang.String theName)
Specified by:
getHeaders in interface javax.servlet.http.HttpServletRequest

getHeaderNames

public java.util.Enumeration getHeaderNames()
Specified by:
getHeaderNames in interface javax.servlet.http.HttpServletRequest

getScheme

public java.lang.String getScheme()
Specified by:
getScheme in interface javax.servlet.ServletRequest

getAuthType

public java.lang.String getAuthType()
Specified by:
getAuthType in interface javax.servlet.http.HttpServletRequest

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

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

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String theName)
Specified by:
getParameterValues in interface javax.servlet.ServletRequest

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

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

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

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

getRequestedSessionId

public java.lang.String getRequestedSessionId()
Specified by:
getRequestedSessionId in interface javax.servlet.http.HttpServletRequest

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.