servlet::ServletRequest Class Reference

#include <ServletRequest.h>

Inheritance diagram for servlet::ServletRequest:


Public Member Functions
virtual	~ServletRequest ()
virtual boost::shared_ptr< void >	getAttribute (const std::string &name)=0
template<typename T >
T	getAttribute (const std::string &name)
virtual bool	hasAttribute (const std::string &name) const =0
virtual std::auto_ptr < std::vector< std::string > >	getAttributeNames () const =0
virtual void	setAttribute (const std::string &name, boost::shared_ptr< void > o)=0
template<typename T >
void	setAttribute (const std::string &name, boost::shared_ptr< T > o)
template<typename T >
void	setAttribute (const std::string &name, const T &o)
virtual void	removeAttribute (const std::string &name)=0
virtual std::string	getCharacterEncoding () const =0
virtual void	setCharacterEncoding (const std::string &env)=0
virtual int	getContentLength () const =0
virtual std::string	getContentType () const =0
virtual std::istream &	getInputStream ()=0
virtual std::string	getParameter (const std::string &name) const =0
virtual std::auto_ptr < std::vector< std::string > >	getParameterNames () const =0
virtual std::auto_ptr < std::vector< std::string > >	getParameterValues (const std::string &name) const =0
virtual std::auto_ptr < std::multimap< std::string, std::string > >	getParameterMap () const =0
virtual std::string	getProtocol () const =0
virtual std::string	getScheme () const =0
virtual std::string	getServerName () const =0
virtual int	getServerPort () const =0
virtual std::string	getRemoteAddr () const =0
virtual std::string	getRemoteHost () const =0
virtual bool	isSecure () const =0
virtual RequestDispatcher *	getRequestDispatcher (const std::string &path)=0
virtual int	getRemotePort () const =0
virtual std::string	getLocalName () const =0
virtual std::string	getLocalAddr () const =0
virtual int	getLocalPort () const =0

Detailed Description

ServletRequest

Defines an object to provide client request information to a servlet. The servlet container creates a ServletRequest object and passes it as an argument to the servlet's service method.

A ServletRequest object provides data including parameter name and values, attributes, and an input stream. Interfaces that extend ServletRequest can provide additional protocol-specific data (for example, HTTP data is provided by servlet::HttpServletRequest.

Author:: Various

Version:: $Version$

See also:: servlet::HttpServletRequest

Definition at line 90 of file ServletRequest.h.

Constructor & Destructor Documentation

virtual servlet::ServletRequest::~ServletRequest ( ) [inline, virtual]

Definition at line 92 of file ServletRequest.h.

Member Function Documentation

template<typename T >

T servlet::ServletRequest::getAttribute ( const std::string & name ) [inline]

Reimplemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

T servlet::ServletRequest::getAttribute ( const std::string & name ) [inline, pure virtual]

Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.

Attributes can be set two ways. The servlet container may set attributes to make available custom information about a request. For example, for requests made using HTTPS, the attribute javax.servlet.request.X509Certificate can be used to retrieve information on the certificate of the client. Attributes can also be set programatically using servlet::ServletRequest#setAttribute. This allows information to be embedded into a request before a servlet::RequestDispatcher call.

Attribute names should follow the same conventions as package names. This specification reserves names matching java.*, javax.*, and sun.*.

Parameters:

name a String specifying the name of the attribute

Returns:: an Object containing the value of the attribute, or null if the attribute does not exist

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Definition at line 552 of file ServletRequest.h.

Referenced by servlet::ServletRequestWrapper::getAttribute().

virtual std::auto_ptr< std::vector<std::string> > servlet::ServletRequest::getAttributeNames ( ) const [pure virtual]

Returns an Enumeration containing the names of the attributes available to this request. This method returns an empty Enumeration if the request has no attributes available to it.

Returns:: an Enumeration of strings containing the names of the request's attributes

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::getAttributeNames().

virtual std::string servlet::ServletRequest::getCharacterEncoding ( ) const [pure virtual]

Returns the name of the character encoding used in the body of this request. This method returns null if the request does not specify a character encoding

Returns:: a String containing the name of the character encoding, or null if the request does not specify a character encoding

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::getCharacterEncoding().

virtual int servlet::ServletRequest::getContentLength ( ) const [pure virtual]

Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.

Returns:: an integer containing the length of the request body or -1 if the length is not known

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::getContentLength().

virtual std::string servlet::ServletRequest::getContentType ( ) const [pure virtual]

Returns the MIME type of the body of the request, or null if the type is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_TYPE.

Returns:: a String containing the name of the MIME type of the request, or null if the type is not known

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::getContentType().

virtual std::istream& servlet::ServletRequest::getInputStream ( ) [pure virtual]

Retrieves the body of the request as binary data using a std::istream. Either this method or getReader may be called to read the body, not both.

Returns:: a servlet::ServletInputStream object containing the body of the request

Exceptions:

	IllegalStateException	if the getReader method has already been called for this request
	IOException	if an input or output exception occurred

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::getInputStream().

virtual std::string servlet::ServletRequest::getLocalAddr ( ) const [pure virtual]

Returns the Internet Protocol (IP) address of the interface on which the request was received.

Returns:: a String containing the IP address on which the request was received.

Since:: 2.4

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::getLocalAddr().

virtual std::string servlet::ServletRequest::getLocalName ( ) const [pure virtual]

Returns the host name of the Internet Protocol (IP) interface on which the request was received.

Returns:: a String containing the host name of the IP on which the request was received.

Since:: 2.4

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::getLocalName().

virtual int servlet::ServletRequest::getLocalPort ( ) const [pure virtual]

Returns the Internet Protocol (IP) port number of the interface on which the request was received.

Returns:: an integer specifying the port number

Since:: 2.4

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::getLocalPort().

virtual std::string servlet::ServletRequest::getParameter ( const std::string & name ) const [pure virtual]

Returns the value of a request parameter as a String, or null if the parameter does not exist. Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.

You should only use this method when you are sure the parameter has only one value. If the parameter might have more than one value, use getParameterValues.

If you use this method with a multivalued parameter, the value returned is equal to the first value in the array returned by getParameterValues.

If the parameter data was sent in the request body, such as occurs with an HTTP POST request, then reading the body directly via getInputStream or getReader can interfere with the execution of this method.

Parameters:

name a String specifying the name of the parameter

Returns:: a String representing the single value of the parameter

See also:: getParameterValues

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::getParameter().

virtual std::auto_ptr< std::multimap<std::string,std::string> > servlet::ServletRequest::getParameterMap ( ) const [pure virtual]

Returns a java.util.Map of the parameters of this request. Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.

Returns:: an immutable java.util.Map containing parameter names as keys and parameter values as map values. The keys in the parameter map are of type String. The values in the parameter map are of type String array.

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::getParameterMap().

virtual std::auto_ptr< std::vector<std::string> > servlet::ServletRequest::getParameterNames ( ) const [pure virtual]

Returns an Enumeration of String objects containing the names of the parameters contained in this request. If the request has no parameters, the method returns an empty Enumeration.

Returns:: an Enumeration of String objects, each String containing the name of a request parameter; or an empty Enumeration if the request has no parameters

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::getParameterNames().

virtual std::auto_ptr< std::vector<std::string> > servlet::ServletRequest::getParameterValues ( const std::string & name ) const [pure virtual]

Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.

If the parameter has a single value, the array has a length of 1.

Parameters:

name a String containing the name of the parameter whose value is requested

Returns:: an array of String objects containing the parameter's values

See also:: getParameter

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::getParameterValues().

virtual std::string servlet::ServletRequest::getProtocol ( ) const [pure virtual]

Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1. For HTTP servlets, the value returned is the same as the value of the CGI variable SERVER_PROTOCOL.

Returns:: a String containing the protocol name and version number

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::getProtocol(), and servlet::not_supported().

virtual std::string servlet::ServletRequest::getRemoteAddr ( ) const [pure virtual]

Returns the Internet Protocol (IP) address of the client or last proxy that sent the request. For HTTP servlets, same as the value of the CGI variable REMOTE_ADDR.

Returns:: a String containing the IP address of the client that sent the request

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::getRemoteAddr().

virtual std::string servlet::ServletRequest::getRemoteHost ( ) const [pure virtual]

Returns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address. For HTTP servlets, same as the value of the CGI variable REMOTE_HOST.

Returns:: a String containing the fully qualified name of the client

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::getRemoteHost().

virtual int servlet::ServletRequest::getRemotePort ( ) const [pure virtual]

Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.

Returns:: an integer specifying the port number

Since:: 2.4

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::getRemotePort().

virtual RequestDispatcher* servlet::ServletRequest::getRequestDispatcher ( const std::string & path ) [pure virtual]

Returns a servlet::RequestDispatcher object that acts as a wrapper for the resource located at the given path. A RequestDispatcher object can be used to forward a request to the resource or to include the resource in a response. The resource can be dynamic or static.

The pathname specified may be relative, although it cannot extend outside the current servlet context. If the path begins with a "/" it is interpreted as relative to the current context root. This method returns null if the servlet container cannot return a RequestDispatcher.

The difference between this method and servlet::ServletContext#getRequestDispatcher is that this method can take a relative path.

Parameters:

path a String specifying the pathname to the resource. If it is relative, it must be relative against the current servlet.

Returns:: a RequestDispatcher object that acts as a wrapper for the resource at the specified path, or null if the servlet container cannot return a RequestDispatcher

See also:: RequestDispatcher
ServletContext::getRequestDispatcher

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::getRequestDispatcher().

virtual std::string servlet::ServletRequest::getScheme ( ) const [pure virtual]

Returns the name of the scheme used to make this request, for example, http, https, or ftp. Different schemes have different rules for constructing URLs, as noted in RFC 1738.

Returns:: a String containing the name of the scheme used to make this request

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::getScheme().

virtual std::string servlet::ServletRequest::getServerName ( ) const [pure virtual]

Returns the host name of the server to which the request was sent. It is the value of the part before ":" in the Host header value, if any, or the resolved server name, or the server IP address.

Returns:: a String containing the name of the server

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::getServerName().

virtual int servlet::ServletRequest::getServerPort ( ) const [pure virtual]

Returns the port number to which the request was sent. It is the value of the part after ":" in the Host header value, if any, or the server port where the client connection was accepted on.

Returns:: an integer specifying the port number

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::getServerPort().

virtual bool servlet::ServletRequest::hasAttribute ( const std::string & name ) const [pure virtual]

[C++ Servlet API Extention]

Returns the false if no attribute of the given name exists. Returns true otherwize

Attributes can be set two ways. The servlet container may set attributes to make available custom information about a request. For example, for requests made using HTTPS, the attribute javax.servlet.request.X509Certificate can be used to retrieve information on the certificate of the client. Attributes can also be set programatically using servlet::ServletRequest#setAttribute. This allows information to be embedded into a request before a servlet::RequestDispatcher call.

Attribute names should follow the same conventions as package names. This specification reserves names matching java.*, javax.*, and sun.*.

Parameters:

name a String specifying the name of the attribute

Returns:: false if the attribute does not exist. true otherwize

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::hasAttribute().

virtual bool servlet::ServletRequest::isSecure ( ) const [pure virtual]

Returns the preferred Locale that the client will accept content in, based on the Accept-Language header. If the client request doesn't provide an Accept-Language header, this method returns the default locale for the server.

Returns:: the preferred Locale for the client

virtual Locale getLocale() const=0;

Returns an Enumeration of Locale objects indicating, in decreasing order starting with the preferred locale, the locales that are acceptable to the client based on the Accept-Language header. If the client request doesn't provide an Accept-Language header, this method returns an Enumeration containing one Locale, the default locale for the server.

Returns:: an Enumeration of preferred Locale objects for the client

virtual std::auto_ptr< std::vector<Locale> > getLocales() const=0;

Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.

Returns:: a boolean indicating if the request was made using a secure channel

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::isSecure().

virtual void servlet::ServletRequest::removeAttribute ( const std::string & name ) [pure virtual]

Removes an attribute from this request. This method is not generally needed as attributes only persist as long as the request is being handled.

Attribute names should follow the same conventions as package names. Names beginning with java.*, javax.*, and com.sun.*, are reserved for use by Sun Microsystems.

Parameters:

name a String specifying the name of the attribute to remove

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::removeAttribute().

template<typename T >

void servlet::ServletRequest::setAttribute	(	const std::string &	name,
		const T &	o
	)			`[inline]`

Definition at line 559 of file ServletRequest.h.

References setAttribute().

Here is the call graph for this function:

template<typename T >

void servlet::ServletRequest::setAttribute	(	const std::string &	name,
		boost::shared_ptr< T >	o
	)			`[inline]`

Definition at line 189 of file ServletRequest.h.

References setAttribute().

Here is the call graph for this function:

virtual void servlet::ServletRequest::setAttribute	(	const std::string &	name,
		boost::shared_ptr< void >	o
	)			`[pure virtual]`

Stores an attribute in this request. Attributes are reset between requests. This method is most often used in conjunction with servlet::RequestDispatcher.

Attribute names should follow the same conventions as package names. Names beginning with java.*, javax.*, and com.sun.*, are reserved for use by Sun Microsystems.
If the object passed in is null, the effect is the same as calling removeAttribute.
It is warned that when the request is dispatched from the servlet resides in a different web application by RequestDispatcher, the object set by this method may not be correctly retrieved in the caller servlet.

Parameters:

	name	a `String` specifying the name of the attribute
	o	the `Object` to be stored

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::setAttribute(), and setAttribute().

virtual void servlet::ServletRequest::setCharacterEncoding ( const std::string & env ) [pure virtual]

Overrides the name of the character encoding used in the body of this request. This method must be called prior to reading request parameters or reading input using getReader().

Parameters:

env a String containing the name of the character encoding.

Exceptions:

java.io.UnsupportedEncodingException

if this is not a valid encoding

Implemented in container::HttpServletRequestImpl, and servlet::ServletRequestWrapper.

Referenced by servlet::ServletRequestWrapper::setCharacterEncoding().

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

include/servlet/ServletRequest.h

CPPSERV

servlet::ServletRequest Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation