Uses of Interface
org.apache.struts.chain.contexts.ActionContext
Packages that use ActionContext
Package
Description
Contains the new
ComposableRequestProcessor
which was introduced in Struts 1.3.Configurable commands that may be placed within the
request processor.
Contains generic commands.
Commands which are particular to servlet processing.
This package provides objects that encapsulate access to
the request and session-scoped resources to service
command processing.
The "config" package contains configuration objects that correspond to
elements that may be specified in the
struts-config.xml
module configuration file.-
Uses of ActionContext in org.apache.struts.chain
Fields in org.apache.struts.chain with type parameters of type ActionContextModifier and TypeFieldDescriptionprotected Catalog<ActionContext> ComposableRequestProcessor.catalogTheCatalogcontaining all of the available command chains for this module.protected CatalogFactory<ActionContext> ComposableRequestProcessor.catalogFactoryTheCatalogFactoryfrom which catalog containing the the base request-processingCommandwill be retrieved.protected Command<ActionContext> ComposableRequestProcessor.commandTheCommandto be executed for each request.Methods in org.apache.struts.chain that return ActionContextModifier and TypeMethodDescriptionprotected ActionContextComposableRequestProcessor.contextInstance(HttpServletRequest request, HttpServletResponse response) Provide the initializedActionContextinstance which will be used by this request.protected ActionContextComposableRequestProcessor.createActionContextInstance(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response) Create a new instance ofActionContextaccording to configuration.Methods in org.apache.struts.chain with parameters of type ActionContextModifier and TypeMethodDescriptionprotected voidComposableRequestProcessor.initializeActionContext(ActionContext context) Set common properties on the givenActionContextinstance so that commands in the chain can count on their presence.Method parameters in org.apache.struts.chain with type arguments of type ActionContextModifier and TypeMethodDescriptionvoidComposableRequestProcessor.setCatalogFactory(CatalogFactory<ActionContext> catalogFactory) Set theCatalogFactoryinstance which should be used to find the request-processing command. -
Uses of ActionContext in org.apache.struts.chain.commands
Methods in org.apache.struts.chain.commands that return types with arguments of type ActionContextModifier and TypeMethodDescriptionprotected Command<ActionContext> ExecuteCommand.getCommand(String commandName, String catalogName) Retrieve the specified Command from the specified Catalog.protected Command<ActionContext> ExecuteCommand.getCommand(ActionContext context) Find theActionConfigin the current context and, if it is properly configured, lookup the appropriatecommons-chaincommand.protected Command<ActionContext> ExecuteForwardCommand.getCommand(ActionContext context) Return the command specified by thecommandandcatalogproperties of theforwardConfigproperty of the givenActionContext.protected Command<ActionContext> ExceptionCatcher.lookupExceptionCommand()Return the command to be executed if an exception occurs.Methods in org.apache.struts.chain.commands with parameters of type ActionContextModifier and TypeMethodDescriptionprotected DispatcherExecuteDispatcher.createDispatcher(String type, ActionContext context) Creates the dispatcher of the specified type.protected abstract ForwardConfigAbstractExecuteAction.execute(ActionContext context, Action action, ActionConfig actionConfig, ActionForm actionForm) Execute the specifiedAction, and return the resultingForwardConfig.booleanActionCommand.execute(ActionContext actionContext) final booleanActionCommandBase.execute(ActionContext actionContext) Logs and executes the command.protected booleanAbstractAuthorizeAction.execute_(ActionContext actionCtx) Determine whether the requested action is authorized for the current user.protected booleanAbstractCreateAction.execute_(ActionContext actionCtx) Create (if necessary) and cache anActionfor this request.protected booleanAbstractExceptionHandler.execute_(ActionContext actionCtx) Invoke the appropriateActionfor this request, and cache the returnedActionForward.protected booleanAbstractExecuteAction.execute_(ActionContext actionCtx) Invoke the appropriateActionfor this request if a dispatcher is not available, and cache the returnedActionForward.protected booleanAbstractPerformForward.execute_(ActionContext actionCtx) Perform forwarding or redirection based on the specifiedActionForward(if any).protected booleanAbstractPerformInclude.execute_(ActionContext actionCtx) Perform an include based on the specified include uri (if any).protected booleanAbstractPopulateActionForm.execute_(ActionContext actionCtx) Populate the form bean (if any) for this request.protected booleanAbstractRequestNoCache.execute_(ActionContext actionCtx) Check to see if the controller is configured to prevent caching, and if so, request no cache flags to be set.protected booleanAbstractSelectAction.execute_(ActionContext actionCtx) Cache theActionConfiginstance for the action to be used for processing this request.protected booleanAbstractSelectForward.execute_(ActionContext actionCtx) Select and cache theActionForwardfor thisActionConfigif specified.protected booleanAbstractSelectInput.execute_(ActionContext actionCtx) Select and cache aForwardConfigfor the input page for the current request.protected booleanAbstractSelectLocale.execute_(ActionContext actionCtx) Select theLocaleto be used for this request.protected booleanAbstractSelectModule.execute_(ActionContext actionCtx) Cache theModuleConfigandMessageResourcesinstances for the sub-application module to be used for processing this request.protected booleanAbstractSetContentType.execute_(ActionContext actionCtx) Check to see if the content type is set, and if so, set it for this response.protected booleanAbstractSetOriginalURI.execute_(ActionContext actionCtx) Check to original uri is set, and if not, set it for this request.protected booleanAbstractValidateActionForm.execute_(ActionContext actionCtx) Validate the properties of the form bean for this request.protected abstract booleanActionCommandBase.execute_(ActionContext actionContext) Executes the command.protected booleanCacheMessages.execute_(ActionContext actionCtx) protected booleanCreateActionForm.execute_(ActionContext actionCtx) Create (if necessary) and cache a form bean for this request.protected booleanExceptionCatcher.execute_(ActionContext actionCtx) Clear any existing stored exception and pass thecontexton to the remainder of the current chain.protected booleanExecuteCommand.execute_(ActionContext actionCtx) If thecontextis "valid", lookup a command and execute it.protected booleanExecuteDispatcher.execute_(ActionContext context) protected booleanRemoveCachedMessages.execute_(ActionContext actionCtx) Removes anyActionMessagesobject stored in the session underGlobals.MESSAGE_KEYandGlobals.ERROR_KEYif the messages'isAccessedmethod returns true.protected booleanSelectInclude.execute_(ActionContext actionCtx) Select and cache the include uri for thisActionConfigif specified.protected abstract ForwardConfigAbstractSelectForward.forward(ActionContext context, ModuleConfig moduleConfig, String uri) Create and return aForwardConfigrepresenting the specified module-relative destination.protected abstract ForwardConfigAbstractSelectInput.forward(ActionContext context, ModuleConfig moduleConfig, String uri) Create and return aForwardConfigrepresenting the specified module-relative destination.protected abstract ActionAbstractCreateAction.getAction(ActionContext context, String type, ActionConfig actionConfig) Create and return the appropriateActionclass for the giventypeandactionConfig.protected Command<ActionContext> ExecuteCommand.getCommand(ActionContext context) Find theActionConfigin the current context and, if it is properly configured, lookup the appropriatecommons-chaincommand.protected Command<ActionContext> ExecuteForwardCommand.getCommand(ActionContext context) Return the command specified by thecommandandcatalogproperties of theforwardConfigproperty of the givenActionContext.protected StringExecuteDispatcher.getDispatcherType(ActionContext context) Retrieves the fully-qualified class name of the dispatcher to instantiate for the specified context.protected abstract StringAbstractAuthorizeAction.getErrorMessage(ActionContext context, ActionConfig actionConfig) Retrieve error message from context.protected abstract StringAbstractSelectInput.getErrorMessage(ActionContext context, ActionConfig actionConfig) Retrieve error message from context.protected abstract LocaleAbstractSelectLocale.getLocale(ActionContext context) Return theLocaleto be used for this request.protected abstract StringAbstractSelectAction.getPath(ActionContext context) Return the path to be used to select theActionConfigfor this request.protected abstract StringAbstractSelectModule.getPrefix(ActionContext context) Calculate and return the module prefix for the module to be selected for this request.protected abstract ForwardConfigAbstractExceptionHandler.handle(ActionContext context, Exception exception, ExceptionConfig exceptionConfig, ActionConfig actionConfig, ModuleConfig moduleConfig) Perform the required handling of the specified exception.protected voidAbstractPopulateActionForm.handleCancel(ActionContext context, ActionConfig actionConfig, ActionForm actionForm) Take into account whether the request includes any defined value for the global "cancel" parameter.protected StringAbstractPerformInclude.includePath(ActionContext actionContext, String include) Returns the path to perform the include.protected abstract booleanAbstractAuthorizeAction.isAuthorized(ActionContext context, String[] roles, ActionConfig actionConfig) Determine if the action is authorized for the given roles.protected abstract booleanAbstractPopulateActionForm.isPopulate(ActionContext context, ActionConfig actionConfig) Determines whether an action form should be populated.protected abstract booleanAbstractPopulateActionForm.isReset(ActionContext context, ActionConfig actionConfig) Determines whether an action form should be resetprotected abstract voidAbstractPerformForward.perform(ActionContext context, ForwardConfig forwardConfig) Perform the appropriate processing on the specifiedForwardConfig.protected abstract voidAbstractPerformInclude.perform(ActionContext context, String include) Perform the appropriate processing on the specified include uri.protected abstract voidAbstractPopulateActionForm.populate(ActionContext context, ActionConfig actionConfig, ActionForm actionForm) Populate the givenActionFormwith request parameter values, taking into account any prefix/suffix values configured on the givenActionConfig.booleanExceptionCatcher.postprocess(ActionContext actionCtx, Exception exception) If an exception was thrown by a subsequentCommand, pass it on to the specified exception handling chain.protected voidExecuteDispatcher.processDispatchResult(Object result, ActionContext context) Interprets the specified dispatch result.protected abstract voidAbstractRequestNoCache.requestNoCache(ActionContext context) Request no cache flags are set.protected abstract voidAbstractPopulateActionForm.reset(ActionContext context, ActionConfig actionConfig, ActionForm actionForm) Call thereset()method on the specified form bean.protected abstract voidAbstractSetContentType.setContentType(ActionContext context, String contentType) Request no cache flags are set.protected abstract voidAbstractSetOriginalURI.setOriginalURI(ActionContext context) Set the original uri.protected booleanExecuteCommand.shouldProcess(ActionContext context) Evaluate the current context to see if a command should even be executed.protected booleanExecuteForwardCommand.shouldProcess(ActionContext context) Determine whether the forwardConfig should be processed.protected abstract ActionErrorsAbstractValidateActionForm.validate(ActionContext context, ActionConfig actionConfig, ActionForm actionForm) Call thevalidate()method of the specified form bean, and return the resultingActionErrorsobject. -
Uses of ActionContext in org.apache.struts.chain.commands.generic
Methods in org.apache.struts.chain.commands.generic with parameters of type ActionContextModifier and TypeMethodDescriptionprotected booleanCopyFormToContext.execute_(ActionContext actionContext) Look up anActionForminstance based on the configured properties of this command and copy it into theContext.protected ActionFormCopyFormToContext.findOrCreateForm(ActionContext context) Based on the properties of this command and the givenActionContext, find or create anActionForminstance for preparation.protected ActionFormCopyFormToContext.findOrCreateForm(ActionContext ctx, String effectiveFormName, String effectiveScope) Actually find or create an instance ofActionFormconfigured under the form-bean-nameeffectiveFormName, looking in in theActionContext'sscope as identified byeffectiveScope. -
Uses of ActionContext in org.apache.struts.chain.commands.servlet
Methods in org.apache.struts.chain.commands.servlet with parameters of type ActionContextModifier and TypeMethodDescriptionprotected ActionCreateAction.createAction(ActionContext context, String type) Invoked bygetActionwhen theActionactually has to be created.protected ForwardConfigExecuteAction.execute(ActionContext context, Action action, ActionConfig actionConfig, ActionForm actionForm) Execute the specifiedAction, and return the resultingActionForward.protected booleanActionPostProcess.execute_(ActionContext context) Performs additional functions after an Action or Command has been called.protected ForwardConfigSelectForward.forward(ActionContext context, ModuleConfig moduleConfig, String uri) Create and return aForwardConfigrepresenting the specified module-relative destination.protected ForwardConfigSelectInput.forward(ActionContext context, ModuleConfig moduleConfig, String uri) Create and return aForwardConfigrepresenting the specified module-relative destination.protected ActionCreateAction.getAction(ActionContext context, String type, ActionConfig actionConfig) protected StringAuthorizeAction.getErrorMessage(ActionContext context, ActionConfig actionConfig) protected StringSelectInput.getErrorMessage(ActionContext context, ActionConfig actionConfig) protected LocaleSelectLocale.getLocale(ActionContext context) Return theLocaleto be used for this request.protected StringSelectAction.getPath(ActionContext context) protected StringSelectModule.getPrefix(ActionContext context) protected ForwardConfigExceptionHandler.handle(ActionContext context, Exception exception, ExceptionConfig exceptionConfig, ActionConfig actionConfig, ModuleConfig moduleConfig) protected StringPerformInclude.includePath(ActionContext actionContext, String include) protected booleanAuthorizeAction.isAuthorized(ActionContext context, String[] roles, ActionConfig mapping) protected booleanPopulateActionForm.isPopulate(ActionContext context, ActionConfig actionConfig) Determines whether an action form should be populated.protected booleanPopulateActionForm.isReset(ActionContext context, ActionConfig actionConfig) Determines whether an action form should be reset.protected voidPerformForward.perform(ActionContext context, ForwardConfig forwardConfig) Perform the appropriate processing on the specifiedForwardConfig.protected voidPerformInclude.perform(ActionContext context, String uri) Perform the appropriate processing on the specified include uri.protected voidPopulateActionForm.populate(ActionContext context, ActionConfig actionConfig, ActionForm actionForm) protected voidRequestNoCache.requestNoCache(ActionContext context) protected voidPopulateActionForm.reset(ActionContext context, ActionConfig actionConfig, ActionForm actionForm) protected voidSetContentType.setContentType(ActionContext context, String contentType) protected voidSetOriginalURI.setOriginalURI(ActionContext context) protected ActionErrorsValidateActionForm.validate(ActionContext context, ActionConfig actionConfig, ActionForm actionForm) Call thevalidate()method of the specified form bean, and return the resultingActionErrorsobject. -
Uses of ActionContext in org.apache.struts.chain.contexts
Classes in org.apache.struts.chain.contexts that implement ActionContextModifier and TypeClassDescriptionclassProvide an abstract but semi-complete implementation of ActionContext to serve as the base for concrete implementations.classImplementActionContextwith empty maps forapplicationScope,sessionScope,requestScope, andparameterMapproperties.classImplement ActionContext interface while making Servlet API-specific values available.classProvide a Subclass of ActionContextBase which is understood to be wrapping an instance ofWebContext. -
Uses of ActionContext in org.apache.struts.config
Methods in org.apache.struts.config with parameters of type ActionContextModifier and TypeMethodDescriptionFormBeanConfig.createActionForm(ActionContext context) Create and return anActionForminstance appropriate to the information in thisFormBeanConfig. -
Uses of ActionContext in org.apache.struts.dispatcher
Methods in org.apache.struts.dispatcher with parameters of type ActionContextModifier and TypeMethodDescriptionObject[]AbstractMethodResolver.buildArguments(ActionContext context, Method method) Object[]MethodResolver.buildArguments(ActionContext context, Method method) Constructs the arguments that will be passed to the dispatched method.AbstractDispatcher.dispatch(ActionContext context) Dispatcher.dispatch(ActionContext context) Dispatches to the action referenced by the specified context.protected final ObjectAbstractDispatcher.dispatchMethod(ActionContext context, Method method, String name) Dispatches to the specified method.protected final MethodAbstractDispatcher.getMethod(ActionContext context, String methodName) Introspects the action to identify a method of the specified name that will be the target of the dispatch.protected StringAbstractParameterDispatcher.getParameter(ActionContext context) Retrieves the parameter name whose value will identity the intended method to dispatch.protected booleanAbstractDispatcher.isCancelled(ActionContext context) Determines whether the current form's cancel button was pressed.protected abstract booleanAbstractEventMappingDispatcher.isSubmissionParameter(ActionContext context, String methodKey) Determines whether the specified method key is a submission parameter.AbstractMethodResolver.resolveMethod(ActionContext context, String methodName) MethodResolver.resolveMethod(ActionContext context, String methodName) Decides the appropriate method instance for the specified method name.protected final StringAbstractEventMappingDispatcher.resolveMethodName(ActionContext context) protected StringAbstractMappingDispatcher.resolveMethodName(ActionContext context) Resolves the method name by obtaining theparameterattribute from theActionMapping.protected final StringAbstractParameterDispatcher.resolveMethodName(ActionContext context) protected abstract StringAbstractParameterDispatcher.resolveParameterValue(ActionContext context, String parameter) Extracts the value that is keyed by the specified parameter.protected ObjectAbstractDispatcher.unspecified(ActionContext context) Services the case when the dispatch fails because the method name cannot be resolved. -
Uses of ActionContext in org.apache.struts.dispatcher.servlet
Methods in org.apache.struts.dispatcher.servlet with parameters of type ActionContextModifier and TypeMethodDescriptionObject[]ServletMethodResolver.buildArguments(ActionContext context, Method method) protected booleanServletEventMappingDispatcher.isSubmissionParameter(ActionContext context, String methodKey) If the method key exists as a standalone parameter or with the image suffixes (.x/.y), the method name has been found.protected final MethodServletMethodResolver.resolveClassicMethod(ActionContext context, String methodName) Obtains the method instance with the classicexecuteservlet signature.ServletMethodResolver.resolveMethod(ActionContext context, String methodName) protected StringServletParameterDispatcher.resolveParameterValue(ActionContext context, String parameter) Extracts the value from the specified servlet parameter.protected ObjectServletMappingDispatcher.unspecified(ActionContext context) Sends the 404 HTTP error response.protected ObjectServletParameterDispatcher.unspecified(ActionContext context) Sends the 404 HTTP error response.