org.figure8.join.control.action
Class MailingListActions

java.lang.Object
  org.apache.struts.action.Action
      org.figure8.join.control.JoinAction
          org.figure8.join.control.action.MailingListActions

public class MailingListActions
extends JoinAction

This is a Struts action for managing Mailing lists and their subscriptions.

Version:

$Revision: 1.3 $

Author:

Laurent Broudoux

Field Summary

static java.lang.String	DUPLICATE_MAILING_LIST_KEY The request scope attribute under which is stored the MailingList that has raised a DuplicateEntityException during save of another one.
static java.lang.String	LOAD_OP Operation code for loading a specified MailingList
static java.lang.String	MAILING_LIST_KEY The session attribute key used for storing a specified MailingList for later update.
static java.lang.String	MAILING_LISTS_KEY The request scope attribute under which the retrieved mailing list list is stored.
static java.lang.String	REMOVE_OP Operation code for removing a MailingList (subscriptions are removed as well)
protected ReportingManager	reportingManager The Reporting manager implementation to use
static java.lang.String	SAVE_OP Operation code for saving (create or update) a MailingList
static java.lang.String	SUBSCRIBE_OP Operation code for user subscribing to a MailingList
static java.lang.String	SUBSCRIPTIONS_KEY The request scope attribute under which the retrieved subscriptions list is stored.
static java.lang.String	SUBSCRIPTIONS_OP Operation code for getting a user subscriptions to MailingLists

Fields inherited from class org.figure8.join.control.JoinAction

BODY_ATTRIBUTE, BODY_PARAMETER, EXCEPTION_KEY, GUI_KEY, OP_PARAMETER, REND_MAIN, REND_NONE, REND_PARAMETER, REND_POPUP, XHR_PARAMETER

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

defaultLocale, servlet

Constructor Summary

MailingListActions()
Creates a new instance of MailingListActions

Method Summary

org.apache.struts.action.ActionForward	doExecute(java.lang.String operation, org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Abstract method that subclasses must implement.
protected org.apache.struts.action.ActionForward	getSubscriptions(org.apache.struts.action.ActionMapping mapping, MailingListForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Retrieve subscription for a given list or for a given user.
protected org.apache.struts.action.ActionForward	loadMailingList(org.apache.struts.action.ActionMapping mapping, MailingListForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Load a specified mailing list into request attribute for update.
protected org.apache.struts.action.ActionForward	saveMailingList(org.apache.struts.action.ActionMapping mapping, MailingListForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Save a mailing list within datastore (this is a create or update method).
void	setReportingManager(ReportingManager manager)
protected org.apache.struts.action.ActionForward	subscribeMailingLists(org.apache.struts.action.ActionMapping mapping, MailingListForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Subscribe a user to a set of MailingLists.

Methods inherited from class org.figure8.join.control.JoinAction

execute, getUserContainer, isLoggedIn, isXhrRequest, removeObsoleteForm

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

addErrors, addMessages, execute, generateToken, getDataSource, getDataSource, 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

Field Detail

LOAD_OP

public static final java.lang.String LOAD_OP

Operation code for loading a specified MailingList

See Also:

Constant Field Values

SAVE_OP

public static final java.lang.String SAVE_OP

Operation code for saving (create or update) a MailingList

See Also:

Constant Field Values

REMOVE_OP

public static final java.lang.String REMOVE_OP

Operation code for removing a MailingList (subscriptions are removed as well)

See Also:

Constant Field Values

SUBSCRIBE_OP

public static final java.lang.String SUBSCRIBE_OP

Operation code for user subscribing to a MailingList

See Also:

Constant Field Values

SUBSCRIPTIONS_OP

public static final java.lang.String SUBSCRIPTIONS_OP

Operation code for getting a user subscriptions to MailingLists

See Also:

Constant Field Values

MAILING_LIST_KEY

public static final java.lang.String MAILING_LIST_KEY

The session attribute key used for storing a specified MailingList for later update.

See Also:

Constant Field Values

MAILING_LISTS_KEY

public static final java.lang.String MAILING_LISTS_KEY

The request scope attribute under which the retrieved mailing list list is stored.

See Also:

Constant Field Values

SUBSCRIPTIONS_KEY

public static final java.lang.String SUBSCRIPTIONS_KEY

The request scope attribute under which the retrieved subscriptions list is stored.

See Also:

Constant Field Values

DUPLICATE_MAILING_LIST_KEY

public static final java.lang.String DUPLICATE_MAILING_LIST_KEY

The request scope attribute under which is stored the MailingList that has raised a DuplicateEntityException during save of another one.

See Also:

Constant Field Values

reportingManager

protected ReportingManager reportingManager

The Reporting manager implementation to use

Constructor Detail

MailingListActions

public MailingListActions()

Creates a new instance of MailingListActions

Method Detail

setReportingManager

public void setReportingManager(ReportingManager manager)

Parameters:

manager - The ReportingManager implementation to use

doExecute

public org.apache.struts.action.ActionForward doExecute(java.lang.String operation,
                                                        org.apache.struts.action.ActionMapping mapping,
                                                        org.apache.struts.action.ActionForm form,
                                                        javax.servlet.http.HttpServletRequest request,
                                                        javax.servlet.http.HttpServletResponse response)
                                                 throws java.lang.Exception

Description copied from class: JoinAction

Abstract method that subclasses must implement. The real execution must be done here according to the specified operation. ActionForward returned by execution should only point on page fragment : this superclass is responsible of including them within a whole page.

Specified by:

doExecute in class JoinAction

Parameters:

operation - String representing the operation to invoke on Action

mapping - Mapping between forwards name and path for this action

form - The form object containing request parameters

request - The servlet container request wrapper

response - The servlet container response wrapper

Returns:

A forward to the next view to render and display

Throws:

java.lang.Exception - such as InfraStructureExceptions ...

loadMailingList

protected org.apache.struts.action.ActionForward loadMailingList(org.apache.struts.action.ActionMapping mapping,
                                                                 MailingListForm form,
                                                                 javax.servlet.http.HttpServletRequest request,
                                                                 javax.servlet.http.HttpServletResponse response)
                                                          throws java.lang.Exception

Load a specified mailing list into request attribute for update.

Returns:

A forward to the next view to render and display.

Throws:

java.lang.Exception

saveMailingList

protected org.apache.struts.action.ActionForward saveMailingList(org.apache.struts.action.ActionMapping mapping,
                                                                 MailingListForm form,
                                                                 javax.servlet.http.HttpServletRequest request,
                                                                 javax.servlet.http.HttpServletResponse response)
                                                          throws java.lang.Exception

Save a mailing list within datastore (this is a create or update method).

Returns:

A forward to the next view to render and display.

Throws:

java.lang.Exception

subscribeMailingLists

protected org.apache.struts.action.ActionForward subscribeMailingLists(org.apache.struts.action.ActionMapping mapping,
                                                                       MailingListForm form,
                                                                       javax.servlet.http.HttpServletRequest request,
                                                                       javax.servlet.http.HttpServletResponse response)
                                                                throws java.lang.Exception

Subscribe a user to a set of MailingLists.

Returns:

A forward to the next view to render and display.

Throws:

java.lang.Exception

getSubscriptions

protected org.apache.struts.action.ActionForward getSubscriptions(org.apache.struts.action.ActionMapping mapping,
                                                                  MailingListForm form,
                                                                  javax.servlet.http.HttpServletRequest request,
                                                                  javax.servlet.http.HttpServletResponse response)
                                                           throws java.lang.Exception

Retrieve subscription for a given list or for a given user.

Returns:

A forward to the next view to render and display.

Throws:

java.lang.Exception