gov.nih.nci.caarray.ui.core
Class BaseDispatchAction

java.lang.Object
  extended by org.apache.struts.action.Action
      extended by org.apache.struts.actions.DispatchAction
          extended by gov.nih.nci.caarray.ui.core.BaseDispatchAction
Direct Known Subclasses:
AddExperimentFactorAction, ArrayAddUpdateAction, ArrayCopyAction, ArrayDesignAddAction, ArrayDesignDetailAction, ArrayDesignFileProcessAction, ArrayDesignSearchAction, ArrayDesignUpdateAction, ArrayDetailAction, ArraySearchAction, BiomaterialCharacteristicsAction, BiosourceAddUpdateAction, BiosourceDetailAction, BiosourceSearchAction, ExperimentAddAdditionalHybPageAction, ExperimentAddHybPageAction, ExperimentBatchDownloadAction, ExperimentHybridizationAction, ExperimentHybridizationAnnotationAction, ExperimentHybridizationDetailDoneAction, HardwareAddUpdateAction, HardwareDetailAction, HardwareSearchAction, HybridizationFileProcessAction, HybridizationFileUploadAction, LabelAddUpdateAction, LabeledExtractDetailAction, LabeledExtractSearchAction, ModifyExperimentAdditionalQualifierAction, ModifyExperimentContactAction, ModifyExperimentDetailAction, ModifyExperimentFactorAction, ModifyExperimentGeneralInfoAction, ModifyExperimentPublicationAction, ModifyExperimentQualityAction, ModifyProtocolApplicationAction, ModifyTreatmentAction, OntologyAddUpdateAction, OntologyDetailAction, OntologySearchAction, OrganizationAddUpdateAction, OrganizationDetailAction, OrganizationSearchAction, ParameterAddAction, PeopleSearchAction, PerformExperimentAdditionalUploadFileAction, PerformExperimentAddPublicationAction, PerformExperimentDataProcessingAction, PerformExperimentImportMageMLAction, PerformExperimentNewAdditionalQualifierAction, PerformExperimentNewPageContinueAction, PerformExperimentUploadHybridizationAction, PersonAddUpdateAction, PersonDetailAction, PoolAction, ProtocolActionMappingsAction, ProtocolAddUpdateAction, ProtocolApplicationAction, ProtocolDetailAction, ProtocolSearchAction, SampleDetailAction, SampleSearchAction, SampleUpdateAction, SoftwareAddUpdateAction, SoftwareDetailAction, SoftwareSearchAction, SplitAction, TreatmentActionOne, TreatmentActionThree, TreatmentActionTwo, UserManagementAction

public abstract class BaseDispatchAction
extends org.apache.struts.actions.DispatchAction

This DispatchAction class is intended for use just like Struts's DispatchAction with the additional of cache and general exception handling.

Here's the usage for DispatchAction from Struts:

An abstract Action that dispatches to a public method that is named by the request parameter whose name is specified by the parameter property of the corresponding ActionMapping. This Action is useful for developers who prefer to combine many similar actions into a single Action class, in order to simplify their application design.

To configure the use of this action in your struts-config.xml file, create an entry like this:

which will use the value of the request parameter named "method" to pick the appropriate "execute" method, which must have the same signature (other than method name) of the standard Action.execute method. For example, you might have the following three methods in the same action:

public ActionForward delete(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception

public ActionForward insert(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception

public ActionForward update(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception

and call one of the methods with a URL like this:

http://localhost:8080/myapp/saveSubscription.do?method=update

Author:
TranP

Field Summary
 
Fields inherited from class org.apache.struts.actions.DispatchAction
clazz, log, messages, methods, types
 
Fields inherited from class org.apache.struts.action.Action
ACTION_SERVLET_KEY, APPLICATION_KEY, DATA_SOURCE_KEY, defaultLocale, ERROR_KEY, EXCEPTION_KEY, FORM_BEANS_KEY, FORWARDS_KEY, LOCALE_KEY, MAPPING_KEY, MAPPINGS_KEY, MESSAGE_KEY, MESSAGES_KEY, MULTIPART_KEY, PLUG_INS_KEY, REQUEST_PROCESSOR_KEY, servlet, SERVLET_KEY, TRANSACTION_TOKEN_KEY
 
Constructor Summary
BaseDispatchAction()
           
 
Method Summary
 org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
abstract  boolean loginRequired()
           
 
Methods inherited from class org.apache.struts.actions.DispatchAction
dispatchMethod, getMethod, unspecified
 
Methods inherited from class org.apache.struts.action.Action
execute, generateToken, getDataSource, getDataSource, getLocale, getResources, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, perform, perform, resetToken, saveErrors, saveMessages, saveToken, setLocale, setServlet, toHex
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BaseDispatchAction

public BaseDispatchAction()
Method Detail

execute

public org.apache.struts.action.ActionForward execute(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
Overrides:
execute in class org.apache.struts.actions.DispatchAction
Throws:
java.lang.Exception

loginRequired

public abstract boolean loginRequired()