com.redhat.rhn.frontend.struts

Class RhnAction

java.lang.Object

org.apache.struts.action.Action

com.redhat.rhn.frontend.struts.RhnAction

Direct Known Subclasses:

ActionChainEditAction, ActionChainListAction, ActionDetailsSetupAction, ActivationAction, ActivationKeyChildChannelsAction, ActivationKeyCloneAction, ActivationKeyDeleteConfirmAction, ActivationKeyDetailsAction, ActivationKeyPackagesAction, ActivationKeysListAction, AddGroupsAction, AddPackagesAction, AddPackagesConfirmAction, AddressesAction, AddToSSMAction, AdvancedModeDetailsAction, AllowSlaveOrgsAction, AuditAction, AuditMachineAction, AuditSearchAction, BaseAddFilesAction, BaseConfigAction, BaseCopyToAction, BaseCryptoKeyEditAction, BaseDeleteErrataAction, BaseEditAction, BaseKickstartEditAction, BaseListAction, BaseListAction, BaseListAction, BaseScheduledListAction, BaseSearchAction, BaseSsmScheduleXccdfAction, BaseSystemEditAction, BaseSystemPackagesAction, BaseSystemPackagesConfirmAction, BaseUserSetupAction, BunchDetailAction, CatalinaAction, ChangeEmailAction, ChangeEmailSetupAction, ChannelDeployConfirmAction, ChannelDetailsAction, ChannelErrataAction, ChannelOverviewAction, ChannelOverviewTasks, ChannelPackageMenuAction, ChannelPackagesAction, ChannelPackagesAction, ChannelPackagesAddConfirmAction, ChannelPackagesBaseAction, ChannelPackagesRemoveAction, ChannelSubscribedAction, ChildChannelAction, ChildChannelConfirmAction, CloneChannelAction, CloneConfirmAction, CloneErrataAction, CobblerAction, CobblerSnippetDeleteAction, CobblerSnippetDetailsAction, CobblerSnippetListSetupAction, CobblerSnippetViewAction, CompareProfileSetupAction, CompareSystemSetupAction, ConfirmSystemPreferencesAction, CrashNoteDeleteAction, CrashNoteEditAction, CreateAction, CreateCustomDataAction, CreateCustomKeyAction, CreateProfileAction, CreateSetupAction, CreateUserAction, CryptoKeysListSetupAction, CustomKeyListAction, CustomPackageListAction, CustomPackagesDeleteConfirmAction, CustomValueAction, CustomValueSetAction, DeleteBugAction, DeleteChannelAction, DeleteChannelAction, DeleteCustomDataAction, DeleteCustomKeyAction, DeleteFileAction, DeleteGroupAction, DeleteProfileAction, DeleteRevisionAction, DeleteScheduleAction, DeleteSlaveAction, DeleteUserAction, DeleteUserSetupAction, DiffAction, DisabledListSetupAction, DisableSelfAction, DisableSelfConfirmAction, DisableUserAction, DisableUserSetupAction, DispatchedAction, DistChannelMapDeleteAction, DistChannelMapEditAction, DistChannelMapSetupAction, DownloadDiffAction, DuplicateSystemsAction, DuplicateSystemsCompareAction, DuplicateSystemsDeleteSetupAction, EditAddressAction, EditAddressSetupAction, EditChannelAction, EditGroupAction, EditMasterAction, EditMasterSetupAction, EditPackagesAction, EditSlaveAction, EditSlaveSetupAction, EnabledListSetupAction, EnableUserAction, EnableUserSetupAction, ErrataChannelIntersectionAction, ErrataConfirmSetupAction, ErrataDetailsSetupAction, ErrataListAction, ErrataListBaseAction, ErrataListConfirmAction, ErrataPackagesSetupAction, ErrataSetupAction, ErrataSystemsAffectedListAction, ExtAuthenticationAction, ExtAuthRoleMappingAction, ExtAuthSgDeleteAction, ExtAuthSgDetailAction, ExtAuthSgMappingAction, ExtGroupDeleteAction, ExtGroupDetailAction, FileDetailsAction, FileDownloadAction, ForgotCredentialsAction, GenericIndexAction, GroupDetailAction, HelpAction, InstalledSystemsListAction, KickstartAdvancedOptionsAction, KickstartCloneAction, KickstartIpRangeAction, KickstartIpRangeDeleteAction, KickstartIpRangeSetupAction, KickstartOverviewAction, KickstartPackageProfileSetupAction, KickstartsSetupAction, KickstartVariableAction, ListCustomDataAction, ListPackagesAction, ListSystemsAction, ListXccdfAction, LocalRevisionDeployAction, Login401SetupAction, LoginAction, LoginSetupAction, LogoutAction, ManageChannelsAction, ManagersSetupAction, MasterAction, MigrateSystemsAction, MiscIndexAction, MissingPackageSetupAction, NotifyAction, OrganizationAction, OrganizationTrustAction, OrgChannelListAction, OrgConfigAction, OrgCreateAction, OrgDeleteAction, OrgDetailsAction, OrgTrustDetailsAction, Overview, OverviewAction, PackageChangeLogAction, PackageDependenciesAction, PackageDetailsAction, PackageListAction, PackageListSetupAction, PackageNameOverviewAction, PendingActionsDeleteConfirmAction, PowerManagementAction, PowerManagementConfigurationAction, PowerManagementOperationsAction, PreservationListDeleteSingleAction, ProfileDetailsAction, ProvisioningRemoteCommand, PublishedErrataAction, RankChannelsAction, RebootSystemConfirmAction, RemoveFromSSMAction, RemoveMastersAction, RemovePackagesAction, RemoveSlavesAction, RepoChannelsAction, RepoDeleteAction, RepoDetailsAction, RepoListSetupAction, RepositoriesAction, ResetLinkAction, ResetPasswordAction, RestartAction, RhnListAction, RhnUnpagedListAction, RhnWizardAction, RollbackAction, RollbackToTagAction, RuleDetailsAction, SatAdminAction, SatRoleConfirm, SatSchedulesAction, SatUserListAction, ScapSetupAction, ScheduleDetailAction, ScheduleImageDeploymentAction, SchedulePackageUpgradeAction, SchedulePackageVerifyAction, ScriptsSetupAction, SearchAction, SelectInstallationPackagesAction, SelectRemovePackagesAction, SelectUpgradePackagesAction, SelectVerifyPackagesAction, SessionStatusAction, ShowProfileAction, SlaveAction, SnapshotBaseAction, SnapshotIndexAction, SnapshotRollbackAction, SnapshotTagCreateAction, SnapshotTagsAction, SnapshotTagsDeleteAction, SoftwareCrashesAction, SoftwareCrashesDeleteAction, SoftwareCrashesDetailsAction, SoftwareCrashesFilesAction, SoftwareCrashesNotesAction, SoftwareCrashesOverviewAction, SoftwareCrashUuidDetailsAction, SSMDeleteSystemsConfirm, SSMGroupConfirmAction, SSMGroupManageAction, SsmKickstartableSystemsAction, SsmKSScheduleAction, SSMUpdateHardwareProfileConfirm, SSMUpdateSoftwareProfileConfirm, SubscribeConfirm, SubscribersAction, SyncErrataAction, SyncErrataPackagesAction, SyncProfilesSetupAction, SyncRepositoriesAction, SyncSystemsSetupAction, SystemConnectionAction, SystemDeleteConfirmAction, SystemDetailsEditAction, SystemDetailsEditAction, SystemFailEventAction, SystemGroupConfigAction, SystemGroupListSetupAction, SystemHardwareAction, SystemHistoryAction, SystemHistoryEventAction, SystemMigrateAction, SystemNoteDeleteAction, SystemNoteEditAction, SystemOverviewAction, SystemPendingEventsAction, SystemPendingEventsCancelAction, SystemRebootAction, SystemRemoteCommandAction, TagSystemsAction, TargetSystemsAction, TargetSystemsConfirmAction, TargetSystemsConfirmAction, TargetSystemsListAction, TaskStatusAction, TinyUrlAction, TrustAction, UnpublishedErrataAction, UpdateCustomDataAction, UpdateCustomKeyAction, UserEditActionHelper, UserEditSetupAction, UserListSetupAction, UserListSetupAction, UserPrefAction, UserPrefSetupAction, ViewDiffResultAction, ViewModifyPathsAction, ViewTreesAction, VirtualSystemSetupAction, WorkWithGroupAction, XccdfDeleteConfirmAction, XccdfDetailsAction, XccdfDiffSubmitAction, XccdfSearchHelper, YourRhnAction, YourRhnClipsRenderer

