org.figure8.join.control.action
Class MachineActions

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

public class MachineActions
extends JoinAction

Struts action used for managing the physical machines used by software project integration team.

Version:

$Revision: 1.1 $

Author:

Laurent Broudoux

Field Summary

static java.lang.String	DETAILS_OP Operation code for getting details on a Machine
static java.lang.String	DUPLICATE_MACHINE_KEY The request scope attribute under which is stored the Machine that has raised a DuplicateEntityException during save of another one.
static java.lang.String	LOAD_OP Operation code for loading a specific Machine
protected static org.apache.commons.logging.Log	log Get a commons logger.
static java.lang.String	MACHINE_KEY The session scope attribute under which the Machine object currently selected by our logged-in User is stored.
static java.lang.String	MACHINES_KEY The request scope attribute under which the retrieved Machines list is stored.
static java.lang.String	SAVE_OP Operation code for saving a Machine (create or update)

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

MachineActions()
Creates a new instance of MachineActions.

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	getMachineDetails(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Retrieve the details onto a specified machine.
protected org.apache.struts.action.ActionForward	loadMachine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Load a specified machine from datastore and fill form with it.
protected org.apache.struts.action.ActionForward	saveMachine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Save a machine into datastore.
void	setResourceManager(ResourceManager manager)

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

log

protected static org.apache.commons.logging.Log log

Get a commons logger.

LOAD_OP

public static final java.lang.String LOAD_OP

Operation code for loading a specific Machine

See Also:

Constant Field Values

SAVE_OP

public static final java.lang.String SAVE_OP

Operation code for saving a Machine (create or update)

See Also:

Constant Field Values

DETAILS_OP

public static final java.lang.String DETAILS_OP

Operation code for getting details on a Machine

See Also:

Constant Field Values

MACHINE_KEY

public static final java.lang.String MACHINE_KEY

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

See Also:

Constant Field Values

MACHINES_KEY

public static final java.lang.String MACHINES_KEY

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

See Also:

Constant Field Values

DUPLICATE_MACHINE_KEY

public static final java.lang.String DUPLICATE_MACHINE_KEY

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

See Also:

Constant Field Values

Constructor Detail

MachineActions

public MachineActions()

Creates a new instance of MachineActions.

Method Detail

setResourceManager

public void setResourceManager(ResourceManager manager)

Parameters:

manager - The ResourceManager 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 ...

loadMachine

protected org.apache.struts.action.ActionForward loadMachine(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

Load a specified machine from datastore and fill form with it.

Returns:

A forward to the next view to render and display

Throws:

java.lang.Exception

saveMachine

protected org.apache.struts.action.ActionForward saveMachine(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

Save a machine into datastore. The Machine may be an already existing one or a new one (this is indeed a create or update method).

Returns:

A forward to the next view to render and display

Throws:

java.lang.Exception

getMachineDetails

protected org.apache.struts.action.ActionForward getMachineDetails(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

Retrieve the details onto a specified machine.

Returns:

A forward to the next view to render and display

Throws:

java.lang.Exception