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.

See Also:

• 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
RestRequest	createRequest(javax.servlet.http.HttpServletRequest req) Creates a RestRequest object based on the specified incoming HttpServletRequest object.
RestResponse	createResponse(RestRequest req, javax.servlet.http.HttpServletResponse res) Creates a RestResponse object based on the specified incoming HttpServletResponse object and the request returned by createRequest(HttpServletRequest).
Map<String,Object>	getSessionObjects(RestRequest req) Returns the session objects for the specified request.
void	handleError(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, RestException e) Method for handling response errors.
void	handleNotFound(int rc, RestRequest req, RestResponse res) Handle the case where a matching method was not found.
void	handleResponse(RestRequest req, RestResponse res, Object output) The main method for serializing POJOs passed in through the RestResponse.setOutput(Object) method or returned by the Java method.
void	renderError(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, RestException e) Method for rendering response errors.
void	service(javax.servlet.http.HttpServletRequest r1, javax.servlet.http.HttpServletResponse r2) The main service method.

Method Detail

createRequest

RestRequest createRequest(javax.servlet.http.HttpServletRequest req)
                   throws javax.servlet.ServletException

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

Parameters:

req - The request object from the service(HttpServletRequest, HttpServletResponse) method.

Returns:

The wrapped request object.

Throws:

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

createResponse

RestResponse createResponse(RestRequest req,
                            javax.servlet.http.HttpServletResponse res)
                     throws javax.servlet.ServletException

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

Parameters:

req - The request object returned by createRequest(HttpServletRequest).

res - The response object from the service(HttpServletRequest, HttpServletResponse) method.

Returns:

The wrapped response object.

Throws:

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

service

void service(javax.servlet.http.HttpServletRequest r1,
             javax.servlet.http.HttpServletResponse r2)
      throws javax.servlet.ServletException,
             IOException

The main service method.

Parameters:

r1 - The incoming HTTP servlet request object.

r2 - The incoming HTTP servlet response object.

Throws:

javax.servlet.ServletException

IOException

handleResponse

void handleResponse(RestRequest req,
                    RestResponse res,
                    Object output)
             throws IOException,
                    RestException

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

Parameters:

req - The HTTP request.

res - The HTTP response.

output - The output to serialize in the response.

Throws:

IOException

RestException

handleNotFound

void handleNotFound(int rc,
                    RestRequest req,
                    RestResponse res)
             throws Exception

Handle the case where a matching method was not found.

Parameters:

rc - The HTTP response code.

req - The HTTP request.

res - The HTTP response.

Throws:

Exception

handleError

void handleError(javax.servlet.http.HttpServletRequest req,
                 javax.servlet.http.HttpServletResponse res,
                 RestException e)
          throws IOException

Method for handling response errors.

Parameters:

req - The servlet request.

res - The servlet response.

e - The exception that occurred.

Throws:

IOException - Can be thrown if a problem occurred trying to write to the output stream.

renderError

void renderError(javax.servlet.http.HttpServletRequest req,
                 javax.servlet.http.HttpServletResponse res,
                 RestException e)
          throws IOException

Method for rendering response errors.

Parameters:

req - The servlet request.

res - The servlet response.

e - The exception that occurred.

Throws:

IOException - Can be thrown if a problem occurred trying to write to the output stream.

getSessionObjects

Map<String,Object> getSessionObjects(RestRequest req)

Returns the session objects for the specified request.

Parameters:

req - The REST request.

Returns:

The session objects for that request.