public abstract class RhnAction
extends org.apache.struts.action.Action

RhnAction base class for all RHN Struts Actions. Used to override Struts functionality as well as add common features to the RHN Struts Actions.

NOTE: RhnSetAction and RhnAction contain two duplicate methods - getStrutsDelegate() and createSuccessMessage(). If another method is added to these classes that is common to both we need to refactor the common methods into a new class maybe called RhnActionDelegate.

We cannot introduce a common base class because RhnSetAction and RhnAction fall into different inheritance hierarchies.

See Also:

RhnSetAction

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SUBMITTED

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

servlet

Constructor Summary

Constructors

Constructor and Description
RhnAction()

Method Summary

Modifier and Type	Method and Description
protected void	addGlobalMessage(org.apache.struts.action.ActionMessages messages, java.lang.String key) Add a message to the set of ActionMessages.
protected void	addGlobalMessage(org.apache.struts.action.ActionMessages messages, java.lang.String key, java.lang.String param0) Add a message to the set of ActionMessages.
protected void	addMessage(javax.servlet.http.HttpServletRequest req, java.lang.String msgKey) Add a success message to the request.
protected void	createErrorMessage(javax.servlet.http.HttpServletRequest req, java.lang.String beanKey, java.lang.String param) Add an error message to the request with 1 parameter: Your System55 has NOT been updated where System55 is the value placed in param.
protected void	createErrorMessageWithMultipleArgs(javax.servlet.http.HttpServletRequest req, java.lang.String beanKey, java.lang.String[] args) Add an error message to the request with argument array
protected java.util.List	createLabelValueList(java.util.Iterator i, java.lang.String nameMethod, java.lang.String valueMethod) Util method to use some reflection to invoke a method on a Iterator's items to produce a List of LabelValue beans
protected void	createMessage(javax.servlet.http.HttpServletRequest req, java.lang.String msgKey, java.lang.String[] params) Add a success message to the request with any parameters.
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.
protected StrutsDelegate	getStrutsDelegate() Returns a StrutsDelegate object.
protected boolean	isSubmitted(org.apache.struts.action.DynaActionForm form) Simple util to check if the Form was submitted
protected java.lang.String	l10n(java.lang.String key) Take a key and return a localized (l10n) String
protected void	localize(java.util.Collection lvList)
protected static org.apache.struts.util.LabelValueBean	lv(java.lang.String label, java.lang.String value) Construct a LabelValueBean with specified label and value
protected static LabelValueEnabledBean	lve(java.lang.String label, java.lang.String value, boolean disabled) Construct a LabelValueEnabledBean instance where the label is localized using the LocalizationService.getMessage() method.
protected static LabelValueEnabledBean	lvel10n(java.lang.String label, java.lang.String value, boolean disabled) Construct a LabelValueEnabledBean instance where the label is localized using the LocalizationService.getMessage() method.
protected static org.apache.struts.util.LabelValueBean	lvl10n(java.lang.String label, java.lang.String value) Construct a LabelValueBean instance where the label is localized using the LocalizationService.getMessage() method.
protected java.util.Map	makeParamMap(javax.servlet.http.HttpServletRequest request) Default param map for our actions.
void	saveMessages(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionMessages messages)

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

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

