com.agapsys.rcf

Class ActionServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.agapsys.rcf.ActionServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

Controller

public class ActionServlet
extends javax.servlet.http.HttpServlet

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ActionServlet()

Method Summary

Modifier and Type	Method and Description
protected void	afterAction(ActionRequest request, ActionResponse response) Called after an action processing.
protected void	beforeAction(ActionRequest request, ActionResponse response) Called before an action.
protected boolean	isInitialized() Returns a boolean indicating this servlet initialization status.
protected void	onClientError(ActionRequest request, ActionResponse response, ClientException error) Called upon a client error.
protected void	onInit() Called during servlet initialization.
protected boolean	onUncaughtError(ActionRequest request, ActionResponse response, RuntimeException uncaughtError) Called when an uncaught error happened while processing the request.
protected void	registerAction(HttpMethod method, String path, Action action) Register an action.
protected void	service(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionServlet

public ActionServlet()

Method Detail

isInitialized

protected boolean isInitialized()

Returns a boolean indicating this servlet initialization status.

Returns:

a boolean indicating this servlet initialization status.

onInit

protected void onInit()

Called during servlet initialization. This is the ideal place to register actions. This method will be called only once during servlet instance life-cycle.

registerAction

protected void registerAction(HttpMethod method,
                              String path,
                              Action action)

Register an action.

Parameters:

method - HTTP method.

path - path relative to this provider Servlet mapping.

action - action associated with given parameters.

onUncaughtError

protected boolean onUncaughtError(ActionRequest request,
                                  ActionResponse response,
                                  RuntimeException uncaughtError)
                           throws javax.servlet.ServletException,
                                  IOException

Called when an uncaught error happened while processing the request.

Parameters:

request - HTTP request.

response - HTTP response.

uncaughtError - uncaught error.

Returns:

a boolean indicating if given error shall be propagated. Default implementation just returns true. In order to suppress the error, implementation should return false.

Throws:

javax.servlet.ServletException - if the HTTP request cannot be handled.

IOException - if an input or output error occurs while the servlet is handling the HTTP request.

onClientError

protected void onClientError(ActionRequest request,
                             ActionResponse response,
                             ClientException error)
                      throws javax.servlet.ServletException,
                             IOException

Called upon a client error.

Parameters:

request - HTTP request.

response - HTTP response.

error - client error.

Throws:

javax.servlet.ServletException - if the HTTP request cannot be handled

IOException - if an input or output error occurs while the servlet is handling the HTTP request.

beforeAction

protected void beforeAction(ActionRequest request,
                            ActionResponse response)
                     throws javax.servlet.ServletException,
                            IOException

Called before an action. Default implementation does nothing.

Parameters:

request - HTTP request.

response - HTTP response.

Throws:

javax.servlet.ServletException - if the HTTP request cannot be handled.

IOException - if an input or output error occurs while the servlet is handling the HTTP request.

afterAction

protected void afterAction(ActionRequest request,
                           ActionResponse response)
                    throws javax.servlet.ServletException,
                           IOException

Called after an action processing. Default implementation does nothing.

Parameters:

request - HTTP request.

response - HTTP response.

Throws:

IOException - if an input or output error occurs while the servlet is handling the HTTP request.

javax.servlet.ServletException - if the HTTP request cannot be handled.

service

protected final void service(javax.servlet.http.HttpServletRequest req,
                             javax.servlet.http.HttpServletResponse resp)
                      throws javax.servlet.ServletException,
                             IOException

Overrides:

service in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException