All Packages Class Hierarchy This Package Previous Next Index
Interface javax.servlet.ServletRequest
- 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.
- Version:
- Servlet API 2.0
-
getAttribute(String)
- Gets a named attribute's value.
-
getCharacterEncoding()
- Gets the character encoding of the request data.
-
getContentLength()
- Gets the size in bytes of the request
-
getContentType()
- Gets the mime type of the request
-
getInputStream()
- Creates an inputstream for servlets to read client request data from.
-
getParameter(String)
- Gets the value of a named requestparameter.
Deprecated.
-
getParameterNames()
- Gets all parameter names.
-
getParameterValues(String)
- Gets an array of Strings containing all the request parameter's
values whose name matches
name
.
-
getProtocol()
- Gets the protocol of the request as Proto/Major.Minor
("HTTP/1.1").
-
getReader()
- Creates an BufferedReader for servlets to read client request
data from.
-
getRealPath(String)
- Translates the given path to the real path on the servers
filesystem, using the servers documentroot.
-
getRemoteAddr()
- Gets the ip address of the client that sent the request
-
getRemoteHost()
- Gets the hostname of the client that sent the request.
-
getScheme()
- Gets the scheme of the request as defined by RFC 1783
("ftp", "http", "gopher", "news").
-
getServerName()
- Get the name of the server receiving the request
-
getServerPort()
- Gets the portnumber the server reveiving the request is running on.
getContentLength
public abstract int getContentLength()
- Gets the size in bytes of the request
- Returns:
- the number of bytes in the request
or -1 if not known
getContentType
public abstract String getContentType()
- Gets the mime type of the request
- Returns:
- a String containing the mime type of the request
or null if not known
getProtocol
public abstract String getProtocol()
- Gets the protocol of the request as Proto/Major.Minor
("HTTP/1.1").
- Returns:
- A string containing the protocol name
getScheme
public abstract String getScheme()
- Gets the scheme of the request as defined by RFC 1783
("ftp", "http", "gopher", "news").
- Returns:
- A String containing the scheme
getServerName
public abstract String getServerName()
- Get the name of the server receiving the request
- Returns:
- The name of the server.
getServerPort
public abstract int getServerPort()
- Gets the portnumber the server reveiving the request is running on.
- Returns:
- the portnumber
getRemoteAddr
public abstract String getRemoteAddr()
- Gets the ip address of the client that sent the request
- Returns:
- the client's ip address
getRemoteHost
public abstract 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
getRealPath
public abstract String getRealPath(String path)
- 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
getInputStream
public abstract ServletInputStream getInputStream() throws IOException
- Creates an inputstream for servlets to read client request data from.
- Returns:
- The created InputStreams
- Throws: IOException
- if an i/o related error occured
- Throws: IllegalStateException
- if
getReader
was already
called on this request.
- See Also:
- getReader
getParameter
public abstract String getParameter(String name)
- Note: getParameter() is deprecated.
But undepricated in Servlet API 2.1!
- 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
getParameterValues
public abstract 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
getParameterNames
public abstract 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
getAttribute
public abstract 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.
getReader
public abstract BufferedReader getReader() throws IOException
- Creates an BufferedReader for servlets to read client request
data from.
- Returns:
- The created BufferedReader
- Throws: IOException
- if an i/o related error occured
- Throws: IllegalStateException
- if
getInputStream
was
already called on this request.
- See Also:
- getInputStream
getCharacterEncoding
public abstract String getCharacterEncoding()
- Gets the character encoding of the request data.
- Returns:
- Character encoding or null if the encoding is unavailable
All Packages Class Hierarchy This Package Previous Next Index