destroy
public void destroy()
Clean up in preparation for a shutdown of this application.
doForward
protected void doForward(String uri,
HttpServletRequest request,
HttpServletResponse response)
throws IOException,
ServletException
Do a forward to specified URI using a RequestDispatcher
.
This method is used by all internal method needing to do a forward.
uri
- Context-relative URI to forward torequest
- Current page requestresponse
- Current page response
doInclude
protected void doInclude(String uri,
HttpServletRequest request,
HttpServletResponse response)
throws IOException,
ServletException
Do an include of specified URI using a RequestDispatcher
.
This method is used by all internal method needing to do an include.
uri
- Context-relative URI to includerequest
- Current page requestresponse
- Current page response
getInternal
protected MessageResources getInternal()
Return the MessageResources
instance containing our
internal message strings.
getServletContext
protected ServletContext getServletContext()
Return the ServletContext
for the web application in which
we are running.
init
public void init(ActionServlet servlet,
ModuleConfig moduleConfig)
throws ServletException
Initialize this request processor instance.
servlet
- The ActionServlet we are associated withmoduleConfig
- The ModuleConfig we are associated with.
internalModuleRelativeForward
protected void internalModuleRelativeForward(String uri,
HttpServletRequest request,
HttpServletResponse response)
throws IOException,
ServletException
Do a module relative forward to specified URI using request dispatcher.
URI is relative to the current module. The real URI is compute by prefixing
the module name.
This method is used internally and is not part of the public API. It is
advised to not use it in subclasses.
uri
- Module-relative URI to forward torequest
- Current page requestresponse
- Current page response
internalModuleRelativeInclude
protected void internalModuleRelativeInclude(String uri,
HttpServletRequest request,
HttpServletResponse response)
throws IOException,
ServletException
Do a module relative include to specified URI using request dispatcher.
URI is relative to the current module. The real URI is compute by prefixing
the module name.
This method is used internally and is not part of the public API. It is
advised to not use it in subclasses.
uri
- Module-relative URI to includerequest
- Current page requestresponse
- Current page response
log
protected void log(String message)
Use commons-logging instead. This will be removed in a release
after Struts 1.2.
Log the specified message to the servlet context log for this
web application.
message
- The message to be logged
log
protected void log(String message,
Throwable exception)
Use commons-logging instead. This will be removed in a release
after Struts 1.2.
Log the specified message and exception to the servlet context log
for this web application.
message
- The message to be loggedexception
- The exception to be logged
process
public void process(HttpServletRequest request,
HttpServletResponse response)
throws IOException,
ServletException
Process an HttpServletRequest
and create the
corresponding HttpServletResponse
or dispatch
to another resource.
request
- The servlet request we are processingresponse
- The servlet response we are creating
processActionCreate
protected Action processActionCreate(HttpServletRequest request,
HttpServletResponse response,
ActionMapping mapping)
throws IOException
Return an Action
instance that will be used to process
the current request, creating a new one if necessary.
request
- The servlet request we are processingresponse
- The servlet response we are creatingmapping
- The mapping we are using
processActionForm
protected ActionForm processActionForm(HttpServletRequest request,
HttpServletResponse response,
ActionMapping mapping)
Retrieve and return the ActionForm
associated with
this mapping, creating and retaining one if necessary. If there is no
ActionForm
associated with this mapping, return
null
.
request
- The servlet request we are processingresponse
- The servlet response we are creatingmapping
- The mapping we are using
processActionPerform
protected ActionForward processActionPerform(HttpServletRequest request,
HttpServletResponse response,
Action action,
ActionForm form,
ActionMapping mapping)
throws IOException,
ServletException
Ask the specified Action
instance to handle this
request. Return the ActionForward
instance (if any)
returned by the called Action
for further processing.
request
- The servlet request we are processingresponse
- The servlet response we are creatingaction
- The Action instance to be usedform
- The ActionForm instance to pass to this Actionmapping
- The ActionMapping instance to pass to this Action
processCachedMessages
protected void processCachedMessages(HttpServletRequest request,
HttpServletResponse response)
Removes any ActionMessages
object stored in the session
under Globals.MESSAGE_KEY
and Globals.ERROR_KEY
if the messages' isAccessed
method returns true. This
allows messages to be stored in the session, display one time, and be
released here.
request
- The servlet request we are processing.response
- The servlet response we are creating.
processContent
protected void processContent(HttpServletRequest request,
HttpServletResponse response)
Set the default content type (with optional character encoding) for
all responses if requested. NOTE - This header will
be overridden automatically if a
RequestDispatcher.forward
call is
ultimately invoked.
request
- The servlet request we are processingresponse
- The servlet response we are creating
processException
protected ActionForward processException(HttpServletRequest request,
HttpServletResponse response,
Exception exception,
ActionForm form,
ActionMapping mapping)
throws IOException,
ServletException
Ask our exception handler to handle the exception. Return the
ActionForward
instance (if any) returned by the
called ExceptionHandler
.
request
- The servlet request we are processingresponse
- The servlet response we are processingexception
- The exception being handledform
- The ActionForm we are processingmapping
- The ActionMapping we are using
processForward
protected boolean processForward(HttpServletRequest request,
HttpServletResponse response,
ActionMapping mapping)
throws IOException,
ServletException
Process a forward requested by this mapping (if any). Return
true
if standard processing should continue, or
false
if we have already handled this request.
request
- The servlet request we are processingresponse
- The servlet response we are creatingmapping
- The ActionMapping we are using
processForwardConfig
protected void processForwardConfig(HttpServletRequest request,
HttpServletResponse response,
ForwardConfig forward)
throws IOException,
ServletException
Forward or redirect to the specified destination, by the specified
mechanism. This method uses a ForwardConfig
object instead
an ActionForward
.
request
- The servlet request we are processingresponse
- The servlet response we are creatingforward
- The ForwardConfig controlling where we go next
processInclude
protected boolean processInclude(HttpServletRequest request,
HttpServletResponse response,
ActionMapping mapping)
throws IOException,
ServletException
Process an include requested by this mapping (if any). Return
true
if standard processing should continue, or
false
if we have already handled this request.
request
- The servlet request we are processingresponse
- The servlet response we are creatingmapping
- The ActionMapping we are using
processLocale
protected void processLocale(HttpServletRequest request,
HttpServletResponse response)
Automatically select a Locale
for the current user, if requested.
NOTE - configuring Locale selection will trigger
the creation of a new HttpSession
if necessary.
request
- The servlet request we are processingresponse
- The servlet response we are creating
processMapping
protected ActionMapping processMapping(HttpServletRequest request,
HttpServletResponse response,
String path)
throws IOException
Select the mapping used to process the selection path for this request.
If no mapping can be identified, create an error response and return
null
.
request
- The servlet request we are processingresponse
- The servlet response we are creatingpath
- The portion of the request URI for selecting a mapping
processMultipart
protected HttpServletRequest processMultipart(HttpServletRequest request)
If this is a multipart request, wrap it with a special wrapper.
Otherwise, return the request unchanged.
request
- The HttpServletRequest we are processing
processNoCache
protected void processNoCache(HttpServletRequest request,
HttpServletResponse response)
Set the no-cache headers for all responses, if requested.
NOTE - This header will be overridden
automatically if a RequestDispatcher.forward
call is
ultimately invoked.
request
- The servlet request we are processingresponse
- The servlet response we are creating
processPath
protected String processPath(HttpServletRequest request,
HttpServletResponse response)
throws IOException
Identify and return the path component (from the request URI) that
we will use to select an ActionMapping
with which to dispatch.
If no such path can be identified, create an error response and return
null
.
request
- The servlet request we are processingresponse
- The servlet response we are creating
processPopulate
protected void processPopulate(HttpServletRequest request,
HttpServletResponse response,
ActionForm form,
ActionMapping mapping)
throws ServletException
Populate the properties of the specified ActionForm
instance from
the request parameters included with this request. In addition,
request attribute Globals.CANCEL_KEY
will be set if
the request was submitted with a button created by
CancelTag
.
request
- The servlet request we are processingresponse
- The servlet response we are creatingform
- The ActionForm instance we are populatingmapping
- The ActionMapping we are using
processPreprocess
protected boolean processPreprocess(HttpServletRequest request,
HttpServletResponse response)
General-purpose preprocessing hook that can be overridden as required
by subclasses. Return true
if you want standard processing
to continue, or false
if the response has already been
completed. The default implementation does nothing.
request
- The servlet request we are processingresponse
- The servlet response we are creating
processRoles
protected boolean processRoles(HttpServletRequest request,
HttpServletResponse response,
ActionMapping mapping)
throws IOException,
ServletException
If this action is protected by security roles, make sure that the
current user possesses at least one of them. Return true
to continue normal processing, or false
if an appropriate
response has been created and processing should terminate.
request
- The servlet request we are processingresponse
- The servlet response we are creatingmapping
- The mapping we are using
processValidate
protected boolean processValidate(HttpServletRequest request,
HttpServletResponse response,
ActionForm form,
ActionMapping mapping)
throws IOException,
ServletException,
InvalidCancelException
If this request was not cancelled, and the request's
ActionMapping
has not disabled validation, call the
validate
method of the specified
ActionForm
,
and forward to the input path if there were any errors.
Return
true
if we should continue processing,
or
false
if we have already forwarded control back
to the input form.
request
- The servlet request we are processingresponse
- The servlet response we are creatingform
- The ActionForm instance we are populatingmapping
- The ActionMapping we are using