org.figure8.join.control.action
Class LogicalEnvironmentActions

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

public class LogicalEnvironmentActions
extends JoinAction

This is a Struts for managing all operations related to LogicalEnvironment entities.

Version:

$Revision: 1.1 $

Author:

Laurent Broudoux

Field Summary

static java.lang.String	DUPLICATE_ENVIRONMENT_KEY The request scope attribute under which is stored the LogicalEnvironment that has raised a DuplicateEntityException during save of another one.
static java.lang.String	ENVIRONMENT_KEY The session scope attribute under which the LogicalEnvironment object currently selected by our logged-in User is stored.
static java.lang.String	ENVIRONMENTS_KEY The request scope attribute under which the retrieved LogicalEnvironments list is stored.
static java.lang.String	LOAD_OP Operation code for loading a specific LogicalEnvironment
static java.lang.String	SAVE_OP Operation code for saving a LogicalEnvironment (create or update)
static java.lang.String	VIEW_OP Operation code for accessing LogicalEnvironment view objects

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

LogicalEnvironmentActions()
Creates a new LogicalEnvironmentActions.

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.
java.util.List	getEnvironmentViews() This is an helpful method for allt the web-tier components to retrieve loaded environment views.
protected org.apache.struts.action.ActionForward	loadEnvironment(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 logical environment from datastore and fill form with it.
protected org.apache.struts.action.ActionForward	loadEnvironmentViews(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Load the logical environment views from datastore.
protected org.apache.struts.action.ActionForward	saveEnvironment(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Save a logical environment into datastore.
void	setEnvironmentManager(EnvironmentManager envManager)
void	setIntegrationProcessManager(IntegrationProcessManager 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

LOAD_OP

public static final java.lang.String LOAD_OP

Operation code for loading a specific LogicalEnvironment

See Also:

Constant Field Values

SAVE_OP

public static final java.lang.String SAVE_OP

Operation code for saving a LogicalEnvironment (create or update)

See Also:

Constant Field Values

VIEW_OP

public static final java.lang.String VIEW_OP

Operation code for accessing LogicalEnvironment view objects

See Also:

Constant Field Values

ENVIRONMENT_KEY

public static final java.lang.String ENVIRONMENT_KEY

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

See Also:

Constant Field Values

ENVIRONMENTS_KEY

public static final java.lang.String ENVIRONMENTS_KEY

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

See Also:

Constant Field Values

DUPLICATE_ENVIRONMENT_KEY

public static final java.lang.String DUPLICATE_ENVIRONMENT_KEY

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

See Also:

Constant Field Values

Constructor Detail

LogicalEnvironmentActions

public LogicalEnvironmentActions()

Creates a new LogicalEnvironmentActions.

Method Detail

setEnvironmentManager

public void setEnvironmentManager(EnvironmentManager envManager)

Parameters:

envManager - The EnvironmentManager implementation instance to use

setIntegrationProcessManager

public void setIntegrationProcessManager(IntegrationProcessManager manager)

Parameters:

manager - The IntegrationProcessManager implementation instance to use

getEnvironmentViews

public java.util.List getEnvironmentViews()

This is an helpful method for allt the web-tier components to retrieve loaded environment views. This method actually loads them if not already done.

Returns:

A Collection of available org.figure8.join.view.EnvironmentViews

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

loadEnvironment

protected org.apache.struts.action.ActionForward loadEnvironment(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 logical environment from datastore and fill form with it.

Returns:

A forward to the next view to render and display

Throws:

java.lang.Exception

saveEnvironment

protected org.apache.struts.action.ActionForward saveEnvironment(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 logical environment into datastore. The environment 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

loadEnvironmentViews

protected org.apache.struts.action.ActionForward loadEnvironmentViews(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 the logical environment views from datastore.

Returns:

A forward to the next view to render and display

Throws:

java.lang.Exception