Package org.kuali.rice.ksb.messaging.web

Class KSBAction

java.lang.Object
org.apache.struts.action.Action
org.apache.struts.actions.BaseAction
org.apache.struts.actions.DispatchAction
org.kuali.rice.ksb.messaging.web.KSBAction
Direct Known Subclasses:
ConfigViewerAction, JavaSecurityManagementAction, MessageQueueAction, QuartzQueueAction, ServiceBusAction, ServiceRegistryAction, ThreadPoolAction
public abstract class KSBAction extends org.apache.struts.actions.DispatchAction
An abstract super class for all Struts Actions in KEW. Adds some custom dispatch behavior by extending the Struts DispatchAction.
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Field Summary

    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
    Description
    KSBAction()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    checkAuthorization(org.apache.struts.action.ActionForm form, String methodToCall)
     
    org.apache.struts.action.ActionMessages
    establishFinalState(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionForm form)
     
    abstract org.apache.struts.action.ActionMessages
    establishRequiredState(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionForm form)
     
    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 String
    findMethodToCall(org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request)
     
    protected static KualiModuleService
    getKualiModuleService()
     
    protected Map<String,String>
    getRoleQualification(org.apache.struts.action.ActionForm form, String methodToCall)
    override this method to add data from the form for role qualification in the authorization check
    protected boolean
    isModuleLocked(org.apache.struts.action.ActionForm form, String methodToCall, javax.servlet.http.HttpServletRequest request)
     
    org.apache.struts.action.ActionForward
    noOp(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
     
    org.apache.struts.action.ActionForward
    refresh(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
     
    abstract org.apache.struts.action.ActionForward
    start(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
     

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

    cancelled, dispatchMethod, getMethod, getMethodName, getParameter, unspecified

    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 Details

    • KSBAction

      public KSBAction()

  • Method Details

    • 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 Exception
      Overrides:
      execute in class org.apache.struts.actions.DispatchAction
      Throws:
      Exception

    • checkAuthorization

      protected void checkAuthorization(org.apache.struts.action.ActionForm form, String methodToCall) throws AuthorizationException
      Throws:
      AuthorizationException

    • getRoleQualification

      protected Map<String,String> getRoleQualification(org.apache.struts.action.ActionForm form, String methodToCall)
      override this method to add data from the form for role qualification in the authorization check

    • start

      public abstract org.apache.struts.action.ActionForward start(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Throws:
      Exception

    • refresh

      public org.apache.struts.action.ActionForward refresh(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Throws:
      Exception

    • establishRequiredState

      public abstract org.apache.struts.action.ActionMessages establishRequiredState(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionForm form) throws Exception
      Throws:
      Exception

    • establishFinalState

      public org.apache.struts.action.ActionMessages establishFinalState(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionForm form) throws Exception
      Throws:
      Exception

    • noOp

      public org.apache.struts.action.ActionForward noOp(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Throws:
      Exception

    • getKualiModuleService

      protected static KualiModuleService getKualiModuleService()

    • findMethodToCall

      protected String findMethodToCall(org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request) throws Exception
      Throws:
      Exception

    • isModuleLocked

      protected boolean isModuleLocked(org.apache.struts.action.ActionForm form, String methodToCall, javax.servlet.http.HttpServletRequest request)