com.redhat.rhn.frontend.action.systems.entitlements

Class SystemEntitlementsSubmitAction

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

com.redhat.rhn.frontend.action.common.RhnSetAction

com.redhat.rhn.frontend.action.common.BaseSetOperateOnSelectedItemsAction

com.redhat.rhn.frontend.action.systems.entitlements.SystemEntitlementsSubmitAction

public class SystemEntitlementsSubmitAction
extends BaseSetOperateOnSelectedItemsAction

Class representing the submit action of the System Entitlements page

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_ADD_ENTITLED
static java.lang.String	KEY_MANAGEMENT_ENTITLED
static java.lang.String	KEY_REMOVE_ENTITLED
static java.lang.String	KEY_UNENTITLED

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, 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
SystemEntitlementsSubmitAction()

Method Summary

Modifier and Type	Method and Description
protected DataResult<SystemOverview>	getDataResult(User user, org.apache.struts.action.ActionForm formIn, javax.servlet.http.HttpServletRequest request)
protected org.apache.struts.action.ActionMessage	getEmptySelectionMessage()
protected RhnSetDecl	getSetDecl() The declaration of the set we are working with, must be one of the constants from RhnSetDecl
org.apache.struts.action.ActionForward	operateAddOnEntitlements(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm formIn, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean add) Execute some operation on the set of selected items.
org.apache.struts.action.ActionForward	processAdd(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm formIn, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	processManagementEntitled(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm formIn, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	processMessage(org.apache.struts.action.ActionMessages msg, java.lang.String methodName, long successCount, long failureCount) This basically adds all the action messages that will be used for validation errors or status messages
protected 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 void	processParamMap(org.apache.struts.action.ActionForm formIn, javax.servlet.http.HttpServletRequest request, java.util.Map<java.lang.String,java.lang.Object> params)
org.apache.struts.action.ActionForward	processRemove(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm formIn, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	processUnentitle(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm formIn, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
java.lang.Boolean	setToManagementEntitled(org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest req, RhnSetElement elementIn, User userIn) This method is called when the "Set To Management Entitled" button is clicked in the System Entitlements page.
java.lang.Boolean	unentitle(org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest req, RhnSetElement elementIn, User userIn) This method is called when the "Unentitle" button is clicked in the System Entitlements page.

Methods inherited from class com.redhat.rhn.frontend.action.common.BaseSetOperateOnSelectedItemsAction

addToMessage, addToMessage, getNoScriptMessage, handleEmptySelection, handleNoScript, operateOnElement, operateOnSelectedSet, operateOnSelectedSet

Methods inherited from class com.redhat.rhn.frontend.action.common.RhnSetAction

getKeyMethodMap, getSetName, selectall, unselectall, unspecified, updatelist, updateSet

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

createSuccessMessage, filter, getForwardName, makeParamMap

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

Field Detail

KEY_MANAGEMENT_ENTITLED

public static final java.lang.String KEY_MANAGEMENT_ENTITLED

See Also:

Constant Field Values

KEY_UNENTITLED

public static final java.lang.String KEY_UNENTITLED

See Also:

Constant Field Values

KEY_ADD_ENTITLED

public static final java.lang.String KEY_ADD_ENTITLED

See Also:

Constant Field Values

KEY_REMOVE_ENTITLED

public static final java.lang.String KEY_REMOVE_ENTITLED

See Also:

Constant Field Values

Constructor Detail

SystemEntitlementsSubmitAction

public SystemEntitlementsSubmitAction()

Method Detail

getSetDecl

protected RhnSetDecl getSetDecl()

The declaration of the set we are working with, must be one of the constants from RhnSetDecl

Specified by:

getSetDecl in class RhnSetAction

Returns:

the declaration of the set we are working with

getDataResult

protected DataResult<SystemOverview> getDataResult(User user,
                                                   org.apache.struts.action.ActionForm formIn,
                                                   javax.servlet.http.HttpServletRequest request)

Specified by:

getDataResult in class RhnSetAction

processMethodKeys

protected 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.

Specified by:

processMethodKeys in class RhnListDispatchAction

Parameters:

map - Mapping between method and button names.

processParamMap

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

Specified by:

processParamMap in class RhnListDispatchAction

processManagementEntitled

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

Parameters:

mapping - ActionMapping

formIn - ActionForm

request - ServletRequest

response - ServletResponse

Returns:

The ActionForward to go to next.

setToManagementEntitled

public java.lang.Boolean setToManagementEntitled(org.apache.struts.action.ActionForm form,
                                                 javax.servlet.http.HttpServletRequest req,
                                                 RhnSetElement elementIn,
                                                 User userIn)

This method is called when the "Set To Management Entitled" button is clicked in the System Entitlements page. Basically sets the entitlements of the selected systems to Management.

Parameters:

form - Action form object.

req - The servlet request object

elementIn - The checked element in the set

userIn - logged in user

Returns:

true of the server was entitled.

processUnentitle

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

Parameters:

mapping - ActionMapping

formIn - ActionForm

request - ServletRequest

response - ServletResponse

Returns:

The ActionForward to go to next.

unentitle

public java.lang.Boolean unentitle(org.apache.struts.action.ActionForm form,
                                   javax.servlet.http.HttpServletRequest req,
                                   RhnSetElement elementIn,
                                   User userIn)

This method is called when the "Unentitle" button is clicked in the System Entitlements page. Basically removes all the entitlements related to the selected systems.

Parameters:

form - Action form object.

req - The servlet request object

elementIn - The checked element in the set

userIn - logged in user

Returns:

true of the server was unentitled.

processAdd

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

Parameters:

mapping - ActionMapping

formIn - ActionForm

request - ServletRequest

response - ServletResponse

Returns:

The ActionForward to go to next.

processRemove

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

Parameters:

mapping - ActionMapping

formIn - ActionForm

request - ServletRequest

response - ServletResponse

Returns:

The ActionForward to go to next.

operateAddOnEntitlements

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

Execute some operation on the set of selected items. Forwards to the "default" NOTE: Must define StringResource for failure and success messages: getSetName() + ".success" for providing a parameterized message to the UI that would say "2 ServerProbe Suite(s) deleted."

Parameters:

mapping - ActionMapping

formIn - ActionForm

request - ServletRequest

response - ServletResponse

add - Add/remove entitlement..

Returns:

The ActionForward to go to next.

processMessage

protected void processMessage(org.apache.struts.action.ActionMessages msg,
                              java.lang.String methodName,
                              long successCount,
                              long failureCount)

This basically adds all the action messages that will be used for validation errors or status messages

Overrides:

processMessage in class BaseSetOperateOnSelectedItemsAction

Parameters:

msg - container of the messages

methodName - name of the caller method which is used as a key

successCount - the number of successful actions

failureCount - the number of failures.

getEmptySelectionMessage

protected org.apache.struts.action.ActionMessage getEmptySelectionMessage()

Overrides:

getEmptySelectionMessage in class BaseSetOperateOnSelectedItemsAction

Returns:

empty selection message