IRequest (stallion-core 1.0.0-SNAPSHOT API)

All Known Implementing Classes:

EmptyRequest, JobRequest, MockRequest, SandboxedRequest, StRequest, TaskRequest
```
public interface IRequest
```

Field Summary

Fields
Modifier and Type Field and Description

static String RECENT_POSTBACK_COOKIE

Fields
Modifier and Type	Field and Description
`static String`	`RECENT_POSTBACK_COOKIE`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`String`	`getActualIp()` Tries to guess the actual IP address of the end-user, by looking at the IP address header as defined in settings.ipHeaderName (x-real-ip by default) and then getRemoteAddr() if the header does not exist.
`Map<String,Object>`	`getBodyMap()` Parse the request body based on the content-type, usually either form encoded or JSON, and then parse it into a Map
`Object`	`getBodyObject(Class clazz)` Interpret the body of the request as JSON and parse it into the given object.
`Object`	`getBodyParam(String name)` Internally, gets the request body as Map, and then returns the value for the given key
`String`	`getContent()` Gets the request body as a string
`javax.servlet.http.Cookie`	`getCookie(String cookieName)`
`javax.servlet.http.Cookie[]`	`getCookies()`
`String`	`getHeader(String name)` Get the given request header, case insensitive
`Enumeration<String>`	`getHeaderNames()`
`String`	`getHost()` Gets the host by first looking for the x-forwarded-for header, and then the Host: header.
`default javax.servlet.http.HttpServletRequest`	`getHttpServletRequest()`
`Boolean`	`getIsJsonRequest()` Returns true if this request is expected to produce JSON, used to determine what kind of response to give in cases of errors.
`Map<String,Object>`	`getItems()` Get an arbitrary hashmap of data that lives the lifetime of this request, can be used as a very short lived cache, or for any other arbitrary use.
`String`	`getMethod()` Gets the HTTP method - GET, POST, PUT, DELETE, etc.
`IOrg`	`getOrg()`
`String`	`getParameter(String paramName)` Gets the parameter from either the query string or the request body
`default javax.servlet.http.Part`	`getPart(String name)`
`String`	`getPath()` Get the request path
`default List<String>`	`getQueryParamAsList(String key)`
`Map<String,String>`	`getQueryParams()` Parses the query string into a map
`String`	`getQueryString()` Get the request query string, everything after the ? in the URL
`BufferedReader`	`getReader()` Get a Reader that reads the request body
`String`	`getRemoteAddr()` Get the RemoteAddr field from the underlying HttpServletRequest object, which gets it from the socket connection.
`default URI`	`getRequestUri()`
`default String`	`getRequestUrl()` Alis for requestUrl()
`default String`	`getRequestUrlWithQuery()` Absolute URL of the request with the query string.
`SandboxedRequest`	`getSandboxedRequest(Sandbox box)` Get a sandboxed version of this request object.
`String`	`getScheme()`
`Set<String>`	`getScopes()` If this is a scoped, OAuth request, return the scopes.
`IUser`	`getUser()` Gets the user associated with the current request
`boolean`	`isScoped()` Return true if this is scope-limited OAuth request
`String`	`requestUrl()` Get the full, externally facing URL used to intiate this request.
`default void`	`setAsMultiPartRequest()`
`void`	`setIsJsonRequest(Boolean isJsonRequest)`
`void`	`setItems(Map<String,Object> items)`
`void`	`setOrg(IOrg org)`
`void`	`setPath(String path)`
`void`	`setQuery(String query)`
`IRequest`	`setScoped(boolean scoped)`
`IRequest`	`setScopes(Set<String> scopes)`
`void`	`setUser(IUser user)`

- Field Detail
  - RECENT_POSTBACK_COOKIE
```
static final String RECENT_POSTBACK_COOKIE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - setAsMultiPartRequest
```
default void setAsMultiPartRequest()
```
  - getPart
```
default javax.servlet.http.Part getPart(String name)
```
  - getHttpServletRequest
```
default javax.servlet.http.HttpServletRequest getHttpServletRequest()
```
  - requestUrl
```
String requestUrl()
```
    Get the full, externally facing URL used to intiate this request.
    
    Returns:
  - getRequestUrl
```
default String getRequestUrl()
```
    Alis for requestUrl()
    
    Returns:
  - getScheme
```
String getScheme()
```
  - getRequestUri
```
default URI getRequestUri()
```
  - getRequestUrlWithQuery
```
default String getRequestUrlWithQuery()
```
    Absolute URL of the request with the query string.
  - getQueryString
```
String getQueryString()
```
    Get the request query string, everything after the ? in the URL
    
    Returns:
  - getQueryParamAsList
```
default List<String> getQueryParamAsList(String key)
```
  - getRemoteAddr
```
String getRemoteAddr()
```
    Get the RemoteAddr field from the underlying HttpServletRequest object, which gets it from the socket connection. Note that if you have nginx running as a proxy in front of Stallion, then remoteAddr will be localhost, since the socket connection is coming from Nginx. If you have a load balancer in front of Stallion, the remoteAddr will be of the load balancer
    
    Returns:
  - getHost
```
String getHost()
```
    Gets the host by first looking for the x-forwarded-for header, and then the Host: header.
    
    Returns:
  - getActualIp
```
String getActualIp()
```
    Tries to guess the actual IP address of the end-user, by looking at the IP address header as defined in settings.ipHeaderName (x-real-ip by default) and then getRemoteAddr() if the header does not exist.
    
    Returns:
  - getBodyObject
```
Object getBodyObject(Class clazz)
```
    Interpret the body of the request as JSON and parse it into the given object.
    
    Parameters:
    
    clazz -
    
    Returns:
  - getBodyMap
```
Map<String,Object> getBodyMap()
```
    Parse the request body based on the content-type, usually either form encoded or JSON, and then parse it into a Map
    
    Returns:
  - getBodyParam
```
Object getBodyParam(String name)
```
    Internally, gets the request body as Map, and then returns the value for the given key
    
    Parameters:
    
    name -
    
    Returns:
  - getQueryParams
```
Map<String,String> getQueryParams()
```
    Parses the query string into a map
    
    Returns:
  - getCookies
```
javax.servlet.http.Cookie[] getCookies()
```
  - getCookie
```
javax.servlet.http.Cookie getCookie(String cookieName)
```
  - getPath
```
String getPath()
```
    Get the request path
    
    Returns:
  - setPath
```
void setPath(String path)
```
  - getHeader
```
String getHeader(String name)
```
    Get the given request header, case insensitive
    
    Parameters:
    
    name -
    
    Returns:
  - getReader
```
BufferedReader getReader()
                  throws IOException
```
    Get a Reader that reads the request body
    
    Returns:
    
    Throws:
    
    IOException
  - getContent
```
String getContent()
```
    Gets the request body as a string
    
    Returns:
  - getHeaderNames
```
Enumeration<String> getHeaderNames()
```
  - getUser
```
IUser getUser()
```
    Gets the user associated with the current request
    
    Returns:
  - setUser
```
void setUser(IUser user)
```
  - getOrg
```
IOrg getOrg()
```
  - setOrg
```
void setOrg(IOrg org)
```
  - getMethod
```
String getMethod()
```
    Gets the HTTP method - GET, POST, PUT, DELETE, etc.
    
    Returns:
  - getParameter
```
String getParameter(String paramName)
```
    Gets the parameter from either the query string or the request body
    
    Parameters:
    
    paramName -
    
    Returns:
  - getIsJsonRequest
```
Boolean getIsJsonRequest()
```
    Returns true if this request is expected to produce JSON, used to determine what kind of response to give in cases of errors.
    
    Returns:
  - setIsJsonRequest
```
void setIsJsonRequest(Boolean isJsonRequest)
```
  - setQuery
```
void setQuery(String query)
```
  - getItems
```
Map<String,Object> getItems()
```
    Get an arbitrary hashmap of data that lives the lifetime of this request, can be used as a very short lived cache, or for any other arbitrary use.
    
    Returns:
  - setItems
```
void setItems(Map<String,Object> items)
```
  - getSandboxedRequest
```
SandboxedRequest getSandboxedRequest(Sandbox box)
```
    Get a sandboxed version of this request object. Sandboxing usually limits access to the headers and cookies, so that a plugin cannot steal authentication tokens.
    
    Parameters:
    
    box -
    
    Returns:
  - getScopes
```
Set<String> getScopes()
```
    If this is a scoped, OAuth request, return the scopes.
    
    Returns:
  - setScopes
```
IRequest setScopes(Set<String> scopes)
```
  - isScoped
```
boolean isScoped()
```
    Return true if this is scope-limited OAuth request
    
    Returns:
  - setScoped
```
IRequest setScoped(boolean scoped)
```

Interface IRequest

Field Summary

Method Summary

Field Detail

RECENT_POSTBACK_COOKIE

Method Detail

setAsMultiPartRequest

getPart

getHttpServletRequest

requestUrl

getRequestUrl

getScheme

getRequestUri

getRequestUrlWithQuery

getQueryString

getQueryParamAsList

getRemoteAddr

getHost

getActualIp

getBodyObject

getBodyMap

getBodyParam

getQueryParams

getCookies

getCookie

getPath

setPath

getHeader

getReader

getContent

getHeaderNames

getUser

setUser

getOrg

setOrg

getMethod

getParameter

getIsJsonRequest

setIsJsonRequest

setQuery

getItems

setItems

getSandboxedRequest

getScopes

setScopes

isScoped

setScoped