servlet::HttpServletRequestWrapper Class Reference

#include <HttpServletRequestWrapper.h>

Inheritance diagram for servlet::HttpServletRequestWrapper:

[legend]

Collaboration diagram for servlet::HttpServletRequestWrapper:

[legend]

List of all members.

Public Member Functions
	HttpServletRequestWrapper (HttpServletRequest *request)
virtual std::string	getAuthType () const
virtual std::auto_ptr < cookielist_t >	getCookies () const
virtual long	getDateHeader (const std::string &name) const
virtual std::string	getHeader (const std::string &name) const
virtual std::auto_ptr < std::vector< std::string > >	getHeaders (const std::string &name) const
virtual std::auto_ptr < std::vector< std::string > >	getHeaderNames () const
virtual int	getIntHeader (const std::string &name) const
virtual std::string	getMethod () const
virtual std::string	getPathInfo () const
virtual std::string	getPathTranslated () const
virtual std::string	getContextPath () const
virtual std::string	getQueryString () const
virtual std::string	getRemoteUser () const
virtual bool	isUserInRole (const std::string &role) const
virtual std::string	getRequestedSessionId () const
virtual std::string	getRequestURI () const
virtual std::string	getRequestURL () const
virtual std::string	getServletPath () const
virtual HttpSession *	getSession (bool create=true)
virtual bool	isRequestedSessionIdValid () const
virtual bool	isRequestedSessionIdFromCookie () const
virtual bool	isRequestedSessionIdFromURL () const
virtual UploadedFile *	getUploadedFile (const std::string &name)
Private Member Functions
HttpServletRequest *	_getHttpServletRequest ()
const HttpServletRequest *	_getHttpServletRequest () const

---

Detailed Description

Provides a convenient implementation of the HttpServletRequest interface that can be subclassed by developers wishing to adapt the request to a Servlet. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped request object.

See also:

javax.servlet.http.HttpServletRequest

Since:

v 2.3

Definition at line 39 of file HttpServletRequestWrapper.h.

---

Constructor & Destructor Documentation

servlet::HttpServletRequestWrapper::HttpServletRequestWrapper

(

HttpServletRequest *

request

)

[inline]

Constructs a request object wrapping the given request->

Exceptions:

java->lang->IllegalArgumentException

if the request is null

Definition at line 55 of file HttpServletRequestWrapper.h.

---

Member Function Documentation

const HttpServletRequest* servlet::HttpServletRequestWrapper::_getHttpServletRequest

(

)

const [inline, private]

Definition at line 46 of file HttpServletRequestWrapper.h.

References servlet::ServletRequestWrapper::getRequest().

Here is the call graph for this function:

HttpServletRequest* servlet::HttpServletRequestWrapper::_getHttpServletRequest

(

)

[inline, private]

Definition at line 43 of file HttpServletRequestWrapper.h.

References servlet::ServletRequestWrapper::getRequest().

Referenced by getAuthType(), getContextPath(), getCookies(), getDateHeader(), getHeader(), getHeaderNames(), getHeaders(), getIntHeader(), getMethod(), getPathInfo(), getPathTranslated(), getQueryString(), getRemoteUser(), getRequestedSessionId(), getRequestURI(), getRequestURL(), getServletPath(), getSession(), getUploadedFile(), isRequestedSessionIdFromCookie(), isRequestedSessionIdFromURL(), isRequestedSessionIdValid(), and isUserInRole().

Here is the call graph for this function:

virtual std::string servlet::HttpServletRequestWrapper::getAuthType

(

)

const [inline, virtual]

The default behavior of this method is to return getAuthType() on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 64 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::getAuthType().

Here is the call graph for this function:

virtual std::string servlet::HttpServletRequestWrapper::getContextPath

(

)

const [inline, virtual]

The default behavior of this method is to return getContextPath() on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 147 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::getContextPath().

Here is the call graph for this function:

virtual std::auto_ptr< cookielist_t > servlet::HttpServletRequestWrapper::getCookies

(

)

const [inline, virtual]

The default behavior of this method is to return getCookies() on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 72 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::getCookies().

Here is the call graph for this function:

virtual long servlet::HttpServletRequestWrapper::getDateHeader

(

const std::string &

name

)

const [inline, virtual]

The default behavior of this method is to return getDateHeader(std::string name) on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 80 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::getDateHeader().

Here is the call graph for this function:

virtual std::string servlet::HttpServletRequestWrapper::getHeader

(

const std::string &

name

)

const [inline, virtual]

The default behavior of this method is to return getHeader(std::string name) on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 88 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::getHeader().

Here is the call graph for this function:

