HttpRequest (api 2.1.12 API)

All Superinterfaces:

HttpContext, HttpHeaders

All Known Subinterfaces:

MultipartRequest

All Known Implementing Classes:

RequestWrapper, StandardMultipartRequest, StandardRequest
```
public interface HttpRequest
extends HttpContext, HttpHeaders
```
Created by Zhenjie Yan on 2018/6/12.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String SESSION_NAME
- Fields inherited from interface com.yanzhenjie.andserver.http.HttpContext
  ANDROID_CONTEXT, HTTP_MESSAGE_CONVERTER, REQUEST_CREATED_SESSION, RESPONSE_PRODUCE_TYPE
- Fields inherited from interface com.yanzhenjie.andserver.http.HttpHeaders
  ACCEPT, ACCEPT_CHARSET, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ACCEPT_RANGES, Access_Control_Allow_Credentials, Access_Control_Allow_Headers, Access_Control_Allow_Methods, Access_Control_Allow_Origin, Access_Control_Expose_Headers, Access_Control_Max_Age, Access_Control_Request_Headers, Access_Control_Request_Method, AGE, ALLOW, AUTHORIZATION, CACHE_CONTROL, CONNECTION, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_LOCATION, CONTENT_MD5, CONTENT_RANGE, CONTENT_TYPE, COOKIE, DATE, DAV, DEPTH, DESTINATION, ETAG, EXPECT, EXPIRES, FROM, HOST, IF, IF_MATCH, IF_MODIFIED_SINCE, IF_NONE_MATCH, IF_RANGE, IF_UNMODIFIED_SINCE, LAST_MODIFIED, LOCATION, LOCK_TOKEN, MAX_FORWARDS, ORIGIN, OVERWRITE, PRAGMA, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, RANGE, REFERER, RETRY_AFTER, SERVER, SET_COOKIE, STATUS_URI, TE, TIMEOUT, TRAILER, TRANSFER_ENCODING, UPGRADE, USER_AGENT, VARY, VIA, WARNING, WWW_AUTHENTICATE

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`SESSION_NAME`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`changeSessionId()` Change the session id of the current session associated with this request and return the new session id, if there is no session associated with the request, an `IllegalStateException` is thrown.
`MediaType`	`getAccept()` Returns the preferred `MediaType` that the client will accept content in, based on the Accept header.
`java.util.Locale`	`getAcceptLanguage()` Returns the preferred `Locale` that the client will accept content in, based on the `Accept-Language` header.
`java.util.List<java.util.Locale>`	`getAcceptLanguages()` Returns a `List` 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.
`java.util.List<MediaType>`	`getAccepts()` Returns a `List` of `MediaType` objects indicating, in decreasing order starting with the preferred MediaType, the media types that are acceptable to the client based on the `Accept` header.
`RequestBody`	`getBody()` Get the response body.
`long`	`getContentLength()` Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.
`MediaType`	`getContentType()` Returns the MIME type of the body of the request, or `null` if the type is not known.
`HttpContext`	`getContext()` Get the http context of this request.
`Cookie`	`getCookie(java.lang.String name)` Return a `Cookie` object, if there is no cookie corresponding to this name, it returns `null`.
`java.util.List<Cookie>`	`getCookies()` Returns an `List` containing all of the `Cookie` objects the client sent with this request.
`java.lang.String`	`getCookieValue(java.lang.String name)` Gets the value of the cookie with the specified name.
`long`	`getDateHeader(java.lang.String name)` Returns the value of the specified request header as a `long` value that represents a `Date` object.
`java.lang.String`	`getHeader(java.lang.String name)` Returns the value of the specified request header as a `String`.
`java.util.List<java.lang.String>`	`getHeaderNames()` Returns an `List` of all the header names this request contains, or empty `List` if the request has no headers.
`java.util.List<java.lang.String>`	`getHeaders(java.lang.String name)` Returns all the values of the specified request header as an `List` of `String`.
`int`	`getIntHeader(java.lang.String name)` Returns the value of the specified request header as an `int`.
`java.lang.String`	`getLocalAddr()` The default behavior of this method is to return getLocalAddr() on the wrapped request object.
`java.lang.String`	`getLocalName()` Returns the host name of the Internet Protocol (IP) interface on which the request was received.
`int`	`getLocalPort()` Returns the Internet Protocol (IP) port number of the interface on which the request was received.
`HttpMethod`	`getMethod()` Returns `HttpMethod` with which this request was made.
`MultiValueMap<java.lang.String,java.lang.String>`	`getParameter()` Returns `MultiValueMap` of the parameters of this request, or empty `MultiValueMap` if there are no parameters.
`java.lang.String`	`getParameter(java.lang.String name)` Returns the value of a request parameter as a `String`, or `null` if the parameter does not exist.
`java.util.List<java.lang.String>`	`getParameterNames()` Returns an `List` of `String` containing the names of the parameters contained in this request.
`java.util.List<java.lang.String>`	`getParameters(java.lang.String name)` Returns an array of `String` objects containing all of the values the given request parameter has, or `null` if the parameter does not exist.
`java.lang.String`	`getPath()` Get the path to this request.
`java.util.List<java.lang.String>`	`getQueries(java.lang.String name)` Returns an `List` of `String` objects containing all of the values the given query parameter name, or empty `List` if the query parameter does not exist.
`MultiValueMap<java.lang.String,java.lang.String>`	`getQuery()` Returns `MultiValueMap` of the query parameters of this request, or empty `MultiValueMap` if there are no query parameters.
`java.lang.String`	`getQuery(java.lang.String name)` Returns the value of a request parameter as a `String` object, or `null` if the parameter does not exist.
`java.util.List<java.lang.String>`	`getQueryNames()` Returns an `List` of `String` objects containing the names of the query parameters contained in url of this request, or empty `List` if there are no query parameters.
`java.lang.String`	`getRemoteAddr()` Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
`java.lang.String`	`getRemoteHost()` Returns the fully qualified name of the client or the last proxy that sent the request.
`int`	`getRemotePort()` Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
`RequestDispatcher`	`getRequestDispatcher(java.lang.String path)` Returns a `RequestDispatcher` object that acts as a wrapper for the resource located at the given path.
`Session`	`getSession()` Returns the current session associated with this request, or if the request does not have a session, creates one.
`java.lang.String`	`getURI()` Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.
`Session`	`getValidSession()` Returns the current `Session` associated with this request or, if there is no current session returns a new session.
`boolean`	`isSessionValid()` Checks whether the requested session ID is still valid.

