Package org.kuali.rice.krad.web.controller

Class UifClientListener

java.lang.Object

org.kuali.rice.krad.web.controller.UifControllerBase

org.kuali.rice.krad.web.controller.UifClientListener

@Controller
@RequestMapping("/listener")
public class UifClientListener
extends UifControllerBase

Controller that receives various ajax requests from the client to manager server side state

Author:

Kuali Rice Team (rice.collab@kuali.org)

Constructor Summary

Constructors

Constructor	Description
UifClientListener()

Method Summary

Modifier and Type	Method	Description
String	clearForm(String formKeyToClear, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Invoked from the client when the user is leaving a view (by the portal tabs or other mechanism) to clear the form from session storage
protected UifFormBase	createInitialForm()	Invoked to create a new form instance for the request before it is passed to the Binder/BeanWrapper.
String	keepSessionAlive(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Invoked from the session timeout warning dialog to keep a session alive on behalf of a user
org.springframework.web.servlet.ModelAndView	logout(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Invoked from the session timeout warning dialog to log the user out, forwards to logout message view
String	retrieveMessage(String key, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Invoked from the client to retrieve text for a message

Methods inherited from class org.kuali.rice.krad.web.controller.UifControllerBase

addBlankLine, addFileUploadLine, addLine, back, cancel, checkForm, closeEditLineDialog, defaultMapping, deleteFileUploadLine, deleteLine, editLine, getCollectionControllerService, getControllerService, getFileControllerService, getFileFromLine, getMessageView, getModelAndView, getModelAndView, getModelAndView, getModelAndViewService, getModelAndViewWithInit, getModelAndViewWithInit, getNavigationControllerService, getQueryControllerService, getRefreshControllerService, getSaveControllerService, initForm, navigate, performFieldQuery, performFieldSuggest, performLookup, performRedirect, performRedirect, refresh, retrieveCollectionPage, retrieveEditLineDialog, returnToHub, returnToPrevious, save, saveField, saveLine, sessionTimeout, setCollectionControllerService, setControllerService, setFileControllerService, setModelAndViewService, setNavigationControllerService, setQueryControllerService, setRefreshControllerService, setSaveControllerService, showDialog, start, tableJsonRetrieval

Methods inherited from class java.lang.Object

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

Constructor Details

UifClientListener

public UifClientListener()

Method Details

createInitialForm

protected UifFormBase createInitialForm()

Invoked to create a new form instance for the request before it is passed to the Binder/BeanWrapper.

Specified by:

createInitialForm in class UifControllerBase

Returns:

UifFormBase instance that will be used for data binding and backing the view.

clearForm

@MethodAccessible
@RequestMapping(params="methodToCall=clearForm")
@ResponseBody
public String clearForm(@RequestParam("formKeyToClear")
 String formKeyToClear,
 javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)

Invoked from the client when the user is leaving a view (by the portal tabs or other mechanism) to clear the form from session storage

Parameters:

formKeyToClear - key of form that should be cleared

Returns:

String json success string

retrieveMessage

@MethodAccessible
@RequestMapping(params="methodToCall=retrieveMessage")
@ResponseBody
public String retrieveMessage(@RequestParam("key")
 String key,
 javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)

Invoked from the client to retrieve text for a message

Parameters:

key - - key for the message

Returns:

String response in JSON format containing the message text

keepSessionAlive

@MethodAccessible
@RequestMapping(params="methodToCall=keepSessionAlive")
@ResponseBody
public String keepSessionAlive(javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)

Invoked from the session timeout warning dialog to keep a session alive on behalf of a user

Returns:

String json success string

logout

@MethodAccessible
@RequestMapping(params="methodToCall=logout")
public org.springframework.web.servlet.ModelAndView logout(@ModelAttribute("KualiForm")
 UifFormBase form,
 org.springframework.validation.BindingResult result,
 javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)

Invoked from the session timeout warning dialog to log the user out, forwards to logout message view