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:

NotificationMessageContentService

Method Summary

Modifier and Type	Method and Description
String	generateNotificationMessage(NotificationBo notification) This method is responsible for marshalling out the passed in Notification object in and XML representation.
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.
String	generateNotificationResponseMessage(NotificationResponseBo response) Generates a Notification response message
NotificationBo	parseNotificationRequestMessage(InputStream stream) Parses a Notification request message into business objects.
NotificationBo	parseNotificationRequestMessage(String notificationMessageAsXml) Parses a Notification request message into business objects.
NotificationBo	parseSerializedNotificationXml(byte[] xmlAsBytes) This method parses out the serialized XML version of Notification BO and populates a Notification BO with it.

Method Detail

parseNotificationRequestMessage

NotificationBo parseNotificationRequestMessage(InputStream stream)
                                        throws IOException,
                                               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

XmlException

parseNotificationRequestMessage

NotificationBo parseNotificationRequestMessage(String notificationMessageAsXml)
                                        throws IOException,
                                               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

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