virtual std::auto_ptr< std::vector<std::string> > servlet::HttpServletRequestWrapper::getHeaderNames

(

)

const [inline, virtual]

The default behavior of this method is to return getHeaderNames() on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 105 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::getHeaderNames().

Here is the call graph for this function:

virtual std::auto_ptr< std::vector<std::string> > servlet::HttpServletRequestWrapper::getHeaders

(

const std::string &

name

)

const [inline, virtual]

The default behavior of this method is to return getHeaders(std::string name) on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 96 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::getHeaders().

Here is the call graph for this function:

virtual int servlet::HttpServletRequestWrapper::getIntHeader

(

const std::string &

name

)

const [inline, virtual]

The default behavior of this method is to return getIntHeader(std::string name) on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 114 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::getIntHeader().

Here is the call graph for this function:

virtual std::string servlet::HttpServletRequestWrapper::getMethod

(

)

const [inline, virtual]

The default behavior of this method is to return getMethod() on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 122 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::getMethod().

Here is the call graph for this function:

virtual std::string servlet::HttpServletRequestWrapper::getPathInfo

(

)

const [inline, virtual]

The default behavior of this method is to return getPathInfo() on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 130 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::getPathInfo().

Here is the call graph for this function:

virtual std::string servlet::HttpServletRequestWrapper::getPathTranslated

(

)

const [inline, virtual]

The default behavior of this method is to return getPathTranslated() on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 139 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::getPathTranslated().

Here is the call graph for this function:

virtual std::string servlet::HttpServletRequestWrapper::getQueryString

(

)

const [inline, virtual]

The default behavior of this method is to return getQuerystd::string() on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 155 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::getQueryString().

Here is the call graph for this function:

virtual std::string servlet::HttpServletRequestWrapper::getRemoteUser

(

)

const [inline, virtual]

The default behavior of this method is to return getRemoteUser() on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 163 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::getRemoteUser().

Here is the call graph for this function:

virtual std::string servlet::HttpServletRequestWrapper::getRequestedSessionId

(

)

const [inline, virtual]

The default behavior of this method is to return getRequestedSessionId() on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 180 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::getRequestedSessionId().

Here is the call graph for this function:

virtual std::string servlet::HttpServletRequestWrapper::getRequestURI

(

)

const [inline, virtual]

The default behavior of this method is to return getRequestURI() on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 188 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::getRequestURI().

Here is the call graph for this function:

virtual std::string servlet::HttpServletRequestWrapper::getRequestURL

(

)

const [inline, virtual]

The default behavior of this method is to return getRequestURL() on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 195 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::getRequestURL().

Here is the call graph for this function:

virtual std::string servlet::HttpServletRequestWrapper::getServletPath

(

)

const [inline, virtual]

The default behavior of this method is to return getServletPath() on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 204 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::getServletPath().

Here is the call graph for this function:

virtual HttpSession* servlet::HttpServletRequestWrapper::getSession

(

bool

create = true

)

[inline, virtual]

The default behavior of this method is to return getSession(boolean create) on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 213 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::getSession().

Here is the call graph for this function:

virtual UploadedFile* servlet::HttpServletRequestWrapper::getUploadedFile

(

const std::string &

)

[inline, virtual]

Returns named uploaded file

Implements servlet::HttpServletRequest.

Definition at line 241 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::getUploadedFile().

Here is the call graph for this function:

virtual bool servlet::HttpServletRequestWrapper::isRequestedSessionIdFromCookie

(

)

const [inline, virtual]

The default behavior of this method is to return isRequestedSessionIdFromCookie() on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 230 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::isRequestedSessionIdFromCookie().

Here is the call graph for this function:

virtual bool servlet::HttpServletRequestWrapper::isRequestedSessionIdFromURL

(

)

const [inline, virtual]

The default behavior of this method is to return isRequestedSessionIdFromURL() on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 238 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::isRequestedSessionIdFromURL().

Here is the call graph for this function:

virtual bool servlet::HttpServletRequestWrapper::isRequestedSessionIdValid

(

)

const [inline, virtual]

The default behavior of this method is to return isRequestedSessionIdValid() on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 222 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::isRequestedSessionIdValid().

Here is the call graph for this function:

virtual bool servlet::HttpServletRequestWrapper::isUserInRole

(

const std::string &

role

)

const [inline, virtual]

The default behavior of this method is to return isUserInRole(std::string role) on the wrapped request object.

Implements servlet::HttpServletRequest.

Definition at line 172 of file HttpServletRequestWrapper.h.

References _getHttpServletRequest(), and servlet::HttpServletRequest::isUserInRole().

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• include/servlet/HttpServletRequestWrapper.h