RestCall (Apache Juneau 8.1.3)

java.lang.Object
- org.apache.juneau.rest.RestCall

```
public class RestCall
extends Object
```
A wrapper around a single HttpServletRequest/HttpServletResponse pair.

Constructor Summary

Constructors
Constructor and Description

RestCall(HttpServletRequest req, HttpServletResponse res)
Constructor.

Constructors
Constructor and Description
`RestCall(HttpServletRequest req, HttpServletResponse res)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RestCall`	`debug(boolean b)` Enables or disabled debug mode on this call.
`RestCall`	`exception(Throwable e)` Identifies that an exception occurred during this call.
`RestCall`	`finish()` Called at the end of a call to finish any remaining tasks such as flushing buffers and logging the response.
`String`	`getMethod()` Returns the HTTP method name.
`Object`	`getOutput()` Shortcut for calling getRestResponse().getOutput().
`String`	`getPathInfo()` Shortcut for calling getRequest().getPathInfo().
`String`	`getPathInfoUndecoded()` Same as `getPathInfo()` but doesn't decode encoded characters.
`HttpServletRequest`	`getRequest()` Returns the HTTP servlet request of this REST call.
`HttpServletResponse`	`getResponse()` Returns the HTTP servlet response of this REST call.
`RestRequest`	`getRestRequest()` Returns the REST request of this REST call.
`RestResponse`	`getRestResponse()` Returns the REST response of this REST call.
`String`	`getServletPath()` Shortcut for calling getRequest().getServletPath().
`int`	`getStatus()` Shortcut for calling getRequest().getStatus().
`UrlPathInfo`	`getUrlPathInfo()` Returns the request path info as a `UrlPathInfo` bean.
`boolean`	`hasOutput()` Shortcut for calling getRestResponse().hasOutput().
`RestCall`	`logger(RestCallLogger logger)` Sets the logger to use when logging this call.
`RestCall`	`loggerConfig(RestCallLoggerConfig config)` Sets the logging configuration to use when logging this call.
`RestCall`	`output(Object output)` Sets the output object to serialize as the response of this call.
`RestCall`	`request(HttpServletRequest req)` Overrides the request object on the REST call.
`RestCall`	`response(HttpServletResponse res)` Overrides the response object on the REST call.
`RestCall`	`responseMeta(ResponseBeanMeta meta)` Sets metadata about the response.
`RestCall`	`restRequest(RestRequest rreq)` Set the `RestRequest` object on this REST call.
`RestCall`	`restResponse(RestResponse rres)` Set the `RestResponse` object on this REST call.
`RestCall`	`status(int code)` Sets the HTTP status on this call.

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

- Constructor Detail
  - RestCall
```
public RestCall(HttpServletRequest req,
                HttpServletResponse res)
```
    Constructor.
    
    Parameters:
    
    req - The incoming HTTP servlet request object.
    
    res - The incoming HTTP servlet response object.
- Method Detail
  - request
```
public RestCall request(HttpServletRequest req)
```
    Overrides the request object on the REST call.
    
    Parameters:
    
    req - The new HTTP servlet request.
    
    Returns:
    
    This object (for method chaining).
  - response
```
public RestCall response(HttpServletResponse res)
```
    Overrides the response object on the REST call.
    
    Parameters:
    
    res - The new HTTP servlet response.
    
    Returns:
    
    This object (for method chaining).
  - restRequest
```
public RestCall restRequest(RestRequest rreq)
```
    Set the RestRequest object on this REST call.
    
    Parameters:
    
    rreq - The RestRequest object on this REST call.
    
    Returns:
    
    This object (for method chaining).
  - restResponse
```
public RestCall restResponse(RestResponse rres)
```
    Set the RestResponse object on this REST call.
    
    Parameters:
    
    rres - The RestResponse object on this REST call.
    
    Returns:
    
    This object (for method chaining).
  - getRequest
```
public HttpServletRequest getRequest()
```
    Returns the HTTP servlet request of this REST call.
    
    Returns:
    
    the HTTP servlet request of this REST call.
  - getResponse
