Package org.kuali.rice.ken.service

Interface NotificationMessageContentService

All Known Implementing Classes:
NotificationMessageContentServiceImpl
public interface NotificationMessageContentService
Notification Message Content service - handles parsing the notification XML message and also marshalling out BOs for the response.
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Method Details

    • parseNotificationRequestMessage

      NotificationBo parseNotificationRequestMessage(InputStream stream) throws IOException, org.kuali.rice.core.api.util.xml.XmlException
      Parses a Notification request message into business objects. Performs syntactic and semantic validation. This method takes an InputStream.
      Parameters:
      stream - request message stream
      Returns:
      Notification business object
      Throws:
      SAXException
      ParserConfigurationException
      IOException
      org.kuali.rice.core.api.util.xml.XmlException

    • parseNotificationRequestMessage

      NotificationBo parseNotificationRequestMessage(String notificationMessageAsXml) throws IOException, org.kuali.rice.core.api.util.xml.XmlException
      Parses a Notification request message into business objects. Performs syntactic and semantic validation. This method takes a String of XML.
      Parameters:
      notificationMessageAsXml -
      Returns:
      Throws:
      IOException
      org.kuali.rice.core.api.util.xml.XmlException

    • generateNotificationResponseMessage

      String generateNotificationResponseMessage(NotificationResponseBo response)
      Generates a Notification response message
      Parameters:
      response -
      Returns:
      String XML representation of a Notification response object

    • generateNotificationMessage

      String generateNotificationMessage(NotificationBo notification)
      This method is responsible for marshalling out the passed in Notification object in and XML representation.
      Parameters:
      notification -
      Returns:
      String of XML.

    • generateNotificationMessage

      String generateNotificationMessage(NotificationBo notification, String userRecipientId)
      This method is responsible for marshalling out the passed in Notification object in and XML representation, with the addition of adding the specific recipient to the recipients list and removing the others.
      Parameters:
      notification -
      userRecipientId -
      Returns:
      String of XML.

    • parseSerializedNotificationXml

      NotificationBo parseSerializedNotificationXml(byte[] xmlAsBytes) throws Exception
      This method parses out the serialized XML version of Notification BO and populates a Notification BO with it.
      Parameters:
      xmlAsBytes -
      Returns:
      Notification
      Throws:
      Exception