com.agapsys.rcf

Class ActionServlet<HE extends HttpExchange>

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.agapsys.rcf.ActionServlet<HE>

All Implemented Interfaces:

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

Direct Known Subclasses:

Controller

public class ActionServlet<HE extends HttpExchange>
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(HE exchange) Called after an action.
protected void	beforeAction(HE exchange) Called before an action.
protected HE	getHttpExchange(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Returns the HTTP exchange used by this servlet.
protected void	onClientError(HE exchange, ClientException error) Called upon a error thrown due to client request.
protected void	onInit() Called during servlet initialization.
protected void	onNotFound(HE exchange) Called upon endpoint not found.
protected boolean	onUncaughtError(HE exchange, Throwable throwable) Called when an uncaught error happens while processing an action.
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

onInit

protected void onInit()

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

onNotFound

protected void onNotFound(HE exchange)
                   throws javax.servlet.ServletException,
                          IOException

Called upon endpoint not found.

Parameters:

exchange - HTTP exchange. Default implementation sends a HttpServletResponse.SC_NOT_FOUND status.

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.

onUncaughtError

protected boolean onUncaughtError(HE exchange,
                                  Throwable throwable)
                           throws javax.servlet.ServletException,
                                  IOException

Called when an uncaught error happens while processing an action. Default implementation does nothing.

Parameters:

exchange - HTTP exchange.

throwable - error.

Returns:

a boolean indicating if given error was handled. Default implementation returns false.

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.

onClientError

protected void onClientError(HE exchange,
                             ClientException error)
                      throws javax.servlet.ServletException,
                             IOException

Called upon a error thrown due to client request.

Parameters:

exchange - HTTP exchange. Default implementation sends a 4XX status according to given exception.

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

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.

beforeAction

protected void beforeAction(HE exchange)
                     throws javax.servlet.ServletException,
                            IOException

Called before an action. This method will be called only if an action associated to given request is found and it it allowed to be processed (see SecurityManager). Default implementation does nothing.

Parameters:

exchange - HTTP exchange.

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.

afterAction

protected void afterAction(HE exchange)
                    throws javax.servlet.ServletException,
                           IOException

Called after an action. This method will be called only if an action associated to given request is found, the action is allowed to be processed (see SecurityManager), and the action was successfully processed. Default implementation does nothing.

Parameters:

exchange - HTTP exchange.

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.

getHttpExchange

protected HE getHttpExchange(javax.servlet.http.HttpServletRequest req,
                             javax.servlet.http.HttpServletResponse resp)

Returns the HTTP exchange used by this servlet.

Parameters:

req - HTTP request.

resp - HTTP response.

Returns:

HTTP exchange.

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