org.kuali.rice.ken.web.spring

Class NotificationController

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

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 NotificationController
extends org.springframework.web.servlet.mvc.multiaction.MultiActionController

This class is the controller for the basic notification related actions - viewing, etc.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected NotificationMessageDeliveryService	messageDeliveryService
protected NotificationService	notificationService
protected NotificationWorkflowDocumentService	notificationWorkflowDocService

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
NotificationController()

Method Summary

Modifier and Type	Method and Description
protected NotificationMessageDelivery	determineMessageFromRequest(javax.servlet.http.HttpServletRequest request) This method retrieves the NotificationMessageDelivery given an HttpServletRequest which may contain EITHER a message delivery id or a workflow doc id.
org.springframework.web.servlet.ModelAndView	dismissMessage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method handles user dismissal of a message
org.springframework.web.servlet.ModelAndView	displayHome(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles the display of the main home page in the system.
org.springframework.web.servlet.ModelAndView	displayLookupUsers(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method displays the user lookup screen.
org.springframework.web.servlet.ModelAndView	displayLookupWorkgroups(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method displays the workgroup lookup screen.
org.springframework.web.servlet.ModelAndView	displayNotificationDetail(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This controller handles displaying the appropriate notification details for a specific record.
org.springframework.web.servlet.ModelAndView	displayNotificationsSent(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method handles displaying the notifications that an individual sent.
org.springframework.web.servlet.ModelAndView	displaySearch(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method handles displaying the search screen.
protected boolean	requestIsFromKEW(javax.servlet.http.HttpServletRequest req)
void	setMessageDeliveryService(NotificationMessageDeliveryService messageDeliveryService) Sets the messageDeliveryService attribute value.
void	setNotificationService(NotificationService notificationService) Set the NotificationService
void	setNotificationWorkflowDocumentService(NotificationWorkflowDocumentService s) This method sets the NotificationWorkflowDocumentService

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, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, preventCaching, 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

notificationService

protected NotificationService notificationService

notificationWorkflowDocService

protected NotificationWorkflowDocumentService notificationWorkflowDocService

messageDeliveryService

protected NotificationMessageDeliveryService messageDeliveryService

Constructor Detail

NotificationController

public NotificationController()

Method Detail

setNotificationService

public void setNotificationService(NotificationService notificationService)

Set the NotificationService

Parameters:

notificationService -

setNotificationWorkflowDocumentService

public void setNotificationWorkflowDocumentService(NotificationWorkflowDocumentService s)

This method sets the NotificationWorkflowDocumentService

Parameters:

s -

setMessageDeliveryService

public void setMessageDeliveryService(NotificationMessageDeliveryService messageDeliveryService)

Sets the messageDeliveryService attribute value.

Parameters:

messageDeliveryService - The messageDeliveryService to set.

displayHome

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

Handles the display of the main home page in the system.

Parameters:

request - : a servlet request

response - : a servlet response

Returns:

a ModelAndView object

Throws:

javax.servlet.ServletException - : an exception

IOException - : an exception

displayNotificationsSent

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

This method handles displaying the notifications that an individual sent.

Parameters:

request -

response -

Returns:

ModelAndView

Throws:

javax.servlet.ServletException

IOException

displaySearch

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

This method handles displaying the search screen.

Parameters:

request -

response -

Returns:

ModelAndView

Throws:

javax.servlet.ServletException

IOException

displayLookupUsers

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

This method displays the user lookup screen.

Parameters:

request -

response -

Returns:

Throws:

javax.servlet.ServletException

IOException

displayLookupWorkgroups

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

This method displays the workgroup lookup screen.

Parameters:

request -

response -

Returns:

Throws:

javax.servlet.ServletException

IOException

determineMessageFromRequest

protected NotificationMessageDelivery determineMessageFromRequest(javax.servlet.http.HttpServletRequest request)

This method retrieves the NotificationMessageDelivery given an HttpServletRequest which may contain EITHER a message delivery id or a workflow doc id. Therefore, this is a "special case" for handling the workflow deliverer.

Parameters:

request - the incoming HttpServletRequest

Returns:

the NotificationMessageDelivery or null if not found

requestIsFromKEW

protected boolean requestIsFromKEW(javax.servlet.http.HttpServletRequest req)

Parameters:

req - the HttpServletRequest

Returns:

whether the incoming request was from the action list

displayNotificationDetail

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

This controller handles displaying the appropriate notification details for a specific record.

Parameters:

request - : a servlet request

response - : a servlet response

Returns:

a ModelAndView object

Throws:

javax.servlet.ServletException - : an exception

IOException - : an exception

dismissMessage

public org.springframework.web.servlet.ModelAndView dismissMessage(javax.servlet.http.HttpServletRequest request,
                                                                   javax.servlet.http.HttpServletResponse response)

This method handles user dismissal of a message

Parameters:

request - : a servlet request

response - : a servlet response

Returns:

a ModelAndView object