```
public interface IHTTPRequest
```

Field Summary

Fields
Modifier and Type Field Description

static String HTTP_HEADER_X_FORWARDED_FOR

static String HTTP_HEADER_X_REAL_IP

static String PROPERTY_X_FORWARDED_LIST

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`int`	`getContentLength()`	Get the content length of the body of the message
`String`	`getContentType()`	Get the request content type
`String`	`getForwardedIP(String excludeAddresses)`	Get X-[real-forwarded] address
`String`	`getHeader(String name)`	Get a HTTP header value such as 'Content-Length'
`byte[]`	`getHeaderBytes()`	Returns the header as bytes
`java.util.Map<String,String>`	`getHeaderMap()`	Get a copy of the HTTP request header map
`java.util.Set<String>`	`getHeaderNames()`	Get a Set of the header names
`String`	`getHost()`	Returns the domain name and possibly the port of the server for which the HTTP Request is being sent to, for both HTTP 1.1 and HTTP 2.0
`java.io.InputStream`	`getInputStream()`	Get the body of the message as an input stream
`int`	`getIntHeader(String name)`	Get a HTTP header value such as 'Content-Length' and return as int
`java.util.Locale`	`getLocale()`	Get locale of request (Example: en-us)
`String`	`getMethod()`	Get the method invokation method: GET, POST, HEAD
`byte[]`	`getMsgBytes()`	Return the message bytes
`String`	`getParameter(String name)`	Get a parameter value
`java.util.Map<String,java.util.List<String>>`	`getParameterMap()`	Get the entire parameter Map
`java.util.Set<String>`	`getParameterNames()`	Get a Set of parameter names
`String[]`	`getParameterValues(String name)`	Get a multi-value parameter as an array of String
`String`	`getPath()`	Returns the HTTP path element of the request
`String`	`getProtocol()`	Get the request protocol (example: HTTP/1.1)
`String`	`getQueryString()`	Get the query string part of the url (everything after the ?)
`String`	`getRemoteAddr()`	Get the remote ip address of the request
`String`	`getRemoteHost()`	Get the remote host name (if known) if not return ip address
`String`	`getRequestURI()`	Get the full request URI
`String`	`getRequestURL()`	Get the request url (same as URI minus the query string)
`String`	`getScheme()`	Get the request scheme (Example "http")
`String`	`getServerName()`	Get the name of the server (Example: "Wowza Streaming Engine")
`int`	`getServerPort()`	Get the port this request was received on
`boolean`	`isHeadRequest()`	Returns true if the request is a HEAD request
`boolean`	`isSecure()`	Returns true is the request is protected by SSL
`boolean`	`isUpgradeRequest()`	Returns true if upgrade request (WebSocket,...)
`void`	`parseBodyForParams()`	If the body of the message contains parameter data (data in name value pairs separated by & character) call this routine to decode those parameters and add them to the parameter map.
`void`	`parseBodyForParams(boolean doDecode)`	If the body of the message contains parameter data (data in name value pairs separated by & character) call this routine to decode those parameters and add them to the parameter map.

- Field Detail
  - HTTP_HEADER_X_REAL_IP
```
static final String HTTP_HEADER_X_REAL_IP
```
    See Also:
    
    Constant Field Values
  - HTTP_HEADER_X_FORWARDED_FOR
```
static final String HTTP_HEADER_X_FORWARDED_FOR
```
    See Also:
    
    Constant Field Values
  - PROPERTY_X_FORWARDED_LIST