Methods inherited from interface com.yanzhenjie.andserver.http.HttpContext
getAttribute, removeAttribute, setAttribute

- Field Detail
  - SESSION_NAME
```
static final java.lang.String SESSION_NAME
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getLocalName
```
java.lang.String getLocalName()
```
    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.
  - getLocalAddr
```
java.lang.String getLocalAddr()
```
    The default behavior of this method is to return getLocalAddr() on the wrapped request object.
  - getLocalPort
```
int getLocalPort()
```
    Returns the Internet Protocol (IP) port number of the interface on which the request was received.
    
    Returns:
    
    an integer specifying the port number
  - getRemoteAddr
```
java.lang.String getRemoteAddr()
```
    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
  - getRemoteHost
```
java.lang.String getRemoteHost()
```
    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
  - getRemotePort
```
int getRemotePort()
```
    Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
    
    Returns:
    
    an integer specifying the port number
  - getMethod
```
HttpMethod getMethod()
```
    Returns HttpMethod with which this request was made.
  - getURI
```
java.lang.String getURI()
```
    Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request. The web container does not decode this String.
    E.g.
    
    First line of HTTP request Returned Value
    POST /some/path.html HTTP/1.1 /some/path.html
    
    GET http://foo.bar/a.html HTTP/1.0 /a.html
    
    HEAD /xyz?a=b HTTP/1.1 /xyz
  - getPath
```
java.lang.String getPath()
```
    Get the path to this request.
  - getQueryNames
```
java.util.List<java.lang.String> getQueryNames()
```
    Returns an List of String objects containing the names of the query parameters contained in url of this request, or empty List if there are no query parameters.
    
    Returns:
    
    an List of String.
  - getQuery
```
java.lang.String getQuery(java.lang.String name)
```
    Returns the value of a request parameter as a String object, or null if the parameter does not exist.
    You should only use this method when you are sure the query parameter has only one value. If the query parameter might have more than one value, use getQueries(String).
    
    Parameters:
    
    name - a String specifying the name of the query parameter.
    
    Returns:
    
    the single value of the query parameter.
    
    See Also:
    
    getQueries(String)
  - getQueries
```
java.util.List<java.lang.String> getQueries(java.lang.String name)
```
    Returns an List of String objects containing all of the values the given query parameter name, or empty List if the query parameter does not exist.
    
    Parameters:
    
    name - the name of the query parameter.
    
    Returns:
    
    an List of String containing the parameter's values.
    
    See Also:
    
    getQuery(String)
  - getQuery
```
MultiValueMap<java.lang.String,java.lang.String> getQuery()
```
    Returns MultiValueMap of the query parameters of this request, or empty MultiValueMap if there are no query parameters.
    
    Returns:
    
    a MultiValueMap containing query parameter names as keys and query parameter values as map values.
  - getHeaderNames
```
java.util.List<java.lang.String> getHeaderNames()
```
    Returns an List of all the header names this request contains, or empty List if the request has no headers.
  - getHeader
```
java.lang.String getHeader(java.lang.String name)
```
    Returns the value of the specified request header as a String. If the request did not include a header of the specified name, this method returns null. If there are multiple headers with the same name, this method returns the first head in the request.
    
    Parameters:
    
    name - a String specifying the header name.
    
    See Also:
    
    getHeaders(String)
  - getHeaders
```
java.util.List<java.lang.String> getHeaders(java.lang.String name)
```
    Returns all the values of the specified request header as an List of String.
    Some headers, such as Accept-Language can be sent by clients as several headers each with a different value rather than sending the header as a comma separated list.
    If the request did not include any headers of the specified name, this method returns an empty List.
    
    Parameters:
    
    name - a String specifying the header name.
  - getDateHeader
```
long getDateHeader(java.lang.String name)
```
    Returns the value of the specified request header as a long value that represents a Date object. Use this method with headers that contain dates, e.g. If-Modified-Since.
    The date is returned as the number of milliseconds since January 1, 1970 GMT. The header name is case insensitive.
    If the request did not have a header of the specified name, this method returns -1. If the header can't be converted to a date, the method throws an IllegalStateException.
    
    Parameters:
    
    name - a String specifying the name of the header.
  - getIntHeader
```
int getIntHeader(java.lang.String name)
```
    Returns the value of the specified request header as an int. If the request does not have a header of the specified name, this method returns -1. If the header cannot be converted to an integer, this method throws a IllegalStateException.
    
    Parameters:
    
    name - a String specifying the name of a request header.
  - getAccept
```
MediaType getAccept()
```
    Returns the preferred MediaType that the client will accept content in, based on the Accept header.
  - getAccepts
```
java.util.List<MediaType> getAccepts()
```
    Returns a List of MediaType objects indicating, in decreasing order starting with the preferred MediaType, the media types that are acceptable to the client based on the Accept header. If the client request doesn't provide an Accept header, this method returns a empty List.
    
    Returns:
    
    a List of MediaType objects indicating.
  - getAcceptLanguage
```
java.util.Locale getAcceptLanguage()
```
    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.
  - getAcceptLanguages
```
java.util.List<java.util.Locale> getAcceptLanguages()
```
    Returns a List 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 a List containing one Locale, the default locale for the server.
    
    Returns:
    
    an List of preferred Locale objects for the client.
  - getCookieValue
```
java.lang.String getCookieValue(java.lang.String name)
```
    Gets the value of the cookie with the specified name.
    
    Parameters:
    
    name - the name of value.
    
    Returns:
    
    the value or null if the cookie with the specified name does not exist.
  - getCookie
```
Cookie getCookie(java.lang.String name)
```
    Return a Cookie object, if there is no cookie corresponding to this name, it returns null.
    
    Parameters:
    
    name - cookie name.
    
    Returns:
    
    a Cookie object or null if there is no cookie corresponding to this name .
  - getCookies
```
java.util.List<Cookie> getCookies()
```
    Returns an List containing all of the Cookie objects the client sent with this request. This method returns null if no cookies were sent.
  - getContentLength
```
long getContentLength()
```
    Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.
    
    Returns:
    
    a long containing the length of the request body or -1L if the length is not known.
  - getContentType
```
MediaType getContentType()
```
    Returns the MIME type of the body of the request, or null if the type is not known.
    
    Returns:
    
    a String containing the name of the MIME type of the request, or null if the type is not known.
  - getParameterNames
```
java.util.List<java.lang.String> getParameterNames()
```
    Returns an List of String containing the names of the parameters contained in this request. If the request has no parameters, the method returns an empty List.
    
    Returns:
    
    an List of String objects.
  - getParameter
```
java.lang.String getParameter(java.lang.String name)
```
    Returns the value of a request parameter as a String, or null if the parameter does not exist.
    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 getParameters(String).
    
    Parameters:
    
    name - a String specifying the name of the parameter.
    
    Returns:
    
    the single value of the parameter.
    
    See Also:
    
    getParameters(String)
  - getParameters
```
java.util.List<java.lang.String> getParameters(java.lang.String name)
```
    Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.
    
    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(String)
  - getParameter
```
MultiValueMap<java.lang.String,java.lang.String> getParameter()
```
    Returns MultiValueMap of the parameters of this request, or empty MultiValueMap if there are no parameters.
    
    Returns:
    
    a MultiValueMap containing parameter names as keys and parameter values as map values.
  - getBody
```
RequestBody getBody()
```
    Get the response body.
    
    Returns:
    
    RequestBody.
    
    Throws:
    
    java.lang.UnsupportedOperationException - if the request method does not allow the body to be sent.
  - getValidSession
```
Session getValidSession()
```
    Returns the current Session associated with this request or, if there is no current session returns a new session.
    
    Returns:
    
    the session associated with this request or a new session.
    
    See Also:
    
    getSession()
  - getSession
```
Session getSession()
```
    Returns the current session associated with this request, or if the request does not have a session, creates one.
    
    See Also:
    
    getValidSession()
  - changeSessionId
```
java.lang.String changeSessionId()
```
    Change the session id of the current session associated with this request and return the new session id, if there is no session associated with the request, an IllegalStateException is thrown.
    
    Returns:
    
    the new session id.
    
    See Also:
    
    getSession(), getValidSession()
  - isSessionValid
```
boolean isSessionValid()
```
    Checks whether the requested session ID is still valid.
    If the client did not specify any session ID, this method returns false.
    
    See Also:
    
    getSession(), getValidSession()
  - getRequestDispatcher
```
RequestDispatcher getRequestDispatcher(java.lang.String path)
```
    Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path.
    
    Returns:
    
    a RequestDispatcher object or null if the handler corresponding to the path is not found.
  - getContext
```
HttpContext getContext()
```
    Get the http context of this request.
    
    Returns:
    
    HttpContext.

First line of HTTP request	Returned Value
POST /some/path.html HTTP/1.1	/some/path.html
GET http://foo.bar/a.html HTTP/1.0	/a.html
HEAD /xyz?a=b HTTP/1.1	/xyz

Interface HttpRequest

Field Summary

Fields inherited from interface com.yanzhenjie.andserver.http.HttpContext

Fields inherited from interface com.yanzhenjie.andserver.http.HttpHeaders

Method Summary

Methods inherited from interface com.yanzhenjie.andserver.http.HttpContext

Field Detail

SESSION_NAME

Method Detail

getLocalName

getLocalAddr

getLocalPort

getRemoteAddr

getRemoteHost

getRemotePort

getMethod

getURI

getPath

getQueryNames

getQuery

getQueries

getQuery

getHeaderNames

getHeader

getHeaders

getDateHeader

getIntHeader

getAccept

getAccepts

getAcceptLanguage

getAcceptLanguages

getCookieValue

getCookie

getCookies

getContentLength

getContentType

getParameterNames

getParameter

getParameters

getParameter

getBody

getValidSession

getSession

changeSessionId

isSessionValid

getRequestDispatcher

getContext