servlet::ServletRequestWrapper Class Reference

#include <ServletRequestWrapper.h>

Inheritance diagram for servlet::ServletRequestWrapper:

[legend]

Collaboration diagram for servlet::ServletRequestWrapper:

[legend]

List of all members.

Public Member Functions
	ServletRequestWrapper (ServletRequest *request)
ServletRequest *	getRequest ()
const ServletRequest *	getRequest () const
void	setRequest (ServletRequest *request)
virtual boost::shared_ptr< void >	getAttribute (const std::string &name)
virtual bool	hasAttribute (const std::string &name) const
virtual std::auto_ptr < std::vector< std::string > >	getAttributeNames () const
virtual std::string	getCharacterEncoding () const
virtual void	setCharacterEncoding (const std::string &enc)
virtual int	getContentLength () const
virtual std::string	getContentType () const
virtual std::istream &	getInputStream ()
virtual std::string	getParameter (const std::string &name) const
virtual std::auto_ptr < std::multimap< std::string, std::string > >	getParameterMap () const
virtual std::auto_ptr < std::vector< std::string > >	getParameterNames () const
virtual std::auto_ptr < std::vector< std::string > >	getParameterValues (const std::string &name) const
virtual std::string	getProtocol () const
virtual std::string	getScheme () const
virtual std::string	getServerName () const
virtual int	getServerPort () const
virtual std::string	getRemoteAddr () const
virtual std::string	getRemoteHost () const
virtual void	setAttribute (const std::string &name, boost::shared_ptr< void > t)
virtual void	removeAttribute (const std::string &name)
virtual bool	isSecure () const
virtual RequestDispatcher *	getRequestDispatcher (const std::string &path)
virtual int	getRemotePort () const
virtual std::string	getLocalName () const
virtual std::string	getLocalAddr () const
virtual int	getLocalPort () const
Private Attributes
ServletRequest *	request

---

Detailed Description

Provides a convenient implementation of the ServletRequest 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.

Since:

v 2.3

See also:

javax.servlet.ServletRequest

Definition at line 39 of file ServletRequestWrapper.h.

---

Constructor & Destructor Documentation

servlet::ServletRequestWrapper::ServletRequestWrapper

(

ServletRequest *

request

)

[inline]

Creates a ServletRequest adaptor wrapping the given request object.

Exceptions:

java.lang.IllegalArgumentException

if the request is null

Definition at line 47 of file ServletRequestWrapper.h.

---

Member Function Documentation

virtual boost::shared_ptr<void> servlet::ServletRequestWrapper::getAttribute

(

const std::string &

name

)

[inline, virtual]

The default behavior of this method is to call getAttribute(String name) on the wrapped request object.

Implements servlet::ServletRequest.

Definition at line 78 of file ServletRequestWrapper.h.

References servlet::ServletRequest::getAttribute(), and request.

Here is the call graph for this function:

virtual std::auto_ptr< std::vector<std::string> > servlet::ServletRequestWrapper::getAttributeNames

(

)

const [inline, virtual]

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

Implements servlet::ServletRequest.

Definition at line 97 of file ServletRequestWrapper.h.

References servlet::ServletRequest::getAttributeNames(), and request.

Here is the call graph for this function:

virtual std::string servlet::ServletRequestWrapper::getCharacterEncoding

(

)

const [inline, virtual]

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

Implements servlet::ServletRequest.

Definition at line 108 of file ServletRequestWrapper.h.

References servlet::ServletRequest::getCharacterEncoding(), and request.

Here is the call graph for this function:

virtual int servlet::ServletRequestWrapper::getContentLength

(

)

const [inline, virtual]

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

Implements servlet::ServletRequest.

Definition at line 126 of file ServletRequestWrapper.h.

References servlet::ServletRequest::getContentLength(), and request.

Here is the call graph for this function:

virtual std::string servlet::ServletRequestWrapper::getContentType

(

)

const [inline, virtual]

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

Implements servlet::ServletRequest.

Definition at line 134 of file ServletRequestWrapper.h.

References servlet::ServletRequest::getContentType(), and request.

Here is the call graph for this function:

virtual std::istream& servlet::ServletRequestWrapper::getInputStream

(

)