```
static final String PROPERTY_X_FORWARDED_LIST
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getHeaderMap
```
java.util.Map<String,String> getHeaderMap()
```
    Get a copy of the HTTP request header map
    
    Returns:
    
    copy of the HTTP request header map
  - getHeader
```
String getHeader(String name)
```
    Get a HTTP header value such as 'Content-Length'
    
    Parameters:
    
    name - header name
    
    Returns:
    
    header value
  - getIntHeader
```
int getIntHeader(String name)
```
    Get a HTTP header value such as 'Content-Length' and return as int
    
    Parameters:
    
    name - header name
    
    Returns:
    
    header value
  - getHeaderNames
```
java.util.Set<String> getHeaderNames()
```
    Get a Set of the header names
    
    Returns:
    
    Set of header names
  - getMethod
```
String getMethod()
```
    Get the method invokation method: GET, POST, HEAD
    
    Returns:
    
    method
  - getQueryString
```
String getQueryString()
```
    Get the query string part of the url (everything after the ?)
    
    Returns:
    
    query string
  - getContentLength
```
int getContentLength()
```
    Get the content length of the body of the message
    
    Returns:
    
    content length of the body of the message
  - getRequestURI
```
String getRequestURI()
```
    Get the full request URI
    
    Returns:
    
    full request URI
  - getRequestURL
```
String getRequestURL()
```
    Get the request url (same as URI minus the query string)
    
    Returns:
    
    request url
  - getContentType
```
String getContentType()
```
    Get the request content type
    
    Returns:
    
    request content type
  - parseBodyForParams
```
void parseBodyForParams(boolean doDecode)
```
    If the body of the message contains parameter data (data in name value pairs separated by & character) call this routine to decode those parameters and add them to the parameter map.
    
    Parameters:
    
    doDecode - true to decode the params as though they are url params
  - parseBodyForParams
```
void parseBodyForParams()
```
    If the body of the message contains parameter data (data in name value pairs separated by & character) call this routine to decode those parameters and add them to the parameter map.
  - getParameter
```
String getParameter(String name)
```
    Get a parameter value
    
    Parameters:
    
    name - parameter name
    
    Returns:
    
    parameter value
  - getParameterNames
```
java.util.Set<String> getParameterNames()
```
    Get a Set of parameter names
    
    Returns:
    
    Set of parameter names
  - getParameterValues
```
String[] getParameterValues(String name)
```
    Get a multi-value parameter as an array of String
    
    Parameters:
    
    name - parameter name
    
    Returns:
    
    multi-value parameter as an array of String
  - getParameterMap
```
java.util.Map<String,java.util.List<String>> getParameterMap()
```
    Get the entire parameter Map
    
    Returns:
    
    parameter Map
  - getInputStream
```
java.io.InputStream getInputStream()
```
    Get the body of the message as an input stream
    
    Returns:
    
    body of the message as an input stream
  - getProtocol
```
String getProtocol()
```
    Get the request protocol (example: HTTP/1.1)
    
    Returns:
    
    request protocol
  - getScheme
```
String getScheme()
```
    Get the request scheme (Example "http")
    
    Returns:
    
    request scheme
  - getServerName
```
String getServerName()
```
    Get the name of the server (Example: "Wowza Streaming Engine")
    
    Returns:
    
    name of the server
  - getServerPort
```
int getServerPort()
```
    Get the port this request was received on
    
    Returns:
    
    the port this request was received on
  - getRemoteAddr
```
String getRemoteAddr()
```
    Get the remote ip address of the request
    
    Returns:
    
    remote ip address of the request
  - getForwardedIP
```
String getForwardedIP(String excludeAddresses)
```
    Get X-[real-forwarded] address
  - getRemoteHost
```
String getRemoteHost()
```
    Get the remote host name (if known) if not return ip address
    
    Returns:
    
    remote host name
  - getLocale
```
java.util.Locale getLocale()
```
    Get locale of request (Example: en-us)
    
    Returns:
    
    locale of request
  - isSecure
```
boolean isSecure()
```
    Returns true is the request is protected by SSL
    
    Returns:
    
    true is the request is protected by SSL
  - getPath
```
String getPath()
```
    Returns the HTTP path element of the request
    
    Returns:
    
    HTTP path element of the request
  - getHeaderBytes
```
byte[] getHeaderBytes()
```
    Returns the header as bytes
    
    Returns:
    
    header as bytes
  - getMsgBytes
```
byte[] getMsgBytes()
```
    Return the message bytes
    
    Returns:
    
    message bytes
  - isHeadRequest
```
boolean isHeadRequest()
```
    Returns true if the request is a HEAD request
    
    Returns:
    
    true if the request is a HEAD request
  - isUpgradeRequest
```
boolean isUpgradeRequest()
```
    Returns true if upgrade request (WebSocket,...)
    
    Returns:
    
    Returns true if upgrade request
  - getHost
```
String getHost()
```
    Returns the domain name and possibly the port of the server for which the HTTP Request is being sent to, for both HTTP 1.1 and HTTP 2.0
    
    Returns:
    
    the domain name, to possibly include the port for the service requested ( if it is non-standard ), or an empty string if it is not defined

Modifier and Type	Field	Description
`static String`	`HTTP_HEADER_X_FORWARDED_FOR`
`static String`	`HTTP_HEADER_X_REAL_IP`
`static String`	`PROPERTY_X_FORWARDED_LIST`

Interface IHTTPRequest

Field Summary

Method Summary

Field Detail

HTTP_HEADER_X_REAL_IP

HTTP_HEADER_X_FORWARDED_FOR

PROPERTY_X_FORWARDED_LIST

Method Detail

getHeaderMap

getHeader

getIntHeader

getHeaderNames

getMethod

getQueryString

getContentLength

getRequestURI

getRequestURL

getContentType

parseBodyForParams

parseBodyForParams

getParameter

getParameterNames

getParameterValues

getParameterMap

getInputStream

getProtocol

getScheme

getServerName

getServerPort

getRemoteAddr

getForwardedIP

getRemoteHost

getLocale

isSecure

getPath

getHeaderBytes

getMsgBytes

isHeadRequest

isUpgradeRequest

getHost