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 ServletRequest#setAttribute. This allows information to be embedded into a request before a RequestDispatcher call.
Attribute names should follow the same conventions as package names. This specification reserves names matching java., javax., and sun.*.
a String specifying the name of the attribute
an Object containing the value of the attribute, or null if the attribute does not exist
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.
an Enumeration of strings containing the names of the request's attributes
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
a String containing the name of the character encoding, or null if the request does not specify a character encoding
Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known ir is greater than Integer.MAX_VALUE. For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.
an integer containing the length of the request body or -1 if the length is not known or is greater than Integer.MAX_VALUE.
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.
a long containing the length of the request body or -1L if the length is not known
Servlet 3.1
Retrieves the body of the request as binary data using a ServletInputStream. Either this method or #getReader may be called to read the body, not both.
a ServletInputStream object containing the body of the request
IllegalStateException if the #getReader method has already been called for this request
IOException if an input or output exception occurred
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.
an Enumeration of preferred Locale objects for the client
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.
a String specifying the name of the parameter
a String representing the single value of the parameter
#getParameterValues
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.
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.
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.
an Enumeration of String objects, each String containing the name of a request parameter; or an empty Enumeration if the request has no parameters
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.
a String containing the name of the parameter whose value is requested
an array of String objects containing the parameter's values
#getParameter
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.
a String containing the protocol name and version number
Retrieves the body of the request as character data using a BufferedReader. The reader translates the character data according to the character encoding used on the body. Either this method or #getInputStream may be called to read the body, not both.
a BufferedReader containing the body of the request
UnsupportedEncodingException if the character set encoding used is not supported and the text cannot be decoded
IllegalStateException if #getInputStream method has been called on this request
IOException if an input or output exception occurred
#getInputStream
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.
a String containing the fully qualified name of the client
Checks if this request has been put into asynchronous mode.
A ServletRequest is put into asynchronous mode by calling #startAsync or #startAsync(ServletRequest,ServletResponse) on it.
This method returns false if this request was put into asynchronous mode, but has since been dispatched using one of the AsyncContext#dispatch methods or released from asynchronous mode via a call to AsyncContext#complete.
true if this request has been put into asynchronous mode, false otherwise
Servlet 3.0
Checks if this request supports asynchronous operation.
Asynchronous operation is disabled for this request if this request is within the scope of a filter or servlet that has not been annotated or flagged in the deployment descriptor as being able to support asynchronous handling.
true if this request supports asynchronous operation, false otherwise
Servlet 3.0
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 javax.servlet.http.HttpServletRequest.
Author
Various
See
javax.servlet.http.HttpServletRequest