Package org.kuali.rice.ken.web.spring

Class BaseSendNotificationController

java.lang.Object
org.kuali.rice.ken.web.spring.BaseSendNotificationController
Direct Known Subclasses:
SendEventNotificationMessageController, SendNotificationMessageController
public abstract class BaseSendNotificationController extends Object
Base class for KEN controllers for sending notifications
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Field Details

    • notificationService

      @Autowired @Qualifier("notificationService") protected NotificationService notificationService

    • notificationWorkflowDocumentService

      @Autowired @Qualifier("notificationWorkflowDocumentService") protected NotificationWorkflowDocumentService notificationWorkflowDocumentService

    • notificationChannelService

      @Autowired @Qualifier("notificationChannelService") protected NotificationChannelService notificationChannelService

    • notificationRecipientService

      @Autowired @Qualifier("notificationRecipientService") protected NotificationRecipientService notificationRecipientService

    • notificationMessageContentService

      @Autowired @Qualifier("messageContentService") protected NotificationMessageContentService notificationMessageContentService

    • dataObjectService

      @Autowired @Qualifier("dataObjectService") protected DataObjectService dataObjectService

    • identityService

      @Autowired @Qualifier("kimIdentityService") protected org.kuali.rice.kim.api.identity.IdentityService identityService

    • groupService

      @Autowired @Qualifier("kimGroupService") protected org.kuali.rice.kim.api.group.GroupService groupService

    • namespaceService

      @Autowired @Qualifier("namespaceService") protected NamespaceService namespaceService

  • Constructor Details

    • BaseSendNotificationController

      public BaseSendNotificationController()

  • Method Details

    • getParameter

      protected String getParameter(javax.servlet.http.HttpServletRequest request, String parameterName, Map<String,Object> model, ErrorList errors, String errorMessage)

    • getParameter

      protected String getParameter(javax.servlet.http.HttpServletRequest request, String parameterName, Map<String,Object> model, ErrorList errors, String errorMessage, String defaultValue)

    • getParameterList

      protected String[] getParameterList(javax.servlet.http.HttpServletRequest request, String parameterName, Map<String,Object> model, ErrorList errors, String errorMessage)

    • getDate

      protected Date getDate(String parameter, ErrorList errors, String errorMessage)

    • parseUserRecipients

      protected String[] parseUserRecipients(javax.servlet.http.HttpServletRequest request)

    • parseWorkgroupRecipients

      protected String[] parseWorkgroupRecipients(javax.servlet.http.HttpServletRequest request)

    • parseWorkgroupNamespaceCodes

      protected String[] parseWorkgroupNamespaceCodes(javax.servlet.http.HttpServletRequest request)

    • parseCommaSeparatedValues

      protected String[] parseCommaSeparatedValues(javax.servlet.http.HttpServletRequest request, String param)

    • isUserRecipientValid

      protected boolean isUserRecipientValid(String user, ErrorList errors)

    • isWorkgroupRecipientValid

      protected boolean isWorkgroupRecipientValid(String groupName, String namespaceCode, ErrorList errors)

    • getPrincipalIdFromIdOrName

      protected String getPrincipalIdFromIdOrName(String principalIdOrName)

    • submitNotificationMessage

      protected org.springframework.web.servlet.ModelAndView submitNotificationMessage(javax.servlet.http.HttpServletRequest request, String routeMessage, String viewName)
      Submits the actual event notification message.
      Parameters:
      request - the servlet request
      routeMessage - the message to attach to the route action
      viewName - the name of the view to forward to after completion
      Returns:
      the next view to show
      Throws:
      javax.servlet.ServletException
      IOException

    • createNotificationWorkflowDocument

      protected WorkflowDocument createNotificationWorkflowDocument(javax.servlet.http.HttpServletRequest request, String initiatorId, Map<String,Object> model) throws IllegalArgumentException, ErrorList
      Creates a notification WorkflowDocument.
      Parameters:
      request - the servlet request
      initiatorId - the user sending the notification
      model - the Spring MVC model
      Returns:
      a WorkflowDocument for the notification
      Throws:
      IllegalArgumentException
      ErrorList

    • populateNotificationInstance

      protected NotificationBo populateNotificationInstance(javax.servlet.http.HttpServletRequest request, Map<String,Object> model) throws IllegalArgumentException, ErrorList
      Creates a new NotificationBo instance.
      Parameters:
      request - the servlet request
      model - the Spring MVC model
      Returns:
      a new notification
      Throws:
      IllegalArgumentException
      ErrorList

    • createNotification

      protected NotificationBo createNotification(javax.servlet.http.HttpServletRequest request, Map<String,Object> model, ErrorList errors) throws ErrorList
      Provides an overridable method in which to customize a created NotificationBo instance.
      Parameters:
      request - the servlet request
      model - the Spring MVC model
      errors - the error list
      Returns:
      a new notification
      Throws:
      ErrorList

    • setupModelForSendNotification

      protected Map<String,Object> setupModelForSendNotification(javax.servlet.http.HttpServletRequest request)
      Prepares the model used for sending the notification.
      Parameters:
      request - the servlet request
      Returns:
      the Spring MVC model

    • getNotificationService

      public NotificationService getNotificationService()

    • setNotificationService

      public void setNotificationService(NotificationService notificationService)

    • getNotificationWorkflowDocumentService

      public NotificationWorkflowDocumentService getNotificationWorkflowDocumentService()

    • setNotificationWorkflowDocumentService

      public void setNotificationWorkflowDocumentService(NotificationWorkflowDocumentService notificationWorkflowDocumentService)

    • getNotificationChannelService

      public NotificationChannelService getNotificationChannelService()

    • setNotificationChannelService

      public void setNotificationChannelService(NotificationChannelService notificationChannelService)

    • getNotificationRecipientService

      public NotificationRecipientService getNotificationRecipientService()

    • setNotificationRecipientService

      public void setNotificationRecipientService(NotificationRecipientService notificationRecipientService)

    • getNotificationMessageContentService

      public NotificationMessageContentService getNotificationMessageContentService()

    • setNotificationMessageContentService

      public void setNotificationMessageContentService(NotificationMessageContentService notificationMessageContentService)

    • getDataObjectService

      public DataObjectService getDataObjectService()

    • setDataObjectService

      public void setDataObjectService(DataObjectService dataObjectService)

    • getIdentityService

      public org.kuali.rice.kim.api.identity.IdentityService getIdentityService()

    • setIdentityService

      public void setIdentityService(org.kuali.rice.kim.api.identity.IdentityService identityService)

    • getGroupService

      public org.kuali.rice.kim.api.group.GroupService getGroupService()

    • setGroupService

      public void setGroupService(org.kuali.rice.kim.api.group.GroupService groupService)

    • getNamespaceService

      public NamespaceService getNamespaceService()

    • setNamespaceService

      public void setNamespaceService(NamespaceService namespaceService)