org.figure8.join.control.action
Class QuartzCronActions

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

public class QuartzCronActions
extends JoinAction

Struts action used for managing crons within Join application.

Version:

$Revision: 1.6 $

Author:

Jerome Evrard, Laurent Broudoux

Field Summary

static java.lang.String	CRON_HELP_OP Operation code for getting help about cron expression syntax
static java.lang.String	DETAILS_OP Operation code for retrieving the details and script log infos of a Quartz cron
static java.lang.String	DUPLICATE_QUARTZ_CRON_KEY The request scope attribute under which is stored the cron that has raised a DuplicateEntityException during save of another one.
static java.lang.String	LOAD_OP SAVE_OP: Action name to load a cron
static java.lang.String	QUARTZ_CRON_KEY The session scope attribute under which the cron object currently selected by our logged-in User is stored.
static java.lang.String	QUARTZ_CRONS_KEY The session scope attribute under which the retrieved crons list is stored.
static java.lang.String	SAVE_OP SAVE_OP: Action name to save a new cron
static java.lang.String	SAVE_PARAM_OP Operation code for saving the configurable parameters of Quartz job

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

QuartzCronActions()
Creates a new instance of QuartzCronActions.

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	getQuartzCronDetails(org.apache.struts.action.ActionMapping mapping, QuartzCronForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Get all the details of a registered quartz cron from datastore.
protected void	initializeManagerOrService() Initialize the local consumer manager or the remote service depending on the application setup and the application side we are on.
protected org.apache.struts.action.ActionForward	loadQuartzCron(org.apache.struts.action.ActionMapping mapping, QuartzCronForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Load a specified cron info from datastore and fill form with it.
protected org.apache.struts.action.ActionForward	saveQuartzCron(org.apache.struts.action.ActionMapping mapping, QuartzCronForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Load a specified cron info from datastore and fill form with it.
protected org.apache.struts.action.ActionForward	saveQuartzCronParameters(org.apache.struts.action.ActionMapping mapping, QuartzCronForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Save a cron parameters into datastore.
void	setQuartzCronManager(QuartzCronManager quartzCronManager)
protected void	updateQuartzCronsInRequest(javax.servlet.http.HttpServletRequest request) Update the crons definitions collection within request.

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

SAVE_OP: Action name to load a cron

See Also:

Constant Field Values

SAVE_OP

public static final java.lang.String SAVE_OP

SAVE_OP: Action name to save a new cron

See Also:

Constant Field Values

SAVE_PARAM_OP

public static final java.lang.String SAVE_PARAM_OP

Operation code for saving the configurable parameters of Quartz job

See Also:

Constant Field Values

DETAILS_OP

public static final java.lang.String DETAILS_OP

Operation code for retrieving the details and script log infos of a Quartz cron

See Also:

Constant Field Values

CRON_HELP_OP

public static final java.lang.String CRON_HELP_OP

Operation code for getting help about cron expression syntax

See Also:

Constant Field Values

QUARTZ_CRON_KEY

public static final java.lang.String QUARTZ_CRON_KEY

The session scope attribute under which the cron object currently selected by our logged-in User is stored.

See Also:

Constant Field Values

QUARTZ_CRONS_KEY

public static final java.lang.String QUARTZ_CRONS_KEY

The session scope attribute under which the retrieved crons list is stored.

See Also:

Constant Field Values

DUPLICATE_QUARTZ_CRON_KEY

public static final java.lang.String DUPLICATE_QUARTZ_CRON_KEY

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

See Also:

Constant Field Values

Constructor Detail

QuartzCronActions

public QuartzCronActions()

Creates a new instance of QuartzCronActions.

Method Detail

setQuartzCronManager

public void setQuartzCronManager(QuartzCronManager quartzCronManager)

Parameters:

quartzCronManager - The cronManager to set.

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 ...

loadQuartzCron

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

Load a specified cron info from datastore and fill form with it.

Returns:

A forward to the next view to render and display

Throws:

java.lang.Exception

saveQuartzCron

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

Load a specified cron info from datastore and fill form with it.

Returns:

A forward to the next view to render and display

Throws:

java.lang.Exception

saveQuartzCronParameters

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

Save a cron parameters into datastore. The cron is an already existing one.

Returns:

A forward to the next view to render and display

Throws:

java.lang.Exception

getQuartzCronDetails

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

Get all the details of a registered quartz cron from datastore. This includes getting its execution logs infos.

Returns:

A forward to the next view to render and display

Throws:

java.lang.Exception

updateQuartzCronsInRequest

protected void updateQuartzCronsInRequest(javax.servlet.http.HttpServletRequest request)
                                   throws java.lang.Exception

Update the crons definitions collection within request.

Parameters:

request - The servlet container request wrapper

Throws:

java.lang.Exception - if consumers cannot be refreshed

initializeManagerOrService

protected void initializeManagerOrService()
                                   throws java.lang.Exception

Initialize the local consumer manager or the remote service depending on the application setup and the application side we are on.

Throws:

java.lang.Exception - if manager cannot be found or remote service is not available