com.agapsys.rcf

Class Controller

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.agapsys.rcf.ActionServlet

com.agapsys.rcf.Controller

All Implemented Interfaces:

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

public class Controller
extends ActionServlet

Servlet responsible by mapping methods to actions

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Controller.Dto<T> Defines a Data Transfer Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	CSRF_HEADER Name of the header used to send/retrieve a CSRF token.
static String	METHOD_NAME_MAPPING
static String	SESSION_ATTR_CSRF_TOKEN Name of the default session attribute used to store CSRF token.
static String	SESSION_ATTR_USER Name of the session attribute used to store current user.

Constructor Summary

Constructors

Constructor and Description
Controller()

Method Summary

Modifier and Type	Method and Description
protected User	getUser(ActionRequest request) This method instructs the controller how to retrieve the user associated with given HTTP exchange.
protected boolean	onControllerError(ActionRequest request, ActionResponse response, Throwable uncaughtError) Called upon controller uncaught error.
protected void	onControllerInit() Called during controller initialization.
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	sendObject(ActionRequest request, ActionResponse response, Object obj) This method instructs the controller how to send an object to the client.
protected void	setUser(ActionRequest request, ActionResponse response, User user) This method instructs the controller how to associate an user with a HTTP exchange.

Methods inherited from class com.agapsys.rcf.ActionServlet

afterAction, beforeAction, isInitialized, onClientError, registerAction, service

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

Field Detail

METHOD_NAME_MAPPING

public static final String METHOD_NAME_MAPPING

See Also:

Constant Field Values

SESSION_ATTR_USER

public static final String SESSION_ATTR_USER

Name of the session attribute used to store current user.

SESSION_ATTR_CSRF_TOKEN

public static final String SESSION_ATTR_CSRF_TOKEN

Name of the default session attribute used to store CSRF token.

CSRF_HEADER

public static final String CSRF_HEADER

Name of the header used to send/retrieve a CSRF token.

See Also:

Constant Field Values

Constructor Detail

Controller

public Controller()

Method Detail

onInit

protected final void onInit()

Description copied from class: ActionServlet

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

Overrides:

onInit in class ActionServlet

onControllerInit

protected void onControllerInit()

Called during controller initialization. Default implementation does nothing.

onControllerError

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

Called upon controller uncaught error.

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.

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.

getUser

protected User getUser(ActionRequest request)
                throws javax.servlet.ServletException,
                       IOException

This method instructs the controller how to retrieve the user associated with given HTTP exchange.

Parameters:

request - HTTP request.

Returns:

an user associated with given request. Default uses servlet request session to retrive the user. If a user cannot be retrieved from given request, returns null. Default implementation also verify CSRF attacks.

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.

setUser

protected void setUser(ActionRequest request,
                       ActionResponse response,
                       User user)
                throws javax.servlet.ServletException,
                       IOException

This method instructs the controller how to associate an user with a HTTP exchange. Default implementation uses servlet request session associated with given request.

Parameters:

request - HTTP request.

response - HTTP response.

user - user to be registered with given HTTP exchange. Passing null unregisters the user. Passing non-null user instance will generate a CSRF token header which will be sent in associated 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.

sendObject

protected void sendObject(ActionRequest request,
                          ActionResponse response,
                          Object obj)
                   throws javax.servlet.ServletException,
                          IOException

This method instructs the controller how to send an object to the client. Default implementation serializes the DTO into a JSON response.

Parameters:

request - HTTP request.

response - HTTP response.

obj - object to be sent to the client.

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.

onUncaughtError

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

Description copied from class: ActionServlet

Called when an uncaught error happened while processing the request.

Overrides:

onUncaughtError in class ActionServlet

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.