RequestContext (Latke Core 3.0.8 API)

java.lang.Object
- org.b3log.latke.http.RequestContext

```
public final class RequestContext
extends Object
```
HTTP request context.

Version:

2.0.0.0, Nov 3, 2019

Author:

Liang Ding

Constructor Summary

Constructors
Constructor and Description

RequestContext()

Constructors
Constructor and Description
`RequestContext()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`abort()` Aborts the remaining handlers.
`void`	`addHandler(Handler handler)` Adds the specified handler to handler chain.
`void`	`addHeader(String name, String value)` Adds a header specified by the given name and value to the response.
`Object`	`attr(String name)` Gets an attribute specified by the given name from request.
`void`	`attr(String name, Object value)` Sets an attribute specified by the given name and value into request.
`Map<String,Object>`	`getDataModel()` Gets the data model of renderer bound with this context.
`AbstractResponseRenderer`	`getRenderer()` Gets the renderer.
`Request`	`getRequest()` Gets the request.
`Response`	`getResponse()` Gets the response.
`void`	`handle()` Handles this context with handlers.
`String`	`header(String name)` Gets the value of a header specified by the given name
`String`	`method()` Gets the request HTTP method.
`String`	`param(String name)` Gets a parameter specified by the given name from request body form or query string.
`String`	`pathVar(String name)` Gets a path var specified by the given name from request URI.
`void`	`pathVar(String name, String value)` Puts a path var specified by the given name and value.
`Map<String,String>`	`pathVars()` Get all path vars.
`void`	`pathVars(Map<String,String> pathVars)` Set all path vars.
`String`	`remoteAddr()` Gets the remote address of request.
`RequestContext`	`renderCode(int code)` Renders with {"code": int}.
`RequestContext`	`renderData(Object data)` Renders with {"data": obj}.
`RequestContext`	`renderFalseResult()` Renders with {"sc": false}.
`RequestContext`	`renderJSON()` Renders using `JsonRenderer` with {"sc": false}.
`RequestContext`	`renderJSON(boolean sc)` Renders using `JsonRenderer` with {"sc": sc}.
`RequestContext`	`renderJSON(int code)` Renders using `JsonRenderer` with {"code": int}.
`RequestContext`	`renderJSON(JSONObject json)` Renders with the specified json object.
`RequestContext`	`renderJSONPretty(JSONObject json)` Pretty rends with the specified json object.
`RequestContext`	`renderJSONValue(String name, Object obj)` Renders with {"name", obj}.
`RequestContext`	`renderMsg(String msg)` Renders with {"msg": msg}.
`RequestContext`	`renderPretty()` Pretty renders.
`RequestContext`	`renderTrueResult()` Renders with {"sc": true}.
`JSONObject`	`requestJSON()` Gets the request json object.
`String`	`requestURI()` Gets the request URI.
`void`	`sendError(int sc)` Sends the specified error status code.
`void`	`sendRedirect(String location)` Sends redirect to the specified location.
`void`	`sendStatus(int sc)` Sends the specified status code.
`void`	`setHeader(String name, String value)` Sets a header specified by the given name and value to the response.
`void`	`setRenderer(AbstractResponseRenderer renderer)` Sets the renderer with the specified renderer.
`void`	`setRequest(Request request)` Sets the request with the specified request.
`void`	`setResponse(Response response)` Sets the response with the specified response.
`void`	`setStatus(int sc)` Sends the specified status code.

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

- Constructor Detail
  - RequestContext
```
public RequestContext()
```
- Method Detail
  - getRenderer
```
public AbstractResponseRenderer getRenderer()
```
    Gets the renderer.
    
    Returns:
    
    renderer
  - setRenderer
```
public void setRenderer(AbstractResponseRenderer renderer)
```
    Sets the renderer with the specified renderer.
    
    Parameters:
    
    renderer - the specified renderer
  - getRequest
```
public Request getRequest()
```
    Gets the request.
    
    Returns:
    
    request
  - setRequest
```
public void setRequest(Request request)
```
    Sets the request with the specified request.
    
    Parameters:
    
    request - the specified request
  - getResponse
```
public Response getResponse()
```
    Gets the response.
    
    Returns:
    
    response
  - setResponse
```
public void setResponse(Response response)
```
    Sets the response with the specified response.
    
    Parameters:
    
    response - the specified response
  - getDataModel
```
public Map<String,Object> getDataModel()
```
    Gets the data model of renderer bound with this context.
    
    Returns:
    
    data model, returns null if not found
  - remoteAddr
```
public String remoteAddr()
```
    Gets the remote address of request.
    
    Returns:
    
    remote address
  - sendRedirect
```
public void sendRedirect(String location)
```
    Sends redirect to the specified location.
    
    Parameters:
    
    location - the specified location
  - header
```
public String header(String name)
```
    Gets the value of a header specified by the given name
    
    Parameters:
    
    name - the given name
  - addHeader
```
public void addHeader(String name,
                      String value)
```
    Adds a header specified by the given name and value to the response.
    
    Parameters:
    
    name - the given name
    
    value - the given value
  - setHeader
```
public void setHeader(String name,
                      String value)
```
    Sets a header specified by the given name and value to the response.
    
    Parameters:
    
    name - the given name
    
    value - the given value
  - method
```
public String method()
```
    Gets the request HTTP method.
    
    Returns:
    
    HTTP method
  - requestURI
```
public String requestURI()
```
    Gets the request URI.
    
    Returns:
    
    request URI
  - attr
```
public Object attr(String name)
```
    Gets an attribute specified by the given name from request.
    
    Parameters:
    
    name - the given name
    
    Returns:
    
    attribute, returns null if not found
  - attr
```
public void attr(String name,
                 Object value)
```
    Sets an attribute specified by the given name and value into request.
    
    Parameters:
    
    name - the given name
    
    value - the given value
  - param
```
public String param(String name)
```
    Gets a parameter specified by the given name from request body form or query string.
    
    Parameters:
    
    name - the given name
    
    Returns:
    
    parameter, returns null if not found
  - pathVar
```
public String pathVar(String name)
```
    Gets a path var specified by the given name from request URI.
    
    Parameters:
    
    name - the given name
    
    Returns:
    
    path var, returns null if not found
  - pathVars
```
public Map<String,String> pathVars()
```
    Get all path vars.
    
    Returns:
    
    path vars
  - pathVars
```
public void pathVars(Map<String,String> pathVars)
```
    Set all path vars.
    
    Parameters:
    
    pathVars - the specified path vars
  - pathVar
```
public void pathVar(String name,
                    String value)
```
    Puts a path var specified by the given name and value.
    
    Parameters:
    
    name - the given name
    
    value - the given value
  - sendError
```
public void sendError(int sc)
```
    Sends the specified error status code.
    
    Parameters:
    
    sc - the specified error status code
  - sendStatus
```
public void sendStatus(int sc)
```
    Sends the specified status code.
    
    Parameters:
    
    sc - the specified status code
  - setStatus
```
public void setStatus(int sc)
```
    Sends the specified status code.
    
    Parameters:
    
    sc - the specified status code
  - requestJSON
```
public JSONObject requestJSON()
```
    Gets the request json object.
    
    Returns:
    
    request json object
  - renderJSONPretty
```
public RequestContext renderJSONPretty(JSONObject json)
```
    Pretty rends with the specified json object.
    
    Parameters:
    
    json - the specified json object
    
    Returns:
    
    this context
  - renderJSON
```
public RequestContext renderJSON()
```
    Renders using JsonRenderer with {"sc": false}.
    
    Returns:
    
    this context
  - renderJSON
```
public RequestContext renderJSON(JSONObject json)
```
    Renders with the specified json object.
    
    Parameters:
    
    json - the specified json object
    
    Returns:
    
    this context
  - renderJSON
```
public RequestContext renderJSON(boolean sc)
```
    Renders using JsonRenderer with {"sc": sc}.
    
    Parameters:
    
    sc - the specified sc
    
    Returns:
    
    this context
  - renderJSON
```
public RequestContext renderJSON(int code)
```
    Renders using JsonRenderer with {"code": int}.
    
    Parameters:
    
    code - the specified code
    
    Returns:
    
    this context
  - renderTrueResult
```
public RequestContext renderTrueResult()
```
    Renders with {"sc": true}.
    
    Returns:
    
    this context
  - renderFalseResult
```
public RequestContext renderFalseResult()
```
    Renders with {"sc": false}.
    
    Returns:
    
    this context
  - renderCode
```
public RequestContext renderCode(int code)
```
    Renders with {"code": int}.
    
    Parameters:
    
    code - the specified code
    
    Returns:
    
    this context
  - renderMsg
```
public RequestContext renderMsg(String msg)
```
    Renders with {"msg": msg}.
    
    Parameters:
    
    msg - the specified msg
    
    Returns:
    
    this context
  - renderData
```
public RequestContext renderData(Object data)
```
    Renders with {"data": obj}.
    
    Parameters:
    
    data - the specified JSON data
    
    Returns:
    
    this context
  - renderPretty
```
public RequestContext renderPretty()
```
    Pretty renders.
    
    Returns:
    
    this context
  - renderJSONValue
```
public RequestContext renderJSONValue(String name,
                                      Object obj)
```
    Renders with {"name", obj}.
    
    Parameters:
    
    name - the specified name
    
    obj - the specified object
    
    Returns:
    
    this context
  - handle
```
public void handle()
```
    Handles this context with handlers.
  - abort
```
public void abort()
```
    Aborts the remaining handlers.
  - addHandler
```
public void addHandler(Handler handler)
```
    Adds the specified handler to handler chain.
    
    Parameters:
    
    handler - the specified handler

Class RequestContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RequestContext

Method Detail

getRenderer

setRenderer

getRequest

setRequest

getResponse

setResponse

getDataModel

remoteAddr

sendRedirect

header

addHeader

setHeader

method

requestURI

attr

attr

param

pathVar

pathVars

pathVars

pathVar

sendError

sendStatus

setStatus

requestJSON

renderJSONPretty

renderJSON

renderJSON

renderJSON

renderJSON

renderTrueResult

renderFalseResult

renderCode

renderMsg

renderData

renderPretty

renderJSONValue

handle

abort

addHandler