ServletRequest (OSGL HTTP 1.13.1 API)

java.lang.Object
- org.osgl.http.H.Request
- - org.osgl.http.servlet.ServletRequest

public class ServletRequest
extends H.Request

Field Summary
- Fields inherited from class org.osgl.http.H.Request
  inputStream, reader

Constructor Summary

Constructors
Constructor and Description

ServletRequest(javax.servlet.http.HttpServletRequest req)

Constructors
Constructor and Description
`ServletRequest(javax.servlet.http.HttpServletRequest req)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected Class`	`_impl()` Returns the class of the implementation.
`protected void`	`_initCookieMap()`
`protected String`	`_ip()` Returns remote ip address.
`String`	`contextPath()` Returns the context path of the request.
`InputStream`	`createInputStream()`
`String`	`header(String name)` Returns the header content by name.
`Iterable<String>`	`headerNames()` Returns all header names presented in this request.
`Iterable<String>`	`headers(String name)` Returns all header content by name.
`H.Method`	`method()` Returns the HTTP method of the request
`ServletRequest`	`method(H.Method method)` Set the Http method on this request.
`Iterable<String>`	`paramNames()` Return all parameter names
`String`	`paramVal(String name)` Return a request parameter value by name.
`String[]`	`paramVals(String name)` Returns all values associated with the name specified in the http request.
`String`	`path()` Returns the path of the request.
`String`	`query()` Returns query string or an empty String if the request doesn’t contains a query string
`boolean`	`secure()` Check if the request was made on a secure channel

Methods inherited from class org.osgl.http.H.Request
_setCookie, accept, accept, accept, characterEncoding, contentLength, contentType, context, context, cookie, cookies, current, current, domain, etag, etagMatches, fullPath, fullUrl, host, inputStream, ip, isAjax, isModified, locale, locales, me, password, port, rawAccept, reader, readerCreated, referer, referrer, scheme, toString, url, user, userAgent, userAgentStr

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

- Constructor Detail
  - ServletRequest
```
public ServletRequest(javax.servlet.http.HttpServletRequest req)
```
- Method Detail
  - _impl
```
protected Class _impl()
```
    Description copied from class: H.Request
    
    Returns the class of the implementation. Not to be used by application
    
    Specified by:
    
    _impl in class H.Request
    
    Returns:
    the class
  - headers
```
public Iterable<String> headers(String name)
```
    Description copied from class: H.Request
    
    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
    
    Specified by:
    
    headers in class H.Request
    
    Parameters:
    name - the name of the header
    
    Returns:
    all values of the header
  - headerNames
```
public Iterable<String> headerNames()
```
    Description copied from class: H.Request
    
    Returns all header names presented in this request.
    
    Specified by:
    
    headerNames in class H.Request
    
    Returns:
    all header names as an Iterable of String.
  - path
```
public String path()
```
    Description copied from class: H.Request
    
    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 "/"
    
    Specified by:
    
    path in class H.Request
    
    Returns:
    URL path
  - contextPath
```
public String contextPath()
```
    Description copied from class: H.Request
    
    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
    
    Specified by:
    
    contextPath in class H.Request
    
    Returns:
    context path
  - query
```
public String query()
```
    Description copied from class: H.Request
    
    Returns query string or an empty String if the request doesn’t contains a query string
    
    Specified by:
    
    query in class H.Request
    
    Returns:
    query string
  - secure
```
public boolean secure()
```
    Description copied from class: H.Request
    
    Check if the request was made on a secure channel
    
    Specified by:
    
    secure in class H.Request
    
    Returns:
    true if this is a secure request
  - _ip
```
protected String _ip()
```
    Description copied from class: H.Request
    
    Returns remote ip address.
    
    Specified by:
    
    _ip in class H.Request
    
    Returns:
    remote ip of this request
  - _initCookieMap
```
protected void _initCookieMap()
```
    Specified by:
    
    _initCookieMap in class H.Request
  - header
```
public String header(String name)
```
    Description copied from class: H.Request
    
    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
    
    Specified by:
    
    header in class H.Request
    
    Parameters:
    name - the name of the header
    
    Returns:
    the header content
  - method
```
public H.Method method()
```
    Description copied from class: H.Request
    
    Returns the HTTP method of the request
    
    Specified by:
    
    method in class H.Request
    
    Returns:
    method
  - method
```
public ServletRequest method(H.Method method)
```
    Description copied from class: H.Request
    
    Set the Http method on this request. Used by framework to “override” a HTTP method
    
    Specified by:
    
    method in class H.Request
    
    Parameters:
    method - the method to set
    
    Returns:
    this request instance
  - createInputStream
```
public InputStream createInputStream()
                              throws IllegalStateException
```
    Specified by:
    
    createInputStream in class H.Request
    
    Throws:
    
    IllegalStateException
  - paramVal
```
public String paramVal(String name)
```
    Description copied from class: H.Request
    
    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
    
    Specified by:
    
    paramVal in class H.Request
    
    Parameters:
    name - the parameter name
    
    Returns:
    the parameter value of null if not found
  - paramVals
```
public String[] paramVals(String name)
```
    Description copied from class: H.Request
    
    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
    
    Specified by:
    
    paramVals in class H.Request
    
    Parameters:
    name - the parameter name
    
    Returns:
    all values of the parameter
  - paramNames
```
public Iterable<String> paramNames()
```
    Description copied from class: H.Request
    
    Return all parameter names
    
    Specified by:
    
    paramNames in class H.Request
    
    Returns:
    an Iterable of parameter names

Class ServletRequest

Field Summary

Fields inherited from class org.osgl.http.H.Request

Constructor Summary

Method Summary

Methods inherited from class org.osgl.http.H.Request

Methods inherited from class java.lang.Object

Constructor Detail

ServletRequest

Method Detail

_impl

headers

headerNames

path

contextPath

query

secure

_ip

_initCookieMap

header

method

method

createInputStream

paramVal

paramVals

paramNames