StandardRequest (api 2.1.12 API)

java.lang.Object
- com.yanzhenjie.andserver.http.StandardRequest

All Implemented Interfaces:

HttpContext, HttpHeaders, HttpRequest
```
public class StandardRequest
extends java.lang.Object
implements HttpRequest
```
Created by Zhenjie Yan on 2018/6/12.

Field Summary
- Fields inherited from interface com.yanzhenjie.andserver.http.HttpRequest
  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

Constructor Summary

Constructors
Constructor and Description
`StandardRequest(org.apache.httpcore.HttpRequest request, HttpContext context, DispatcherHandler handler, SessionManager sessionManager)`

Method Summary

All Methods Instance Methods Concrete 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.
`java.lang.Object`	`getAttribute(java.lang.String id)` Obtains attribute with the given name.
`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.
`java.lang.Object`	`removeAttribute(java.lang.String id)` Removes attribute with the given name from the context.
`void`	`setAttribute(java.lang.String id, java.lang.Object obj)` Sets value of the attribute with the given name.
`void`	`setPath(java.lang.String path)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StandardRequest
```
public StandardRequest(org.apache.httpcore.HttpRequest request,
                       HttpContext context,
                       DispatcherHandler handler,
                       SessionManager sessionManager)
```
- Method Detail
  - getLocalName
```
public java.lang.String getLocalName()
```
    Description copied from interface: HttpRequest
    
    Returns the host name of the Internet Protocol (IP) interface on which the request was received.
    
    Specified by:
    
    getLocalName in interface HttpRequest
    
    Returns:
    
    a String containing the host name of the IP on which the request was received.
  - getLocalAddr
```
public java.lang.String getLocalAddr()
```
    Description copied from interface: HttpRequest
    
    The default behavior of this method is to return getLocalAddr() on the wrapped request object.
    
    Specified by:
    
    getLocalAddr in interface HttpRequest
  - getLocalPort
```
public int getLocalPort()
```
    Description copied from interface: HttpRequest
    
    Returns the Internet Protocol (IP) port number of the interface on which the request was received.
    
    Specified by:
    
    getLocalPort in interface HttpRequest
    
    Returns:
    
    an integer specifying the port number
  - getRemoteAddr
```
public java.lang.String getRemoteAddr()
```
    Description copied from interface: HttpRequest
    
    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.
    
    Specified by:
    
    getRemoteAddr in interface HttpRequest
    
    Returns:
    
    a String containing the IP address of the client that sent the request
  - getRemoteHost
```
public java.lang.String getRemoteHost()
```
    Description copied from interface: HttpRequest
    
    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.
    
    Specified by:
    
    getRemoteHost in interface HttpRequest
    
    Returns:
    
    a String containing the fully qualified name of the client
  - getRemotePort
```
public int getRemotePort()
```
    Description copied from interface: HttpRequest
    
    Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
    
    Specified by:
    
    getRemotePort in interface HttpRequest
    
    Returns:
    
    an integer specifying the port number
  - getMethod
```
public HttpMethod getMethod()
```
    Description copied from interface: HttpRequest
    
    Returns HttpMethod with which this request was made.
    
    Specified by:
    
    getMethod in interface HttpRequest
  - getURI
```
public java.lang.String getURI()
```
    Description copied from interface: HttpRequest
    
    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
    
    Specified by:
    
    getURI in interface HttpRequest
  - setPath
```
public void setPath(java.lang.String path)
```
  - getPath
```
public java.lang.String getPath()
```
    Description copied from interface: HttpRequest
    
    Get the path to this request.
    
    Specified by:
    
    getPath in interface HttpRequest
  - getQueryNames
```
public java.util.List<java.lang.String> getQueryNames()
```
    Description copied from interface: HttpRequest
    
    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.
    
    Specified by:
    
    getQueryNames in interface HttpRequest
    
    Returns:
    
    an List of String.
  - getQuery
```
public java.lang.String getQuery(java.lang.String name)
```
    Description copied from interface: HttpRequest
    
    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 HttpRequest.getQueries(String).
    
    Specified by:
    
    getQuery in interface HttpRequest
    
    Parameters:
    
    name - a String specifying the name of the query parameter.
    
    Returns:
    
    the single value of the query parameter.
    
    See Also:
    
    HttpRequest.getQueries(String)
  - getQueries
```
public java.util.List<java.lang.String> getQueries(java.lang.String name)
```
    Description copied from interface: HttpRequest
    
    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.
    
    Specified by:
    
    getQueries in interface HttpRequest
    
    Parameters:
    
    name - the name of the query parameter.
    
    Returns:
    
    an List of String containing the parameter's values.
    
    See Also:
    
    HttpRequest.getQuery(String)
  - getQuery
```
public MultiValueMap<java.lang.String,java.lang.String> getQuery()
```
    Description copied from interface: HttpRequest
    
    Returns MultiValueMap of the query parameters of this request, or empty MultiValueMap if there are no query parameters.
    
    Specified by:
    
    getQuery in interface HttpRequest
    
    Returns:
    
    a MultiValueMap containing query parameter names as keys and query parameter values as map values.
  - getHeaderNames
```
public java.util.List<java.lang.String> getHeaderNames()
```
    Description copied from interface: HttpRequest
    
    Returns an List of all the header names this request contains, or empty List if the request has no headers.
    
    Specified by:
    
    getHeaderNames in interface HttpRequest
  - getHeader
```
public java.lang.String getHeader(java.lang.String name)
```
    Description copied from interface: HttpRequest
    
    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.
    
    Specified by:
    
    getHeader in interface HttpRequest
    
    Parameters:
    
    name - a String specifying the header name.
    
    See Also:
    
    HttpRequest.getHeaders(String)
  - getHeaders
```
public java.util.List<java.lang.String> getHeaders(java.lang.String name)
```
    Description copied from interface: HttpRequest
    
    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.
    
    Specified by:
    
    getHeaders in interface HttpRequest
    
    Parameters:
    
    name - a String specifying the header name.
  - getDateHeader
```
public long getDateHeader(java.lang.String name)
```
    Description copied from interface: HttpRequest
    
    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.
    
    Specified by:
    
    getDateHeader in interface HttpRequest
    
    Parameters:
    
    name - a String specifying the name of the header.
  - getIntHeader
```
public int getIntHeader(java.lang.String name)
```
    Description copied from interface: HttpRequest
    
    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.
    
    Specified by:
    
    getIntHeader in interface HttpRequest
    
    Parameters:
    
    name - a String specifying the name of a request header.
  - getAccept
```
public MediaType getAccept()
```
    Description copied from interface: HttpRequest
    
    Returns the preferred MediaType that the client will accept content in, based on the Accept header.
    
    Specified by:
    
    getAccept in interface HttpRequest
  - getAccepts
```
public java.util.List<MediaType> getAccepts()
```
    Description copied from interface: HttpRequest
    
    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.
    
    Specified by:
    
    getAccepts in interface HttpRequest
    
    Returns:
    
    a List of MediaType objects indicating.
  - getAcceptLanguage
```
public java.util.Locale getAcceptLanguage()
```
    Description copied from interface: HttpRequest
    
    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.
    
    Specified by:
    
    getAcceptLanguage in interface HttpRequest
    
    Returns:
    
    the preferred Locale for the client.
  - getAcceptLanguages
```
public java.util.List<java.util.Locale> getAcceptLanguages()
```
    Description copied from interface: HttpRequest
    
    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.
    
    Specified by:
    
    getAcceptLanguages in interface HttpRequest
    
    Returns:
    
    an List of preferred Locale objects for the client.
  - getCookieValue
```
public java.lang.String getCookieValue(java.lang.String name)
```
    Description copied from interface: HttpRequest
    
    Gets the value of the cookie with the specified name.
    
    Specified by:
    
    getCookieValue in interface HttpRequest
    
    Parameters:
    
    name - the name of value.
    
    Returns:
    
    the value or null if the cookie with the specified name does not exist.
  - getCookie
```
public Cookie getCookie(java.lang.String name)
```
    Description copied from interface: HttpRequest
    
    Return a Cookie object, if there is no cookie corresponding to this name, it returns null.
    
    Specified by:
    
    getCookie in interface HttpRequest
    
    Parameters:
    
    name - cookie name.
    
    Returns:
    
    a Cookie object or null if there is no cookie corresponding to this name .
  - getCookies
```
public java.util.List<Cookie> getCookies()
```
    Description copied from interface: HttpRequest
    
    Returns an List containing all of the Cookie objects the client sent with this request. This method returns null if no cookies were sent.
    
    Specified by:
    
    getCookies in interface HttpRequest
  - getContentLength
```
public long getContentLength()
```
    Description copied from interface: HttpRequest
    
    Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.
    
    Specified by:
    
    getContentLength in interface HttpRequest
    
    Returns:
    
    a long containing the length of the request body or -1L if the length is not known.
  - getContentType
```
public MediaType getContentType()
```
    Description copied from interface: HttpRequest
    
    Returns the MIME type of the body of the request, or null if the type is not known.
    
    Specified by:
    
    getContentType in interface HttpRequest
    
    Returns:
    
    a String containing the name of the MIME type of the request, or null if the type is not known.
  - getParameterNames
```
public java.util.List<java.lang.String> getParameterNames()
```
    Description copied from interface: HttpRequest
    
    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.
    
    Specified by:
    
    getParameterNames in interface HttpRequest
    
    Returns:
    
    an List of String objects.
  - getParameter
```
public java.lang.String getParameter(java.lang.String name)
```
    Description copied from interface: HttpRequest
    
    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 HttpRequest.getParameters(String).
    
    Specified by:
    
    getParameter in interface HttpRequest
    
    Parameters:
    
    name - a String specifying the name of the parameter.
    
    Returns:
    
    the single value of the parameter.
    
    See Also:
    
    HttpRequest.getParameters(String)
  - getParameters
```
public java.util.List<java.lang.String> getParameters(java.lang.String name)
```
    Description copied from interface: HttpRequest
    
    Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.
    
    Specified by:
    
    getParameters in interface HttpRequest
    
    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:
    
    HttpRequest.getParameter(String)
  - getParameter
```
public MultiValueMap<java.lang.String,java.lang.String> getParameter()
```
    Description copied from interface: HttpRequest
    
    Returns MultiValueMap of the parameters of this request, or empty MultiValueMap if there are no parameters.
    
    Specified by:
    
    getParameter in interface HttpRequest
    
    Returns:
    
    a MultiValueMap containing parameter names as keys and parameter values as map values.
  - getBody
```
public RequestBody getBody()
```
    Description copied from interface: HttpRequest
    
    Get the response body.
    
    Specified by:
    
    getBody in interface HttpRequest
    
    Returns:
    
    RequestBody.
  - getValidSession
```
public Session getValidSession()
```
    Description copied from interface: HttpRequest
    
    Returns the current Session associated with this request or, if there is no current session returns a new session.
    
    Specified by:
    
    getValidSession in interface HttpRequest
    
    Returns:
    
    the session associated with this request or a new session.
    
    See Also:
    
    HttpRequest.getSession()
  - getSession
```
public Session getSession()
```
    Description copied from interface: HttpRequest
    
    Returns the current session associated with this request, or if the request does not have a session, creates one.
    
    Specified by:
    
    getSession in interface HttpRequest
    
    See Also:
    
    HttpRequest.getValidSession()
  - changeSessionId
```
public java.lang.String changeSessionId()
```
    Description copied from interface: HttpRequest
    
    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.
    
    Specified by:
    
    changeSessionId in interface HttpRequest
    
    Returns:
    
    the new session id.
    
    See Also:
    
    HttpRequest.getSession(), HttpRequest.getValidSession()
  - isSessionValid
```
public boolean isSessionValid()
```
    Description copied from interface: HttpRequest
    
    Checks whether the requested session ID is still valid.
    If the client did not specify any session ID, this method returns false.
    
    Specified by:
    
    isSessionValid in interface HttpRequest
    
    See Also:
    
    HttpRequest.getSession(), HttpRequest.getValidSession()
  - getRequestDispatcher
```
public RequestDispatcher getRequestDispatcher(java.lang.String path)
```
    Description copied from interface: HttpRequest
    
    Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path.
    
    Specified by:
    
    getRequestDispatcher in interface HttpRequest
    
    Returns:
    
    a RequestDispatcher object or null if the handler corresponding to the path is not found.
  - getContext
```
public HttpContext getContext()
```
    Description copied from interface: HttpRequest
    
    Get the http context of this request.
    
    Specified by:
    
    getContext in interface HttpRequest
    
    Returns:
    
    HttpContext.
  - getAttribute
```
public java.lang.Object getAttribute(java.lang.String id)
```
    Description copied from interface: HttpContext
    
    Obtains attribute with the given name.
    
    Specified by:
    
    getAttribute in interface HttpContext
    
    Parameters:
    
    id - the attribute name.
    
    Returns:
    
    attribute value, or null if not set.
  - setAttribute
```
public void setAttribute(java.lang.String id,
                         java.lang.Object obj)
```
    Description copied from interface: HttpContext
    
    Sets value of the attribute with the given name.
    
    Specified by:
    
    setAttribute in interface HttpContext
    
    Parameters:
    
    id - the attribute name.
    
    obj - the attribute value.
  - removeAttribute
```
public java.lang.Object removeAttribute(java.lang.String id)
```
    Description copied from interface: HttpContext
    
    Removes attribute with the given name from the context.
    
    Specified by:
    
    removeAttribute in interface HttpContext
    
    Parameters:
    
    id - the attribute name.
    
    Returns:
    
    attribute value, or null if not set.

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

Class StandardRequest

Field Summary

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

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

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StandardRequest

Method Detail

getLocalName

getLocalAddr

getLocalPort

getRemoteAddr

getRemoteHost

getRemotePort

getMethod

getURI

setPath

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

getAttribute

setAttribute

removeAttribute