H.Request (OSGL HTTP 1.6.0 API)

java.lang.Object
- org.osgl.http.H.Request<T>

Type Parameters:

T - the type of the implementation class

Direct Known Subclasses:

ServletRequest

Enclosing class:

H
```
public abstract static class H.Request<T extends H.Request>
extends Object
```
Defines the HTTP request trait

Field Summary

Fields
Modifier and Type Field and Description

protected InputStream inputStream

protected Reader reader

Fields
Modifier and Type	Field and Description
`protected InputStream`	`inputStream`
`protected Reader`	`reader`

Constructor Summary

Constructors
Constructor and Description

Request()

Constructors
Constructor and Description
`Request()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract Class<T>`	`_impl()` Returns the class of the implementation.
`protected abstract void`	`_initCookieMap()`
`protected abstract String`	`_ip()` Returns remote ip address.
`protected void`	`_setCookie(String name, H.Cookie cookie)`
`H.Format`	`accept()` Return the request `accept`
`T`	`accept(H.Format fmt)` Set `accept` to the request
`T`	`accept(H.MediaType mediaType)`
`String`	`characterEncoding()` Returns encoding of the request
`long`	`contentLength()` Returns the content length of the request
`H.Format`	`contentType()` Return content type of the request
`<CONTEXT> CONTEXT`	`context()` Get the context object from the request instance
`T`	`context(Object context)` Attach a context object to the request instance
`abstract String`	`contextPath()` Returns the context path of the request.
`H.Cookie`	`cookie(String name)` Returns cookie by it’s name
`List<H.Cookie>`	`cookies()` Returns all cookies of the request in Iterable
`protected abstract InputStream`	`createInputStream()`
`static <T extends H.Request> T`	`current()` Return a request instance of the current execution context, For example from a `ThreadLocal`
`static <T extends H.Request> void`	`current(T request)` Set a request instance into the current execution context, for example into a `ThreadLocal`
`String`	`domain()` Alias of `host()`.
`String`	`etag()`
`boolean`	`etagMatches(String etag)`
`String`	`fullPath()` Returns the full URI path.
`String`	`fullUrl()` Returns the full URL including scheme, domain, port and full request path plus query string
`abstract String`	`header(String name)` Returns the header content by name.
`abstract Iterable<String>`	`headers(String name)` Returns all header content by name.
`String`	`host()` Returns host of this request.
`InputStream`	`inputStream()` Returns body of the request as binary data using `InputStream`
`String`	`ip()` Returns the remote ip address of this request.
`boolean`	`isAjax()` Check if the request is an ajax call
`boolean`	`isModified(String etag, long since)` Check if the requested resource is modified with etag and last timestamp (usually the timestamp of a static file e.g.)
`Locale`	`locale()` Returns locale of the request
`org.osgl.util.C.List<Locale>`	`locales()` Returns all locales of the request
`protected T`	`me()`
`abstract H.Method`	`method()` Returns the HTTP method of the request
`abstract T`	`method(H.Method method)` Set the Http method on this request.
`abstract Iterable<String>`	`paramNames()` Return all parameter names
`abstract String`	`paramVal(String name)` Return a request parameter value by name.
`abstract String[]`	`paramVals(String name)` Returns all values associated with the name specified in the http request.
`String`	`password()` the Http Basic password
`abstract String`	`path()` Returns the path of the request.
`int`	`port()` Returns the port of this request.
`abstract String`	`query()` Returns query string or an empty String if the request doesn’t contains a query string
`Reader`	`reader()` Returns body of the request as binary data using `Reader`
`boolean`	`readerCreated()`
`String`	`referer()` This method is an alias of `referer` which follows the HTTP misspelling header name `referer`
`String`	`referrer()` Return the “referer(sic)” header value
`String`	`scheme()` Returns the scheme of the request, specifically one of the “http” and “https”
`abstract boolean`	`secure()` Check if the request was made on a secure channel
`String`	`url()` Alias of `fullPath()`
`String`	`user()` The Http Basic user
`org.osgl.web.util.UserAgent`	`userAgent()`
`String`	`userAgentStr()` Returns useragent string of this request

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

- Field Detail
  - inputStream
```
protected volatile InputStream inputStream
```
  - reader
```
protected volatile Reader reader
```
- Constructor Detail
  - Request
```
public Request()
```
- Method Detail
  - _impl
```
protected abstract Class<T> _impl()
```
    Returns the class of the implementation. Not to be used by application
    
    Returns:
    
    the class
  - context
```
public T context(Object context)
```
    Attach a context object to the request instance
    
    Parameters:
    
    context - the context object
    
    Returns:
    
    the request instance itself
  - context
```
public <CONTEXT> CONTEXT context()
```
    Get the context object from the request instance
    
    Type Parameters:
    
    CONTEXT - the generic type of the context object
    
    Returns:
    
    the context object
  - method
```
public abstract H.Method method()
```
    Returns the HTTP method of the request
    
    Returns:
    
    method
  - method
```
public abstract T method(H.Method method)
```
    Set the Http method on this request. Used by framework to “override” a HTTP method
    
    Parameters:
    
    method - the method to set
    
    Returns:
    
    this request instance
  - header
```
public abstract String header(String name)
```
    Returns the header content by name. If there are multiple headers with the same name, then the first one is returned. If there is no header has the name then null is returned
    
    Note header name is case insensitive
    
    Parameters:
    
    name - the name of the header
    
    Returns:
    
    the header content
  - headers
```
public abstract Iterable<String> headers(String name)
```
    Returns all header content by name. This method returns content of all header with the same name specified in an Iterable of String. If there is no header has the name specified, then an empty iterable is returned.
    
    Note header name is case insensitive
    
    Parameters:
    
    name - the name of the header
    
    Returns:
    
    all values of the header
  - accept
```
public H.Format accept()
```
    Return the request accept
    
    Returns:
    
    the request accept
  - accept
```
public T accept(H.Format fmt)
```
    Set accept to the request
    
    Parameters:
    
    fmt - the format to be set
    
    Returns:
    
    this request
  - accept
```
public T accept(H.MediaType mediaType)
```
  - referrer
```
public String referrer()
```
    Return the “referer(sic)” header value
    
    Returns:
    
    the http referrer
  - referer
```
public String referer()
```
    This method is an alias of referer which follows the HTTP misspelling header name referer
    
    Returns:
    
    the http referer
  - etag
```
public String etag()
```
  - etagMatches
```
public boolean etagMatches(String etag)
```
  - isAjax
```
public boolean isAjax()
```
    Check if the request is an ajax call
    
    Returns:
    
    true if it is an ajax call
  - path
```
public abstract String path()
```
    Returns the path of the request. This does not include the context path. The path is a composite of HttpServletRequest.getServletPath() and HttpServletRequest.getPathInfo()
    
    The path starts with "/" but not end with "/"
    
    Returns:
    
    URL path
  - contextPath
```
public abstract String contextPath()
```
    Returns the context path of the request. The context path starts with “/” but not end with “/”. If there is no context path then and empty "" is returned
    
    Returns:
    
    context path
  - fullPath
```
public String fullPath()
```
    Returns the full URI path. It’s composed of contextPath() and path() The full path starts with “/”
    
    Returns:
    
    full path
  - url
```
public String url()
```
    Alias of fullPath()
    
    Returns:
    
    the full URL path of the request
  - fullUrl
```
public String fullUrl()
```
    Returns the full URL including scheme, domain, port and full request path plus query string
    
    Returns:
    
    the absolute URL
  - query
```
public abstract String query()
```
    Returns query string or an empty String if the request doesn’t contains a query string
    
    Returns:
    
    query string
  - secure
```
public abstract boolean secure()
```
    Check if the request was made on a secure channel
    
    Returns:
    
    true if this is a secure request
  - scheme
```
public String scheme()
```
    Returns the scheme of the request, specifically one of the “http” and “https”
    
    Returns:
    
    the scheme of the request
  - _setCookie
```
protected void _setCookie(String name,
                          H.Cookie cookie)
```
  - domain
```
public String domain()
```
    Alias of host().
    
    Returns:
    
    host of this request
  - host
```
public String host()
```
    Returns host of this request.
    
    It will first check the X-Forwarded-Host header, if no value then check the Host header, if still no value then return empty string; otherwise
    1. host will be the part before : of the value
    2. port will be the part after : of the value
    Returns:
    
    host of this request
  - port
```
public int port()
```
    Returns the port of this request.
    
    If port cannot be resolved, then it will return the default port: * 80 for no secure connection * 443 for secure connection
    
    Returns:
    
    port the port of this request
    
    See Also:
    
    port()
  - _ip
```
protected abstract String _ip()
```
    Returns remote ip address.
    
    Returns:
    
    remote ip of this request
  - ip
```
public String ip()
```
    Returns the remote ip address of this request.
    
    The resolving process of remote ip address: 1. Check X-Forwarded-For header, if no value or value is unknown then 2. Check Proxy-Client-ip, if no value or value is unknown then 3. Check Wl-Proxy-Client-Ip, if no value or value is unknown then 4. Check HTTP_CLIENT_IP, if no value or value is unknown then 5. Check HTTP_X_FORWARDED_FOR, if no value or value is unknown then 6. return the ip address passed by underline network stack, e.g. netty or undertow
    
    Returns:
    
    remote ip of this request
  - userAgentStr
```
public String userAgentStr()
```
    Returns useragent string of this request
    
    Returns:
    
    useragent string
  - userAgent
```
public org.osgl.web.util.UserAgent userAgent()
```
  - _initCookieMap
```
protected abstract void _initCookieMap()
```
  - cookie
```
public H.Cookie cookie(String name)
```
    Returns cookie by it’s name
    
    Parameters:
    
    name - the cookie name
    
    Returns:
    
    the cookie or null if not found
  - cookies
```
public List<H.Cookie> cookies()
```
    Returns all cookies of the request in Iterable
    
    Returns:
    
    cookies
  - isModified
```
public boolean isModified(String etag,
                          long since)
```
    Check if the requested resource is modified with etag and last timestamp (usually the timestamp of a static file e.g.)
    
    Parameters:
    
    etag - the etag to compare with “If_None_Match” header in browser
    
    since - the last timestamp to compare with “If_Modified_Since” header in browser
    
    Returns:
    
    true if the resource has changed or false otherwise
  - contentType
```
public H.Format contentType()
```
    Return content type of the request
    
    Returns:
    
    content type
  - characterEncoding
```
public String characterEncoding()
```
    Returns encoding of the request
    
    Returns:
    
    character encoding
  - locale
```
public Locale locale()
```
    Returns locale of the request
    
    Returns:
    
    locale
  - locales
```
public org.osgl.util.C.List<Locale> locales()
```
    Returns all locales of the request
    
    Returns:
    
    all locales of the request
  - contentLength
```
public long contentLength()
```
    Returns the content length of the request
    
    Returns:
    
    content length
  - readerCreated
```
public boolean readerCreated()
```
  - createInputStream
```
protected abstract InputStream createInputStream()
```
  - inputStream
```
public InputStream inputStream()
                        throws IllegalStateException
```
    Returns body of the request as binary data using InputStream
    
    Returns:
    
    input stream of the request body
    
    Throws:
    
    IllegalStateException - if reader() has already been called on this request instance
  - reader
```
public Reader reader()
              throws IllegalStateException
```
    Returns body of the request as binary data using Reader
    
    Returns:
    
    the reader of the request body
    
    Throws:
    
    IllegalStateException - if inputStream() has already been called on this request instance
  - paramVal
```
public abstract String paramVal(String name)
```
    Return a request parameter value by name. If there is no parameter found with the name specified, then null is returned. If there are multiple values associated with the name, then the first one is returned
    
    Parameters:
    
    name - the parameter name
    
    Returns:
    
    the parameter value of null if not found
  - paramVals
```
public abstract String[] paramVals(String name)
```
    Returns all values associated with the name specified in the http request. If there is no parameter found with the name, then new String[0] shall be returned
    
    Parameters:
    
    name - the parameter name
    
    Returns:
    
    all values of the parameter
  - paramNames
```
public abstract Iterable<String> paramNames()
```
    Return all parameter names
    
    Returns:
    
    an Iterable of parameter names
  - user
```
public String user()
```
    The Http Basic user
    
    Returns:
    
    the user
  - password
```
public String password()
```
    the Http Basic password
    
    Returns:
    
    the password
  - me
```
protected final T me()
```
  - current
```
public static <T extends H.Request> T current()
```
    Return a request instance of the current execution context, For example from a ThreadLocal
    
    Type Parameters:
    
    T - the requestion type
    
    Returns:
    
    the current request instance
  - current
```
public static <T extends H.Request> void current(T request)
```
    Set a request instance into the current execution context, for example into a ThreadLocal
    
    Type Parameters:
    
    T - the response type
    
    Parameters:
    
    request - the request to be set to current execution context

Class H.Request<T extends H.Request>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

inputStream

reader

Constructor Detail

Request

Method Detail

_impl

context

context

method

method

header

headers

accept

accept

accept

referrer

referer

etag

etagMatches

isAjax

path

contextPath

fullPath

url

fullUrl

query

secure

scheme

_setCookie

domain

host

port

_ip

ip

userAgentStr

userAgent

_initCookieMap

cookie

cookies

isModified

contentType

characterEncoding

locale

locales

contentLength

readerCreated

createInputStream

inputStream

reader

paramVal

paramVals

paramNames

user

password

me

current

current