|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.BaseSendNotificationController
public class BaseSendNotificationController
Base class for KEN controllers for sending notifications
Field Summary | |
---|---|
protected DataObjectService |
dataObjectService
|
protected NotificationChannelService |
notificationChannelService
|
protected NotificationMessageContentService |
notificationMessageContentService
|
protected NotificationRecipientService |
notificationRecipientService
|
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 | |
---|---|
BaseSendNotificationController()
|
Method Summary | |
---|---|
protected NotificationBo |
createNotification(javax.servlet.http.HttpServletRequest request,
Map<String,Object> model,
ErrorList errors)
Provides an overridable method in which to customize a created NotificationBo instance. |
protected WorkflowDocument |
createNotificationWorkflowDocument(javax.servlet.http.HttpServletRequest request,
String initiatorId,
Map<String,Object> model)
Creates a notification WorkflowDocument . |
protected Date |
getDate(String parameter,
ErrorList errors,
String errorMessage)
|
protected static GroupService |
getGroupService()
|
protected static IdentityService |
getIdentityService()
|
protected static NamespaceService |
getNamespaceService()
|
protected String |
getParameter(javax.servlet.http.HttpServletRequest request,
String parameterName,
Map<String,Object> model,
ErrorList errors,
String errorMessage)
|
protected String |
getParameter(javax.servlet.http.HttpServletRequest request,
String parameterName,
Map<String,Object> model,
ErrorList errors,
String errorMessage,
String defaultValue)
|
protected String[] |
getParameterList(javax.servlet.http.HttpServletRequest request,
String parameterName,
Map<String,Object> model,
ErrorList errors,
String errorMessage)
|
protected String |
getPrincipalIdFromIdOrName(String principalIdOrName)
|
protected boolean |
isUserRecipientValid(String user,
ErrorList errors)
|
protected boolean |
isWorkgroupRecipientValid(String groupName,
String namespaceCode,
ErrorList errors)
|
protected String[] |
parseCommaSeparatedValues(javax.servlet.http.HttpServletRequest request,
String param)
|
protected String[] |
parseUserRecipients(javax.servlet.http.HttpServletRequest request)
|
protected String[] |
parseWorkgroupNamespaceCodes(javax.servlet.http.HttpServletRequest request)
|
protected String[] |
parseWorkgroupRecipients(javax.servlet.http.HttpServletRequest request)
|
protected NotificationBo |
populateNotificationInstance(javax.servlet.http.HttpServletRequest request,
Map<String,Object> model)
Creates a new NotificationBo instance. |
void |
setDataObjectService(DataObjectService dataObjectService)
Sets the businessObjectDao attribute value. |
void |
setNotificationChannelService(NotificationChannelService notificationChannelService)
Sets the NotificationChannelService . |
void |
setNotificationMessageContentService(NotificationMessageContentService notificationMessageContentService)
Sets the NotificationMessageContentService . |
void |
setNotificationRecipientService(NotificationRecipientService notificationRecipientService)
Sets the NotificationRecipientService . |
void |
setNotificationService(NotificationService notificationService)
Sets the NotificationService . |
void |
setNotificationWorkflowDocumentService(NotificationWorkflowDocumentService notificationWorkflowDocService)
Sets the NotificationWorkflowDocumentService . |
protected Map<String,Object> |
setupModelForSendNotification(javax.servlet.http.HttpServletRequest request)
Prepares the model used for sending the notification. |
protected org.springframework.web.servlet.ModelAndView |
submitNotificationMessage(javax.servlet.http.HttpServletRequest request,
String routeMessage,
String viewName)
Submits the actual event notification message. |
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 |
---|
protected NotificationService notificationService
protected NotificationWorkflowDocumentService notificationWorkflowDocService
protected NotificationChannelService notificationChannelService
protected NotificationRecipientService notificationRecipientService
protected NotificationMessageContentService notificationMessageContentService
protected DataObjectService dataObjectService
Constructor Detail |
---|
public BaseSendNotificationController()
Method Detail |
---|
protected static IdentityService getIdentityService()
protected static GroupService getGroupService()
protected static NamespaceService getNamespaceService()
public void setNotificationService(NotificationService notificationService)
NotificationService
.
notificationService
- the service to setpublic void setNotificationWorkflowDocumentService(NotificationWorkflowDocumentService notificationWorkflowDocService)
NotificationWorkflowDocumentService
.
notificationWorkflowDocService
- the service to setpublic void setNotificationChannelService(NotificationChannelService notificationChannelService)
NotificationChannelService
.
notificationChannelService
- the service to setpublic void setNotificationRecipientService(NotificationRecipientService notificationRecipientService)
NotificationRecipientService
.
notificationRecipientService
- the service to setpublic void setNotificationMessageContentService(NotificationMessageContentService notificationMessageContentService)
NotificationMessageContentService
.
notificationMessageContentService
- the service to setpublic void setDataObjectService(DataObjectService dataObjectService)
dataObjectService
- the service to setprotected String getParameter(javax.servlet.http.HttpServletRequest request, String parameterName, Map<String,Object> model, ErrorList errors, String errorMessage)
protected String getParameter(javax.servlet.http.HttpServletRequest request, String parameterName, Map<String,Object> model, ErrorList errors, String errorMessage, String defaultValue)
protected String[] getParameterList(javax.servlet.http.HttpServletRequest request, String parameterName, Map<String,Object> model, ErrorList errors, String errorMessage)
protected Date getDate(String parameter, ErrorList errors, String errorMessage)
protected String[] parseUserRecipients(javax.servlet.http.HttpServletRequest request)
protected String[] parseWorkgroupRecipients(javax.servlet.http.HttpServletRequest request)
protected String[] parseWorkgroupNamespaceCodes(javax.servlet.http.HttpServletRequest request)
protected String[] parseCommaSeparatedValues(javax.servlet.http.HttpServletRequest request, String param)
protected boolean isUserRecipientValid(String user, ErrorList errors)
protected boolean isWorkgroupRecipientValid(String groupName, String namespaceCode, ErrorList errors)
protected String getPrincipalIdFromIdOrName(String principalIdOrName)
protected org.springframework.web.servlet.ModelAndView submitNotificationMessage(javax.servlet.http.HttpServletRequest request, String routeMessage, String viewName) throws javax.servlet.ServletException, IOException
request
- the servlet requestrouteMessage
- the message to attach to the route actionviewName
- the name of the view to forward to after completion
javax.servlet.ServletException
IOException
protected WorkflowDocument createNotificationWorkflowDocument(javax.servlet.http.HttpServletRequest request, String initiatorId, Map<String,Object> model) throws IllegalArgumentException, ErrorList
WorkflowDocument
.
request
- the servlet requestinitiatorId
- the user sending the notificationmodel
- the Spring MVC model
WorkflowDocument
for the notification
IllegalArgumentException
ErrorList
protected NotificationBo populateNotificationInstance(javax.servlet.http.HttpServletRequest request, Map<String,Object> model) throws IllegalArgumentException, ErrorList
NotificationBo
instance.
request
- the servlet requestmodel
- the Spring MVC model
IllegalArgumentException
ErrorList
protected NotificationBo createNotification(javax.servlet.http.HttpServletRequest request, Map<String,Object> model, ErrorList errors) throws ErrorList
NotificationBo
instance.
request
- the servlet requestmodel
- the Spring MVC modelerrors
- the error list
ErrorList
protected Map<String,Object> setupModelForSendNotification(javax.servlet.http.HttpServletRequest request)
request
- the servlet request
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |