javax.servlet

Interface ServletRequest

Known Subinterfaces:
HttpServletRequest

public interface ServletRequest

Whenever the server receives a request it creates a ServletRequest object, puts all the request information in it and passes this along with a ServletResponse object to the approriate servlet.
Since:
Servlet API 1.0

Method Summary

Object
getAttribute(String name)
Gets a named attribute's value.
Enumeration
getAttributeNames()
Gets an Enumeration of all the attribute names.
String
getCharacterEncoding()
Gets the character encoding of the request data.
int
getContentLength()
Gets the size in bytes of the request
String
getContentType()
Gets the mime type of the request
ServletInputStream
getInputStream()
Creates an inputstream for servlets to read client request data from.
java.util.Locale
getLocale()
XXX
Enumeration
getLocales()
XXX
String
getParameter(String name)
Gets the value of a named requestparameter.
Enumeration
getParameterNames()
Gets all parameter names.
String[]
getParameterValues(String name)
Gets an array of Strings containing all the request parameter's values whose name matches name.
String
getProtocol()
Gets the protocol of the request as Proto/Major.Minor ("HTTP/1.1").
BufferedReader
getReader()
Creates an BufferedReader for servlets to read client request data from.
String
getRealPath(String path)
Deprecated. Should use getRealPath from the current ServletContext.
String
getRemoteAddr()
Gets the ip address of the client that sent the request
String
getRemoteHost()
Gets the hostname of the client that sent the request.
RequestDispatcher
getRequestDispatcher(String path)
XXX
String
getScheme()
Gets the scheme of the request as defined by RFC 1783 ("ftp", "http", "gopher", "news").
String
getServerName()
Get the name of the server receiving the request
int
getServerPort()
Gets the portnumber the server reveiving the request is running on.
boolean
isSecure()
XXX
void
removeAttribute(String name)
XXX
void
setAttribute(String name, Object o)
Puts a named object into the ServletRequest.

Method Details

getAttribute

public Object getAttribute(String name)
Gets a named attribute's value. This gives one of the initialization attribute values.

Note that the Servlet 2.1 API Documentation mentions some predefined attribute names, but the Servlet Spec does not mention them. I (MJW) am not sure if they are platform specific (JWS) or not.

Returns:
The value of the attribute, null if not found.
Since:
Servlet API 1.0

getAttributeNames

public Enumeration getAttributeNames()
Gets an Enumeration of all the attribute names.
Returns:
The Enumeration of all attribute names set in this request.
Since:
Servlet API 2.1

getCharacterEncoding

public String getCharacterEncoding()
Gets the character encoding of the request data.
Returns:
Character encoding or null if the encoding is unavailable
Since:
Servlet API 2.0

getContentLength

public int getContentLength()
Gets the size in bytes of the request
Returns:
the number of bytes in the request or -1 if not known
Since:
Servlet API 1.0

getContentType

public String getContentType()
Gets the mime type of the request
Returns:
a String containing the mime type of the request or null if not known
Since:
Servlet API 1.0

getInputStream

public ServletInputStream getInputStream()
            throws IOException
Creates an inputstream for servlets to read client request data from.
Returns:
The created InputStreams
Since:
Servlet API 1.0
See Also:
getReader()

getLocale

public java.util.Locale getLocale()
XXX

getLocales

public Enumeration getLocales()
XXX

getParameter

public String getParameter(String name)
Gets the value of a named requestparameter. If the parameter can have more than one value getParameterValues should be used. If there are more than one values associated with the parameter this method will only return the first value as return by getParameterValues is returned. see javax.servlet.ServletRequest.getParameterValues()
Parameters:
name - the name of the parameter whose value we want
Returns:
the (first) value of the parameter or null if not present
Since:
Servlet API 1.0

getParameterNames

public Enumeration getParameterNames()
Gets all parameter names.

Note that the Servlet API 2.1 documentation says that this returns an empty Enumeration if the input stream is empty, but this is not mandated by the Servlet Spec.

Returns:
an enumeration containing all parameter names
Since:
Servlet API 1.0

getParameterValues

public String[] getParameterValues(String name)
Gets an array of Strings containing all the request parameter's values whose name matches name.
Returns:
the array containing all the values or null if not present
Since:
Servlet API 1.0

getProtocol

public String getProtocol()
Gets the protocol of the request as Proto/Major.Minor ("HTTP/1.1").
Returns:
A string containing the protocol name
Since:
Servlet API 1.0

getReader

public BufferedReader getReader()
            throws IOException
Creates an BufferedReader for servlets to read client request data from.
Returns:
The created BufferedReader
Since:
Servlet API 2.0

getRealPath

public String getRealPath(String path)

Deprecated. Should use getRealPath from the current ServletContext.

Translates the given path to the real path on the servers filesystem, using the servers documentroot.
Parameters:
path - the path which requires translating
Returns:
the translated path
Since:
Servlet API 1.0
See Also:
javax.servlet.ServletContext.getRealPath(java.lang.String)

getRemoteAddr

public String getRemoteAddr()
Gets the ip address of the client that sent the request
Returns:
the client's ip address
Since:
Servlet API 1.0

getRemoteHost

public String getRemoteHost()
Gets the hostname of the client that sent the request. This is either a fully qualified host name or a string representing the remote IP address.
Returns:
the client's hostname
Since:
Servlet API 1.0

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(String path)
XXX

getScheme

public String getScheme()
Gets the scheme of the request as defined by RFC 1783 ("ftp", "http", "gopher", "news").
Returns:
A String containing the scheme
Since:
Servlet API 1.0

getServerName

public String getServerName()
Get the name of the server receiving the request
Returns:
The name of the server.
Since:
Servlet API 1.0

getServerPort

public int getServerPort()
Gets the portnumber the server reveiving the request is running on.
Returns:
the portnumber
Since:
Servlet API 1.0

isSecure

public boolean isSecure()
XXX

removeAttribute

public void removeAttribute(String name)
XXX

setAttribute

public void setAttribute(String name,
                         Object o)
Puts a named object into the ServletRequest. Can be used to communicate with other servlets if this ServletRequest is passed to another servlet through a RequestDispatcher. The names used must follow the conventions used for naming java packages.
Parameters:
name - - which is used to refer to this object
Since:
Servlet API 2.1