org.apache.juneau.rest

Interface RestCallHandler

All Known Subinterfaces:

RestCallHandler.Null

All Known Implementing Classes:

BasicRestCallHandler

public interface RestCallHandler

Class that handles the basic lifecycle of an HTTP REST call.

• RestContext.REST_callHandler

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RestCallHandler.Null Represents no RestCallHandler.

Method Summary

Modifier and Type	Method and Description
Throwable	convertThrowable(Throwable t) Method for converting thrown exceptions into other types before they are handled.
RestCall	createCall(HttpServletRequest req, HttpServletResponse res) Wraps an incoming servlet request/response pair into a single RestCall object.
RestRequest	createRequest(RestCall call) Creates a RestRequest object based on the specified incoming HttpServletRequest object.
RestResponse	createResponse(RestCall call) Creates a RestResponse object based on the specified incoming HttpServletResponse object and the request returned by createRequest(RestCall).
Map<String,Object>	getSessionObjects(RestRequest req, RestResponse res) Returns the session objects for the specified request.
void	handleError(RestCall call, Throwable e) Method for handling response errors.
void	handleNotFound(RestCall call) Handle the case where a matching method was not found.
void	handleResponse(RestCall call) The main method for serializing POJOs passed in through the RestResponse.setOutput(Object) method or returned by the Java method.
void	service(HttpServletRequest r1, HttpServletResponse r2) The main service method.

Method Detail

service

void service(HttpServletRequest r1,
             HttpServletResponse r2)
      throws ServletException,
             IOException

The main service method.

Parameters:

r1 - The incoming HTTP servlet request object.

r2 - The incoming HTTP servlet response object.

Throws:

ServletException - Error occurred.

IOException - Thrown by underlying stream.

createCall

RestCall createCall(HttpServletRequest req,
                    HttpServletResponse res)

Wraps an incoming servlet request/response pair into a single RestCall object.

Parameters:

req - The rest request.

res - The rest response.

Returns:

The wrapped request/response pair.

createRequest

RestRequest createRequest(RestCall call)
                   throws ServletException

Creates a RestRequest object based on the specified incoming HttpServletRequest object.

Parameters:

call - The current REST call.

Returns:

The wrapped request object.

Throws:

ServletException - If any errors occur trying to interpret the request.

createResponse

RestResponse createResponse(RestCall call)
                     throws ServletException

Creates a RestResponse object based on the specified incoming HttpServletResponse object and the request returned by createRequest(RestCall).

Parameters:

call - The current REST call.

Returns:

The wrapped response object.

Throws:

ServletException - If any errors occur trying to interpret the request or response.

handleResponse

void handleResponse(RestCall call)
             throws Exception

The main method for serializing POJOs passed in through the RestResponse.setOutput(Object) method or returned by the Java method.

Parameters:

call - The current REST call.

Throws:

Exception - Can be thrown if error occurred while handling response.

handleNotFound

void handleNotFound(RestCall call)
             throws Exception

Handle the case where a matching method was not found.

Parameters:

call - The current REST call.

Throws:

Exception - Can be thrown if error occurred while handling response.

handleError

void handleError(RestCall call,
                 Throwable e)
          throws Exception

Method for handling response errors.

Parameters:

call - The current REST call.

e - The exception that occurred.

Throws:

Exception - Can be thrown if error occurred while handling response.

convertThrowable

Throwable convertThrowable(Throwable t)

Method for converting thrown exceptions into other types before they are handled.

Parameters:

t - The thrown object.

Returns:

The converted thrown object.

getSessionObjects

Map<String,Object> getSessionObjects(RestRequest req,
                                     RestResponse res)

Returns the session objects for the specified request.

Parameters:

req - The REST request.

res - The REST response.

Returns:

The session objects for that request.