SUBMITTED

public static final java.lang.String SUBMITTED

See Also:

Constant Field Values

Constructor Detail

RhnAction

public RhnAction()

Method Detail

getStrutsDelegate

protected StrutsDelegate getStrutsDelegate()

Returns a StrutsDelegate object.

Returns:

A StrutsDelegate object.

See Also:

StrutsDelegate

createLabelValueList

protected java.util.List createLabelValueList(java.util.Iterator i,
                                              java.lang.String nameMethod,
                                              java.lang.String valueMethod)

Util method to use some reflection to invoke a method on a Iterator's items to produce a List of LabelValue beans

Parameters:

i - Iterator that contains the items you want to convert into label value bean

nameMethod - to call on each object, something like 'Channel.getName()'. Must return a String or will throw ClassCastException

valueMethod - method to call on each object to retrieve the desired value.

Returns:

List of LabelValue beans

lv

protected static org.apache.struts.util.LabelValueBean lv(java.lang.String label,
                                                          java.lang.String value)

Construct a LabelValueBean with specified label and value

Parameters:

label - to use

value - value of selection

Returns:

LabelValueBean instance

lvl10n

protected static org.apache.struts.util.LabelValueBean lvl10n(java.lang.String label,
                                                              java.lang.String value)

Construct a LabelValueBean instance where the label is localized using the LocalizationService.getMessage() method.