```
public HttpServletResponse getResponse()
```
    Returns the HTTP servlet response of this REST call.
    
    Returns:
    
    the HTTP servlet response of this REST call.
  - getRestRequest
```
public RestRequest getRestRequest()
```
    Returns the REST request of this REST call.
    
    Returns:
    
    the REST request of this REST call.
  - getRestResponse
```
public RestResponse getRestResponse()
```
    Returns the REST response of this REST call.
    
    Returns:
    
    the REST response of this REST call.
  - logger
```
public RestCall logger(RestCallLogger logger)
```
    Sets the logger to use when logging this call.
    
    Parameters:
    
    logger - The logger to use when logging this call.
    
    Returns:
    
    This object (for method chaining).
  - loggerConfig
```
public RestCall loggerConfig(RestCallLoggerConfig config)
```
    Sets the logging configuration to use when logging this call.
    
    Parameters:
    
    config - The logging configuration to use when logging this call.
    
    Returns:
    
    This object (for method chaining).
  - debug
```
public RestCall debug(boolean b)
               throws IOException
```
    Enables or disabled debug mode on this call.
    
    Parameters:
    
    b - The debug flag value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    IOException - Occurs if request body could not be cached into memory.
  - status
```
public RestCall status(int code)
```
    Sets the HTTP status on this call.
    
    Parameters:
    
    code - The status code.
    
    Returns:
    
    This object (for method chaining).
  - exception
```
public RestCall exception(Throwable e)
```
    Identifies that an exception occurred during this call.
    
    Parameters:
    
    e - The thrown exception.
    
    Returns:
    
    This object (for method chaining).
  - responseMeta
```
public RestCall responseMeta(ResponseBeanMeta meta)
```
    Sets metadata about the response.
    
    Parameters:
    
    meta - The metadata about the response.
    
    Returns:
    
    This object (for method chaining).
  - output
```
public RestCall output(Object output)
```
    Sets the output object to serialize as the response of this call.
    
    Parameters:
    
    output - The response output POJO.
    
    Returns:
    
    This object (for method chaining).
  - finish
```
public RestCall finish()
```
    Called at the end of a call to finish any remaining tasks such as flushing buffers and logging the response.
    
    Returns:
    
    This object (for method chaining).
  - getServletPath
```
public String getServletPath()
```
    Shortcut for calling getRequest().getServletPath().
    
    Returns:
    
    The request servlet path.
  - getUrlPathInfo
```
public UrlPathInfo getUrlPathInfo()
```
    Returns the request path info as a UrlPathInfo bean.
    
    Returns:
    
    The request path info as a UrlPathInfo bean.
  - getPathInfo
```
public String getPathInfo()
```
    Shortcut for calling getRequest().getPathInfo().
    
    Returns:
    
    The request servlet path info.
  - getPathInfoUndecoded
```
public String getPathInfoUndecoded()
```
    Same as getPathInfo() but doesn't decode encoded characters.
    
    Returns:
    
    The undecoded request servlet path info.
  - getMethod
```
public String getMethod()
```
    Returns the HTTP method name.
    
    Returns:
    
    The HTTP method name, always uppercased.
  - getStatus
```
public int getStatus()
```
    Shortcut for calling getRequest().getStatus().
    
    Returns:
    
    The response status code.
  - hasOutput
```
public boolean hasOutput()
```
    Shortcut for calling getRestResponse().hasOutput().
    
    Returns:
    
    true if response has output.
  - getOutput
```
public Object getOutput()
```
    Shortcut for calling getRestResponse().getOutput().
    
    Returns:
    
    The response output.

Class RestCall

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RestCall

Method Detail

request

response

restRequest

restResponse

getRequest

getResponse

getRestRequest

getRestResponse

logger

loggerConfig

debug

status

exception

responseMeta

output

finish

getServletPath

getUrlPathInfo

getPathInfo

getPathInfoUndecoded

getMethod

getStatus

hasOutput

getOutput