Module com.aoindustries.web.struts

Package com.aoindustries.web.struts

Class AuthenticatedAction

java.lang.Object

org.apache.struts.action.Action

com.aoindustries.web.struts.PageAction

com.aoindustries.web.struts.AuthenticatedAction

Direct Known Subclasses:

AdministratorPasswordSetterAction, AdministratorPasswordSetterCompletedAction, IndexAction, MakePaymentAction, MakePaymentNewCardAction, PermissionAction

public abstract class AuthenticatedAction
extends PageAction

Ensures the user is logged in. Forwards to "login" if not logged in. Otherwise, it sets the request attribute Constants.AO_CONN and then calls execute(ActionMapping,ActionForm,HttpServletRequest,HttpServletResponse,Locale,Skin,AoservConnector). The default implementation of this new execute method simply returns the mapping of "success".

More simply put, without overriding the new execute method, this action returns either the mapping for "login" or "success".

Author:

AO Industries, Inc.

Field Summary

Fields inherited from class org.apache.struts.action.Action

servlet

Constructor Summary

Constructors

Constructor	Description
AuthenticatedAction()

Method Summary

Modifier and Type	Method	Description
final ActionForward	execute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response, Registry pageRegistry)	Once the page registry is set resolved, this version of the execute method is invoked.
ActionForward	execute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response, AoservConnector aoConn)	Once authentication has been handled, this version of the execute method is invoked.
static AoservConnector	getAoConn(HttpServletRequest request, HttpServletResponse response)	Gets the AoservConnector for the user or null if not logged in.
static AoservConnector	getAuthenticatedAoConn(HttpServletRequest request, HttpServletResponse response)	Gets the AoservConnector that represents the actual login id.

Methods inherited from class com.aoindustries.web.struts.PageAction

execute

Methods inherited from class org.apache.struts.action.Action

addErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

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

Constructor Details

AuthenticatedAction

public AuthenticatedAction()

Method Details

execute

public final ActionForward execute(ActionMapping mapping,
 ActionForm form,
 HttpServletRequest request,
 HttpServletResponse response,
 Registry pageRegistry)
                            throws Exception

Description copied from class: PageAction

Once the page registry is set resolved, this version of the execute method is invoked. By default, returns mapping for "success".

Overrides:

execute in class PageAction

Throws:

Exception

getAuthenticatedAoConn

public static AoservConnector getAuthenticatedAoConn(HttpServletRequest request,
 HttpServletResponse response)

Gets the AoservConnector that represents the actual login id. This will not change when the user performs a switch user (Constants.SU)..

getAoConn

public static AoservConnector getAoConn(HttpServletRequest request,
 HttpServletResponse response)

Gets the AoservConnector for the user or null if not logged in. This also handles the Constants.SU behavior that was stored in the session by SwitchUserRequestListener.

execute

public ActionForward execute(ActionMapping mapping,
 ActionForm form,
 HttpServletRequest request,
 HttpServletResponse response,
 AoservConnector aoConn)
                      throws Exception

Once authentication has been handled, this version of the execute method is invoked. The default implementation of this method simply returns the mapping of "success".

Throws:

Exception