org.apache.juneau.rest

Class BasicRestCallHandler

java.lang.Object

org.apache.juneau.rest.BasicRestCallHandler

All Implemented Interfaces:

RestCallHandler

public class BasicRestCallHandler
extends Object
implements RestCallHandler

Default implementation of RestCallHandler.

Subclasses can override these methods to tailor how HTTP REST calls are handled.
Subclasses MUST implement a public constructor that takes in a RestContext object.

See Also:

• RestContext.REST_callHandler

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.juneau.rest.RestCallHandler

RestCallHandler.Null

Constructor Summary

Constructors

Constructor and Description
BasicRestCallHandler(RestContext context) Constructor.

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicRestCallHandler

public BasicRestCallHandler(RestContext context)

Constructor.

Parameters:

context - The resource context.

Method Detail

createRequest

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

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

Subclasses may choose to override this method to provide a specialized request object.

Specified by:

createRequest in interface RestCallHandler

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

public 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).

Subclasses may choose to override this method to provide a specialized response object.

Specified by:

createResponse in interface RestCallHandler

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

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

The main service method.

Subclasses can optionally override this method if they want to tailor the behavior of requests.

Specified by:

service in interface RestCallHandler

Parameters:

r1 - The incoming HTTP servlet request object.

r2 - The incoming HTTP servlet response object.

Throws:

javax.servlet.ServletException

IOException

handleResponse

public 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.

Subclasses may override this method if they wish to modify the way the output is rendered or support other output formats.

The default implementation simply iterates through the response handlers on this resource looking for the first one whose ResponseHandler.handle(RestRequest, RestResponse, Object) method returns true.

Specified by:

handleResponse in interface RestCallHandler

Parameters:

req - The HTTP request.

res - The HTTP response.

output - The output to serialize in the response.

Throws:

IOException

RestException

handleNotFound

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

Handle the case where a matching method was not found.

Subclasses can override this method to provide a 2nd-chance for specifying a response. The default implementation will simply throw an exception with an appropriate message.

Specified by:

handleNotFound in interface RestCallHandler

Parameters:

rc - The HTTP response code.

req - The HTTP request.

res - The HTTP response.

Throws:

Exception

handleError

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

Method for handling response errors.

The default implementation logs the error and calls renderError(HttpServletRequest,HttpServletResponse,RestException).

Subclasses can override this method to provide their own custom error response handling.

Specified by:

handleError in interface RestCallHandler

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

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

Method for rendering response errors.

The default implementation renders a plain text English message, optionally with a stack trace if @RestResource.renderResponseStackTraces() is enabled.

Subclasses can override this method to provide their own custom error response handling.

Specified by:

renderError in interface RestCallHandler

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

public Map<String,Object> getSessionObjects(RestRequest req)

Returns the session objects for the specified request.

The default implementation simply returns a single map containing {'req':req}.

Specified by:

getSessionObjects in interface RestCallHandler

Parameters:

req - The REST request.

Returns:

The session objects for that request.