Package spark.http.matching
Class RequestWrapper
- java.lang.Object
-
- spark.Request
-
- spark.http.matching.RequestWrapper
-
final class RequestWrapper extends Request
-
-
Constructor Summary
Constructors Modifier Constructor Description private
RequestWrapper()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description <T> T
attribute(java.lang.String attribute)
Gets the value of the provided attributevoid
attribute(java.lang.String attribute, java.lang.Object value)
Sets an attribute on the request (can be fetched in filters/routes later in the chain)java.util.Set<java.lang.String>
attributes()
java.lang.String
body()
byte[]
bodyAsBytes()
void
changeMatch(RouteMatch match)
int
contentLength()
java.lang.String
contentType()
java.lang.String
contextPath()
java.lang.String
cookie(java.lang.String name)
Gets cookie by name.java.util.Map<java.lang.String,java.lang.String>
cookies()
(package private) static RequestWrapper
create()
boolean
equals(java.lang.Object obj)
(package private) Request
getDelegate()
int
hashCode()
java.util.Set<java.lang.String>
headers()
java.lang.String
headers(java.lang.String header)
Gets the value for the provided headerjava.lang.String
host()
java.lang.String
ip()
java.lang.String
matchedPath()
java.util.Map<java.lang.String,java.lang.String>
params()
Returns the map containing all route paramsjava.lang.String
params(java.lang.String param)
Returns the value of the provided route pattern parameter.java.lang.String
pathInfo()
int
port()
java.lang.String
protocol()
QueryParamsMap
queryMap()
QueryParamsMap
queryMap(java.lang.String key)
java.util.Set<java.lang.String>
queryParams()
java.lang.String
queryParams(java.lang.String queryParam)
Gets the query paramjava.lang.String
queryParamsSafe(java.lang.String queryParam)
Gets the query param and encode itjava.lang.String[]
queryParamsValues(java.lang.String queryParam)
Gets all the values of the query param Example: query parameter 'id' from the following request URI: /hello?id=foo&id=barjava.lang.String
queryString()
javax.servlet.http.HttpServletRequest
raw()
java.lang.String
requestMethod()
java.lang.String
scheme()
java.lang.String
servletPath()
Session
session()
Returns the current session associated with this request, or if the request does not have a session, creates one.Session
session(boolean create)
Returns the current session associated with this request, or if there is no current session andcreate
is true, returns a new session.void
setDelegate(Request delegate)
java.lang.String[]
splat()
java.lang.String
toString()
java.lang.String
uri()
java.lang.String
url()
java.lang.String
userAgent()
-
Methods inherited from class spark.Request
queryParamOrDefault
-
-
-
-
Field Detail
-
delegate
private Request delegate
-
-
Method Detail
-
create
static RequestWrapper create()
-
setDelegate
public void setDelegate(Request delegate)
-
getDelegate
Request getDelegate()
-
changeMatch
public void changeMatch(RouteMatch match)
- Overrides:
changeMatch
in classRequest
-
requestMethod
public java.lang.String requestMethod()
- Overrides:
requestMethod
in classRequest
- Returns:
- request method e.g. GET, POST, PUT, ...
-
pathInfo
public java.lang.String pathInfo()
-
matchedPath
public java.lang.String matchedPath()
- Overrides:
matchedPath
in classRequest
- Returns:
- the matched route Example return: "/account/:accountId"
-
servletPath
public java.lang.String servletPath()
- Overrides:
servletPath
in classRequest
- Returns:
- the servlet path
-
contextPath
public java.lang.String contextPath()
- Overrides:
contextPath
in classRequest
- Returns:
- the context path
-
contentType
public java.lang.String contentType()
- Overrides:
contentType
in classRequest
- Returns:
- the content type of the body
-
body
public java.lang.String body()
-
bodyAsBytes
public byte[] bodyAsBytes()
- Overrides:
bodyAsBytes
in classRequest
-
contentLength
public int contentLength()
- Overrides:
contentLength
in classRequest
- Returns:
- the length of request.body
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
params
public java.util.Map<java.lang.String,java.lang.String> params()
Description copied from class:Request
Returns the map containing all route params
-
params
public java.lang.String params(java.lang.String param)
Description copied from class:Request
Returns the value of the provided route pattern parameter. Example: parameter 'name' from the following pattern: (get '/hello/:name')
-
splat
public java.lang.String[] splat()
-
queryParams
public java.lang.String queryParams(java.lang.String queryParam)
Description copied from class:Request
Gets the query param- Overrides:
queryParams
in classRequest
- Parameters:
queryParam
- the query parameter- Returns:
- the value of the provided queryParam Example: query parameter 'id' from the following request URI: /hello?id=foo
-
queryParamsSafe
public java.lang.String queryParamsSafe(java.lang.String queryParam)
Description copied from class:Request
Gets the query param and encode it- Overrides:
queryParamsSafe
in classRequest
- Parameters:
queryParam
- the query parameter- Returns:
- the encode value of the provided queryParam Example: query parameter 'me' from the URI: /hello?id=fool.
-
queryParamsValues
public java.lang.String[] queryParamsValues(java.lang.String queryParam)
Description copied from class:Request
Gets all the values of the query param Example: query parameter 'id' from the following request URI: /hello?id=foo&id=bar- Overrides:
queryParamsValues
in classRequest
- Parameters:
queryParam
- the query parameter- Returns:
- the values of the provided queryParam, null if it doesn't exists
-
headers
public java.lang.String headers(java.lang.String header)
Description copied from class:Request
Gets the value for the provided header
-
queryParams
public java.util.Set<java.lang.String> queryParams()
- Overrides:
queryParams
in classRequest
- Returns:
- all query parameters
-
headers
public java.util.Set<java.lang.String> headers()
-
queryString
public java.lang.String queryString()
- Overrides:
queryString
in classRequest
- Returns:
- the query string
-
raw
public javax.servlet.http.HttpServletRequest raw()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
userAgent
public java.lang.String userAgent()
-
uri
public java.lang.String uri()
-
protocol
public java.lang.String protocol()
-
attribute
public void attribute(java.lang.String attribute, java.lang.Object value)
Description copied from class:Request
Sets an attribute on the request (can be fetched in filters/routes later in the chain)
-
attribute
public <T> T attribute(java.lang.String attribute)
Description copied from class:Request
Gets the value of the provided attribute
-
attributes
public java.util.Set<java.lang.String> attributes()
- Overrides:
attributes
in classRequest
- Returns:
- all attributes
-
session
public Session session()
Description copied from class:Request
Returns the current session associated with this request, or if the request does not have a session, creates one.
-
session
public Session session(boolean create)
Description copied from class:Request
Returns the current session associated with this request, or if there is no current session andcreate
is true, returns a new session.
-
queryMap
public QueryParamsMap queryMap()
-
queryMap
public QueryParamsMap queryMap(java.lang.String key)
-
cookies
public java.util.Map<java.lang.String,java.lang.String> cookies()
-
-