[inline, virtual]

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

Implements servlet::ServletRequest.

Definition at line 143 of file ServletRequestWrapper.h.

References servlet::ServletRequest::getInputStream(), and request.

Here is the call graph for this function:

virtual std::string servlet::ServletRequestWrapper::getLocalAddr

(

)

const [inline, virtual]

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

Since:

2.4

Implements servlet::ServletRequest.

Definition at line 296 of file ServletRequestWrapper.h.

References servlet::ServletRequest::getLocalAddr(), and request.

Here is the call graph for this function:

virtual std::string servlet::ServletRequestWrapper::getLocalName

(

)

const [inline, virtual]

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

Since:

2.4

Implements servlet::ServletRequest.

Definition at line 285 of file ServletRequestWrapper.h.

References servlet::ServletRequest::getLocalName(), and request.

Here is the call graph for this function:

virtual int servlet::ServletRequestWrapper::getLocalPort

(

)

const [inline, virtual]

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

Since:

2.4

Implements servlet::ServletRequest.

Definition at line 306 of file ServletRequestWrapper.h.

References servlet::ServletRequest::getLocalPort(), and request.

Here is the call graph for this function:

virtual std::string servlet::ServletRequestWrapper::getParameter

(

const std::string &

name

)

const [inline, virtual]

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

Implements servlet::ServletRequest.

Definition at line 152 of file ServletRequestWrapper.h.

References servlet::ServletRequest::getParameter(), and request.

Here is the call graph for this function:

virtual std::auto_ptr< std::multimap<std::string,std::string> > servlet::ServletRequestWrapper::getParameterMap

(

)

const [inline, virtual]

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

Implements servlet::ServletRequest.

Definition at line 160 of file ServletRequestWrapper.h.

References servlet::ServletRequest::getParameterMap(), and request.

Here is the call graph for this function:

virtual std::auto_ptr< std::vector<std::string> > servlet::ServletRequestWrapper::getParameterNames

(

)

const [inline, virtual]

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

Implements servlet::ServletRequest.

Definition at line 168 of file ServletRequestWrapper.h.

References servlet::ServletRequest::getParameterNames(), and request.

Here is the call graph for this function:

virtual std::auto_ptr< std::vector<std::string> > servlet::ServletRequestWrapper::getParameterValues

(

const std::string &

name

)

const [inline, virtual]

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

Implements servlet::ServletRequest.

Definition at line 176 of file ServletRequestWrapper.h.

References servlet::ServletRequest::getParameterValues(), and request.

Here is the call graph for this function:

virtual std::string servlet::ServletRequestWrapper::getProtocol

(

)

const [inline, virtual]

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

Implements servlet::ServletRequest.

Definition at line 185 of file ServletRequestWrapper.h.

References servlet::ServletRequest::getProtocol(), and request.

Here is the call graph for this function:

virtual std::string servlet::ServletRequestWrapper::getRemoteAddr

(

)

const [inline, virtual]

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

Implements servlet::ServletRequest.

Definition at line 219 of file ServletRequestWrapper.h.

References servlet::ServletRequest::getRemoteAddr(), and request.

Here is the call graph for this function:

virtual std::string servlet::ServletRequestWrapper::getRemoteHost

(

)

const [inline, virtual]

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

Implements servlet::ServletRequest.

Definition at line 228 of file ServletRequestWrapper.h.

References servlet::ServletRequest::getRemoteHost(), and request.

Here is the call graph for this function:

virtual int servlet::ServletRequestWrapper::getRemotePort

(

)

const [inline, virtual]

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

Since:

2.4

Implements servlet::ServletRequest.

Definition at line 274 of file ServletRequestWrapper.h.

References servlet::ServletRequest::getRemotePort(), and request.

Here is the call graph for this function:

const ServletRequest* servlet::ServletRequestWrapper::getRequest

(

)

const [inline]

Definition at line 56 of file ServletRequestWrapper.h.

References request.

ServletRequest* servlet::ServletRequestWrapper::getRequest

(

)

[inline]

Return the wrapped request object.

Definition at line 53 of file ServletRequestWrapper.h.

References request.

Referenced by servlet::HttpServletRequestWrapper::_getHttpServletRequest().

