com.redhat.rhn.frontend.struts.wizard

Class RhnWizardAction

java.lang.Object

org.apache.struts.action.Action

com.redhat.rhn.frontend.struts.RhnAction

com.redhat.rhn.frontend.struts.wizard.RhnWizardAction

Direct Known Subclasses:

CreateProfileWizardAction, ScheduleKickstartWizardAction

public abstract class RhnWizardAction
extends RhnAction

Base class designed to make writing wizard-type interfaces easier. The responsibilities of a class extending this one are:

• Implement the generateWizardSteps method. This method should create instances of WizardStep objects and place them in the provided map under a key which corresponds to the step name. The first, or starting, wizard step should be associated with two keys: the desired step name and the constant RhnWizardAction.STEP_START. The constant is used as a fallback when no step name is provided by the UI.
• Implement a DynaActionForm which contains a field named "wizardStep". This form field must contain the name of the submitted form action. This can be tricky since the field should normally point to the next step not the current step.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	STEP_PARAM
static java.lang.String	STEP_START

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

SUBMITTED

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

servlet

Constructor Summary

Constructors

Constructor and Description
RhnWizardAction()

Method Summary

Modifier and Type	Method and Description
protected org.apache.struts.action.ActionForward	dispatch(java.lang.String step, org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, RequestContext ctx, javax.servlet.http.HttpServletResponse response)
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)
protected java.util.List	findMethods(java.lang.String methodPrefix)
protected abstract void	generateWizardSteps(java.util.Map wizardSteps)

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

addGlobalMessage, addGlobalMessage, addMessage, createErrorMessage, createErrorMessageWithMultipleArgs, createLabelValueList, createMessage, createSuccessMessage, getStrutsDelegate, isSubmitted, l10n, localize, lv, lve, lvel10n, lvl10n, makeParamMap, saveMessages

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, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STEP_START

public static final java.lang.String STEP_START

See Also:

Constant Field Values

STEP_PARAM

public static final java.lang.String STEP_PARAM

See Also:

Constant Field Values

Constructor Detail

RhnWizardAction

public RhnWizardAction()

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

Throws:

java.lang.Exception

generateWizardSteps

protected abstract void generateWizardSteps(java.util.Map wizardSteps)

dispatch

protected org.apache.struts.action.ActionForward dispatch(java.lang.String step,
                                                          org.apache.struts.action.ActionMapping mapping,
                                                          org.apache.struts.action.ActionForm form,
                                                          RequestContext ctx,
                                                          javax.servlet.http.HttpServletResponse response)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

findMethods

protected java.util.List findMethods(java.lang.String methodPrefix)