Parameters:

label - to localize

value - value of selection

Returns:

LabelValueBean instance

lve

protected static LabelValueEnabledBean lve(java.lang.String label,
                                           java.lang.String value,
                                           boolean disabled)

Construct a LabelValueEnabledBean instance where the label is localized using the LocalizationService.getMessage() method.

Parameters:

label - to localize

value - value of selection

disabled - true if the bean renderer should render as disabled, false otherwise

Returns:

LabelValueBean instance

lvel10n

protected static LabelValueEnabledBean lvel10n(java.lang.String label,
                                               java.lang.String value,
                                               boolean disabled)

Construct a LabelValueEnabledBean instance where the label is localized using the LocalizationService.getMessage() method.

Parameters:

label - to localize

value - value of selection

disabled - true if the bean renderer should render as disabled, false otherwise

Returns:

LabelValueBean instance

saveMessages

public void saveMessages(javax.servlet.http.HttpServletRequest request,
                         org.apache.struts.action.ActionMessages messages)

Overrides:

saveMessages in class org.apache.struts.action.Action

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)

createMessage

protected void createMessage(javax.servlet.http.HttpServletRequest req,
                             java.lang.String msgKey,
                             java.lang.String[] params)

Add a success message to the request with any parameters.

Parameters:

req - to add the message to

msgKey - resource key to lookup

params - String values to fill in

addMessage

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

Add a success message to the request.

Parameters:

req - to add the message to

msgKey - resource key to lookup

createErrorMessage

protected void createErrorMessage(javax.servlet.http.HttpServletRequest req,
                                  java.lang.String beanKey,
                                  java.lang.String param)

Add an error message to the request with 1 parameter: Your System55 has NOT been updated where System55 is the value placed in param.

Parameters:

req - to add the message to

beanKey - resource key to lookup

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

createErrorMessageWithMultipleArgs

protected void createErrorMessageWithMultipleArgs(javax.servlet.http.HttpServletRequest req,
                                                  java.lang.String beanKey,
                                                  java.lang.String[] args)

Add an error message to the request with argument array

Parameters:

req - to add the message to

beanKey - resource key to lookup

args - String array to fill in for the message parameters

addGlobalMessage

protected void addGlobalMessage(org.apache.struts.action.ActionMessages messages,
                                java.lang.String key)

Add a message to the set of ActionMessages. Takes the key, constructs a new ActionMessage object and adds it to the ActionMessages collection passed in.

Parameters:

messages - set of ActionMessages we want to add an additional ActionMessage to.

key - to the resource bundle that we want to fetch the message from.

addGlobalMessage

protected void addGlobalMessage(org.apache.struts.action.ActionMessages messages,
                                java.lang.String key,
                                java.lang.String param0)

Add a message to the set of ActionMessages. Takes the key, constructs a new ActionMessage object and adds it to the ActionMessages collection passed in.

Parameters:

messages - set of ActionMessages we want to add an additional ActionMessage to.

key - to the resource bundle that we want to fetch the message from.

param0 - the first parameter to be substituted into the message

isSubmitted

protected boolean isSubmitted(org.apache.struts.action.DynaActionForm form)

Simple util to check if the Form was submitted

Parameters:

form - to check

Returns:

True if the form was submitted, false otherwise.

localize

protected void localize(java.util.Collection lvList)

makeParamMap

protected java.util.Map makeParamMap(javax.servlet.http.HttpServletRequest request)

Default param map for our actions. At the minimum, we want to preserve any pagination variables that are in the request.

Parameters:

request - The request containing the params we want

Returns:

Returns a map containing the pagination params.

l10n

protected java.lang.String l10n(java.lang.String key)

Take a key and return a localized (l10n) String

Parameters:

key - to lookup

Returns:

String that is localized