io.stallion.requests

Class StRequest

java.lang.Object

io.stallion.requests.StRequest

All Implemented Interfaces:

IRequest

Direct Known Subclasses:

MockRequest

public class StRequest
extends Object
implements IRequest

Field Summary

Fields inherited from interface io.stallion.requests.IRequest

RECENT_POSTBACK_COOKIE

Constructor Summary

Constructors

Constructor and Description
StRequest()
StRequest(String path, org.eclipse.jetty.server.Request baseRequest, javax.servlet.http.HttpServletRequest request)

Method Summary

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.
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
javax.servlet.http.Part	getPart(String name)
String	getPath() Get the request path
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.
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
String	getValetEmail()
Long	getValetUserId()
boolean	isScoped() Return true if this is scope-limited OAuth request
String	requestUrl() Gets the absolute url of the original request.
void	setAsMultiPartRequest()
void	setIsJsonRequest(Boolean isJsonRequest)
void	setItems(Map<String,Object> items)
void	setOrg(IOrg org)
void	setPath(String path)
void	setQuery(String query)
StRequest	setScoped(boolean scoped)
StRequest	setScopes(Set<String> scopes)
void	setUser(IUser user)
StRequest	setValetEmail(String valetEmail)
StRequest	setValetUserId(Long valetUserId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.stallion.requests.IRequest

getQueryParamAsList, getRequestUri, getRequestUrl, getRequestUrlWithQuery

Constructor Detail

StRequest

public StRequest()

StRequest

public StRequest(String path,
                 org.eclipse.jetty.server.Request baseRequest,
                 javax.servlet.http.HttpServletRequest request)

Method Detail

setAsMultiPartRequest

public void setAsMultiPartRequest()

Specified by:

setAsMultiPartRequest in interface IRequest

getHttpServletRequest

public javax.servlet.http.HttpServletRequest getHttpServletRequest()

Specified by:

getHttpServletRequest in interface IRequest

getPart

public javax.servlet.http.Part getPart(String name)

Specified by:

getPart in interface IRequest

requestUrl

public String requestUrl()

Gets the absolute url of the original request. Reconstructs the URL using the x-forwarded-host, if necessary, so this will work in the case of proxies.

Specified by:

requestUrl in interface IRequest

Returns:

getScheme

public String getScheme()

Specified by:

getScheme in interface IRequest

getHost

public String getHost()

Description copied from interface: IRequest

Gets the host by first looking for the x-forwarded-for header, and then the Host: header.

Specified by:

getHost in interface IRequest

Returns:

getQueryString

public String getQueryString()

Description copied from interface: IRequest

Get the request query string, everything after the ? in the URL

Specified by:

getQueryString in interface IRequest

Returns:

getRemoteAddr

public String getRemoteAddr()

Description copied from interface: IRequest

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

Specified by:

getRemoteAddr in interface IRequest

Returns:

getActualIp

public String getActualIp()

Description copied from interface: IRequest

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.

Specified by:

getActualIp in interface IRequest

Returns:

getBodyObject

public Object getBodyObject(Class clazz)

Description copied from interface: IRequest

Interpret the body of the request as JSON and parse it into the given object.

Specified by:

getBodyObject in interface IRequest

Returns:

getBodyMap

public Map<String,Object> getBodyMap()

Description copied from interface: IRequest

Parse the request body based on the content-type, usually either form encoded or JSON, and then parse it into a Map

Specified by:

getBodyMap in interface IRequest

Returns:

getBodyParam

public Object getBodyParam(String name)

Description copied from interface: IRequest

Internally, gets the request body as Map, and then returns the value for the given key

Specified by:

getBodyParam in interface IRequest

Returns:

getQueryParams

public Map<String,String> getQueryParams()

Description copied from interface: IRequest

Parses the query string into a map

Specified by:

getQueryParams in interface IRequest

Returns:

getCookies

public javax.servlet.http.Cookie[] getCookies()

Specified by:

getCookies in interface IRequest

getCookie

public javax.servlet.http.Cookie getCookie(String cookieName)

Specified by:

getCookie in interface IRequest

getPath

public String getPath()

Description copied from interface: IRequest

Get the request path

Specified by:

getPath in interface IRequest

Returns:

setPath

public void setPath(String path)

Specified by:

setPath in interface IRequest

getHeader

public String getHeader(String name)

Description copied from interface: IRequest

Get the given request header, case insensitive

Specified by:

getHeader in interface IRequest

Returns:

getReader

public BufferedReader getReader()
                         throws IOException

Description copied from interface: IRequest

Get a Reader that reads the request body

Specified by:

getReader in interface IRequest

Returns:

Throws:

IOException

getContent

public String getContent()

Description copied from interface: IRequest

Gets the request body as a string

Specified by:

getContent in interface IRequest

Returns:

getHeaderNames

public Enumeration<String> getHeaderNames()

Specified by:

getHeaderNames in interface IRequest

getUser

public IUser getUser()

Description copied from interface: IRequest

Gets the user associated with the current request

Specified by:

getUser in interface IRequest

Returns:

setUser

public void setUser(IUser user)

Specified by:

setUser in interface IRequest

getOrg

public IOrg getOrg()

Specified by:

getOrg in interface IRequest

setOrg

public void setOrg(IOrg org)

Specified by:

setOrg in interface IRequest

getMethod

public String getMethod()

Description copied from interface: IRequest

Gets the HTTP method - GET, POST, PUT, DELETE, etc.

Specified by:

getMethod in interface IRequest

Returns:

getParameter

public String getParameter(String paramName)

Description copied from interface: IRequest

Gets the parameter from either the query string or the request body

Specified by:

getParameter in interface IRequest

Returns:

getIsJsonRequest

public Boolean getIsJsonRequest()

Description copied from interface: IRequest

Returns true if this request is expected to produce JSON, used to determine what kind of response to give in cases of errors.

Specified by:

getIsJsonRequest in interface IRequest

Returns:

setIsJsonRequest

public void setIsJsonRequest(Boolean isJsonRequest)

Specified by:

setIsJsonRequest in interface IRequest

setQuery

public void setQuery(String query)

Specified by:

setQuery in interface IRequest

getItems

public Map<String,Object> getItems()

Description copied from interface: IRequest

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.

Specified by:

getItems in interface IRequest

Returns:

setItems

public void setItems(Map<String,Object> items)

Specified by:

setItems in interface IRequest

getSandboxedRequest

public SandboxedRequest getSandboxedRequest(Sandbox box)

Description copied from interface: IRequest

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.

Specified by:

getSandboxedRequest in interface IRequest

Returns:

getScopes

public Set<String> getScopes()

Description copied from interface: IRequest

If this is a scoped, OAuth request, return the scopes.

Specified by:

getScopes in interface IRequest

Returns:

setScopes

public StRequest setScopes(Set<String> scopes)

Specified by:

setScopes in interface IRequest

isScoped

public boolean isScoped()

Description copied from interface: IRequest

Return true if this is scope-limited OAuth request

Specified by:

isScoped in interface IRequest

Returns:

setScoped

public StRequest setScoped(boolean scoped)

Specified by:

setScoped in interface IRequest

getValetUserId

public Long getValetUserId()

setValetUserId

public StRequest setValetUserId(Long valetUserId)

getValetEmail

public String getValetEmail()

setValetEmail

public StRequest setValetEmail(String valetEmail)