org.kuali.rice.ken.web.spring

Class UserPreferencesController

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.support.WebContentGenerator

org.springframework.web.servlet.mvc.AbstractController

org.springframework.web.servlet.mvc.multiaction.MultiActionController

org.kuali.rice.ken.web.spring.UserPreferencesController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.mvc.Controller, org.springframework.web.servlet.mvc.LastModified

public class UserPreferencesController
extends org.springframework.web.servlet.mvc.multiaction.MultiActionController

This class is the controller that handles management of various user preferences interfaces (deliver types, user subscriptions, etc).

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected NotificationChannelService	notificationChannelService
protected Object	notificationMessageDelivererRegistryService
protected UserPreferenceService	userPreferenceService

Fields inherited from class org.springframework.web.servlet.mvc.multiaction.MultiActionController

DEFAULT_COMMAND_NAME, LAST_MODIFIED_METHOD_SUFFIX, PAGE_NOT_FOUND_LOG_CATEGORY, pageNotFoundLogger

Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator

METHOD_GET, METHOD_HEAD, METHOD_POST

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Constructor Summary

Constructors

Constructor and Description
UserPreferencesController()

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.web.servlet.ModelAndView	displayActionListPreferences(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method displays the actionList preferences screen.
org.springframework.web.servlet.ModelAndView	displayUserPreferences(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method handles displaying the user preferences UI.
void	setNotificationChannelService(NotificationChannelService notificationChannelService) Set the NotificationChannelService
void	setNotificationMessageDelivererRegistryService(Object notificationMessageDelivererRegistryService) Set the NotificationMessageDelivererRegistryService
void	setUserPreferenceService(UserPreferenceService userPreferenceService) Set the UserPreferenceService
org.springframework.web.servlet.ModelAndView	subscribeToChannel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Subscribe To a Channel
org.springframework.web.servlet.ModelAndView	unsubscribeFromChannel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Unsubscribe from Channel

Methods inherited from class org.springframework.web.servlet.mvc.multiaction.MultiActionController

bind, createBinder, getCommandName, getExceptionHandler, getLastModified, getMethodNameResolver, getValidators, getWebBindingInitializer, handleNoSuchRequestHandlingMethod, handleRequestInternal, initBinder, invokeNamedMethod, newCommandObject, setDelegate, setMethodNameResolver, setValidators, setWebBindingInitializer

Methods inherited from class org.springframework.web.servlet.mvc.AbstractController

handleRequest, isSynchronizeOnSession, setSynchronizeOnSession

Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator

applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isAlwaysMustRevalidate, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, preventCaching, setAlwaysMustRevalidate, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Field Detail

notificationChannelService

protected NotificationChannelService notificationChannelService

userPreferenceService

protected UserPreferenceService userPreferenceService

notificationMessageDelivererRegistryService

protected Object notificationMessageDelivererRegistryService

Constructor Detail

UserPreferencesController

public UserPreferencesController()

Method Detail

setNotificationChannelService

public void setNotificationChannelService(NotificationChannelService notificationChannelService)

Set the NotificationChannelService

Parameters:

notificationChannelService -

setUserPreferenceService

public void setUserPreferenceService(UserPreferenceService userPreferenceService)

Set the UserPreferenceService

Parameters:

userPreferenceService -

setNotificationMessageDelivererRegistryService

public void setNotificationMessageDelivererRegistryService(Object notificationMessageDelivererRegistryService)

Set the NotificationMessageDelivererRegistryService

Parameters:

notificationMessageDelivererRegistryService -

displayActionListPreferences

public org.springframework.web.servlet.ModelAndView displayActionListPreferences(javax.servlet.http.HttpServletRequest request,
                                                                        javax.servlet.http.HttpServletResponse response)
                                                                          throws javax.servlet.ServletException,
                                                                                 IOException

This method displays the actionList preferences screen.

Parameters:

request -

response -

Returns:

Throws:

javax.servlet.ServletException

IOException

displayUserPreferences

public org.springframework.web.servlet.ModelAndView displayUserPreferences(javax.servlet.http.HttpServletRequest request,
                                                                  javax.servlet.http.HttpServletResponse response)
                                                                    throws javax.servlet.ServletException,
                                                                           IOException

This method handles displaying the user preferences UI.

Parameters:

request -

response -

Returns:

Throws:

javax.servlet.ServletException

IOException

subscribeToChannel

public org.springframework.web.servlet.ModelAndView subscribeToChannel(javax.servlet.http.HttpServletRequest request,
                                                              javax.servlet.http.HttpServletResponse response)
                                                                throws javax.servlet.ServletException,
                                                                       IOException

Subscribe To a Channel

Parameters:

request -

response -

Returns:

Throws:

javax.servlet.ServletException

IOException

unsubscribeFromChannel

public org.springframework.web.servlet.ModelAndView unsubscribeFromChannel(javax.servlet.http.HttpServletRequest request,
                                                                  javax.servlet.http.HttpServletResponse response)
                                                                    throws javax.servlet.ServletException,
                                                                           IOException

Unsubscribe from Channel

Parameters:

request -

response -

Returns:

Throws:

javax.servlet.ServletException

IOException