virtual RequestDispatcher* servlet::ServletRequestWrapper::getRequestDispatcher

(

const std::string &

path

)

[inline, virtual]

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

Implements servlet::ServletRequest.

Definition at line 263 of file ServletRequestWrapper.h.

References servlet::ServletRequest::getRequestDispatcher(), and request.

Here is the call graph for this function:

virtual std::string servlet::ServletRequestWrapper::getScheme

(

)

const [inline, virtual]

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

Implements servlet::ServletRequest.

Definition at line 193 of file ServletRequestWrapper.h.

References servlet::ServletRequest::getScheme(), and request.

Referenced by container::ForwardedRequestWrapper::getRequestURL().

Here is the call graph for this function:

virtual std::string servlet::ServletRequestWrapper::getServerName

(

)

const [inline, virtual]

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

Implements servlet::ServletRequest.

Definition at line 201 of file ServletRequestWrapper.h.

References servlet::ServletRequest::getServerName(), and request.

Referenced by container::ForwardedRequestWrapper::getRequestURL().

Here is the call graph for this function:

virtual int servlet::ServletRequestWrapper::getServerPort

(

)

const [inline, virtual]

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

Implements servlet::ServletRequest.

Definition at line 210 of file ServletRequestWrapper.h.

References servlet::ServletRequest::getServerPort(), and request.

Referenced by container::ForwardedRequestWrapper::getRequestURL().

Here is the call graph for this function:

virtual bool servlet::ServletRequestWrapper::hasAttribute

(

const std::string &

name

)

const [inline, virtual]

The default behavior of this method is to call getAttribute(String name) on the wrapped request object.

Implements servlet::ServletRequest.

Definition at line 88 of file ServletRequestWrapper.h.

References servlet::ServletRequest::hasAttribute(), and request.

Here is the call graph for this function:

virtual bool servlet::ServletRequestWrapper::isSecure

(

)

const [inline, virtual]

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

Implements servlet::ServletRequest.

Definition at line 254 of file ServletRequestWrapper.h.

References servlet::ServletRequest::isSecure(), and request.

Here is the call graph for this function:

virtual void servlet::ServletRequestWrapper::removeAttribute

(

const std::string &

name

)

[inline, virtual]

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

Implements servlet::ServletRequest.

Definition at line 245 of file ServletRequestWrapper.h.

References servlet::ServletRequest::removeAttribute(), and request.

Here is the call graph for this function:

virtual void servlet::ServletRequestWrapper::setAttribute	(	const std::string &	name,
		boost::shared_ptr< void >	t
	)			[inline, virtual]

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

Implements servlet::ServletRequest.

Definition at line 237 of file ServletRequestWrapper.h.

References request, and servlet::ServletRequest::setAttribute().

Here is the call graph for this function:

virtual void servlet::ServletRequestWrapper::setCharacterEncoding

(

const std::string &

enc

)

[inline, virtual]

The default behavior of this method is to set the character encoding on the wrapped request object.

Implements servlet::ServletRequest.

Definition at line 117 of file ServletRequestWrapper.h.

References request, and servlet::ServletRequest::setCharacterEncoding().

Here is the call graph for this function:

void servlet::ServletRequestWrapper::setRequest

(

ServletRequest *

request

)

[inline]

Sets the request object being wrapped.

Exceptions:

java.lang.IllegalArgumentException

if the request is null.

Definition at line 65 of file ServletRequestWrapper.h.

---

Member Data Documentation

ServletRequest* servlet::ServletRequestWrapper::request [private]

Definition at line 41 of file ServletRequestWrapper.h.

Referenced by getAttribute(), getAttributeNames(), getCharacterEncoding(), getContentLength(), getContentType(), getInputStream(), getLocalAddr(), getLocalName(), getLocalPort(), getParameter(), getParameterMap(), getParameterNames(), getParameterValues(), getProtocol(), getRemoteAddr(), getRemoteHost(), getRemotePort(), getRequest(), getRequestDispatcher(), getScheme(), getServerName(), getServerPort(), hasAttribute(), isSecure(), removeAttribute(), setAttribute(), and setCharacterEncoding().

---

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

• include/servlet/ServletRequestWrapper.h