com.redhat.rhn.frontend.struts

Class RhnListDispatchAction

java.lang.Object

org.apache.struts.action.Action

org.apache.struts.actions.BaseAction

org.apache.struts.actions.DispatchAction

org.apache.struts.actions.LookupDispatchAction

com.redhat.rhn.frontend.struts.RhnLookupDispatchAction

com.redhat.rhn.frontend.struts.RhnListDispatchAction

Direct Known Subclasses:

ConfigConfirmSubmitAction, EnableSubmitAction, ErrataConfirmAction, FileListConfirmSubmitAction, GlobalRevisionDeployConfirmSubmit, RhnSetAction, UnsubscribeConfirmSubmitAction

public abstract class RhnListDispatchAction
extends RhnLookupDispatchAction

A base class for performing common list actions for those struts actions that must extend LookupDispatchAction, but do not manage a RhnSet. Example: a confirm page.

See Also:

RhnSetAction

Field Summary

Fields inherited from class com.redhat.rhn.frontend.struts.RhnLookupDispatchAction

SUBMITTED

Fields inherited from class org.apache.struts.actions.LookupDispatchAction

keyMethodMap, localeMap

Fields inherited from class org.apache.struts.actions.DispatchAction

clazz, log, methods, types

Fields inherited from class org.apache.struts.actions.BaseAction

messages

Fields inherited from class org.apache.struts.action.Action

servlet

Constructor Summary

Constructors

Constructor and Description
RhnListDispatchAction()

Method Summary

Modifier and Type	Method and Description
protected void	createSuccessMessage(javax.servlet.http.HttpServletRequest req, java.lang.String msgKey, java.lang.String param1) Add a success message to the request with 1 parameter: Your System55 has been updated where System55 is the value placed in param1.
org.apache.struts.action.ActionForward	filter(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm formIn, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Setup the filter parameter on the request.
protected java.lang.String	getForwardName(javax.servlet.http.HttpServletRequest request) Here is a way for subclasses to serve multiple possible forwards.
protected java.util.Map<java.lang.String,java.lang.String>	getKeyMethodMap()
protected java.util.Map<java.lang.String,java.lang.Object>	makeParamMap(org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request) Makes a parameter map containing request params that need to be forwarded on to the success mapping.
protected abstract void	processMethodKeys(java.util.Map<java.lang.String,java.lang.String> map) This method is used to add additional buttons to a list display.
protected abstract void	processParamMap(org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, java.util.Map<java.lang.String,java.lang.Object> params)
org.apache.struts.action.ActionForward	unspecified(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm formIn, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Default action to execute if dispatch parameter is missing or isn't in map

Methods inherited from class com.redhat.rhn.frontend.struts.RhnLookupDispatchAction

getMethodName, getStrutsDelegate, isSubmitted, l10n, lv

Methods inherited from class org.apache.struts.actions.LookupDispatchAction

execute, getLookupMapName

Methods inherited from class org.apache.struts.actions.DispatchAction

cancelled, dispatchMethod, getMethod, getParameter

Methods inherited from class org.apache.struts.action.Action

addErrors, addMessages, execute, generateToken, 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

Constructor Detail

RhnListDispatchAction

public RhnListDispatchAction()

Method Detail

getKeyMethodMap

protected java.util.Map<java.lang.String,java.lang.String> getKeyMethodMap()

Specified by:

getKeyMethodMap in class org.apache.struts.actions.LookupDispatchAction

filter

public org.apache.struts.action.ActionForward filter(org.apache.struts.action.ActionMapping mapping,
                                                     org.apache.struts.action.ActionForm formIn,
                                                     javax.servlet.http.HttpServletRequest request,
                                                     javax.servlet.http.HttpServletResponse response)

Setup the filter parameter on the request.

Parameters:

mapping - ActionMapping

formIn - ActionForm

request - ServletRequest

response - ServletResponse

Returns:

The ActionForward to go to next.

unspecified

public org.apache.struts.action.ActionForward unspecified(org.apache.struts.action.ActionMapping mapping,
                                                          org.apache.struts.action.ActionForm formIn,
                                                          javax.servlet.http.HttpServletRequest request,
                                                          javax.servlet.http.HttpServletResponse response)

Default action to execute if dispatch parameter is missing or isn't in map

Overrides:

unspecified in class org.apache.struts.actions.DispatchAction

Parameters:

mapping - ActionMapping

formIn - ActionForm

request - ServletRequest

response - ServletResponse

Returns:

The ActionForward to go to next.

makeParamMap

protected java.util.Map<java.lang.String,java.lang.Object> makeParamMap(org.apache.struts.action.ActionForm form,
                                                                        javax.servlet.http.HttpServletRequest request)

Makes a parameter map containing request params that need to be forwarded on to the success mapping.

Parameters:

form - the ActionForm

request - HttpServletRequest containing request vars

Returns:

Returns Map of parameters TODO: was private

getForwardName

protected java.lang.String getForwardName(javax.servlet.http.HttpServletRequest request)

Here is a way for subclasses to serve multiple possible forwards.

Parameters:

request - The request object containing possibly needed parameters.

Returns:

default unless overridden by subclass.

createSuccessMessage

protected void createSuccessMessage(javax.servlet.http.HttpServletRequest req,
                                    java.lang.String msgKey,
                                    java.lang.String param1)

Add a success message to the request with 1 parameter: Your System55 has been updated where System55 is the value placed in param1. param1

Parameters:

req - to add the message to

msgKey - resource key to lookup

param1 - String value to fill in for the first parameter. (param1 is HTML escaped as well)

processParamMap

protected abstract void processParamMap(org.apache.struts.action.ActionForm form,
                                        javax.servlet.http.HttpServletRequest request,
                                        java.util.Map<java.lang.String,java.lang.Object> params)

processMethodKeys

protected abstract void processMethodKeys(java.util.Map<java.lang.String,java.lang.String> map)

This method is used to add additional buttons to a list display. It is called from getKeyMethodMap. Simply add your resource bundle name as the key to the given map, and the method name as the value. For example, if you have a resource bundle key of "failed.jsp.rescheduleActions" and a method in your Struts action called "rescheduleAll" the result should look as follows: map.put("failed.jsp.rescheduleActions", "rescheduleAll"); If there are no additional actions then simply return.

Parameters:

map - Mapping between method and button names.