org.kuali.rice.ken.service.impl
Class NotificationMessageContentServiceImpl

java.lang.Object
  org.kuali.rice.ken.service.impl.NotificationMessageContentServiceImpl

All Implemented Interfaces:

NotificationMessageContentService

public class NotificationMessageContentServiceImpl
extends Object
implements NotificationMessageContentService

NotificationMessageContentService implementation - uses both Xalan and XStream in various places to manage the marshalling/unmarshalling of Notification data for processing by various components in the system.

Author:

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

See Also:

NotificationMessageContentService

Field Summary

private GenericDao	boDao Our BusinessObjectDao persistence layer
(package private) static String	CONTENT_TYPE_NAMESPACE_PREFIX Prefix that content type schemas should start with
private static DateFormat	DATEFORMAT_CURR_TZ
private static org.apache.log4j.Logger	LOG
private NotificationContentTypeService	notificationContentTypeService NotificationContentTypeService impl

Constructor Summary

NotificationMessageContentServiceImpl(GenericDao boDao, NotificationContentTypeService notificationContentTypeService)
Constructor which takes a GenericDao Constructs a NotificationMessageContentServiceImpl.java.

Method Summary

String	generateNotificationMessage(Notification notification) This method will marshall out the Notification object as a String of XML, using XStream.
String	generateNotificationMessage(Notification notification, String userRecipientId) This method will marshall out the Notification object as a String of XML, using XStream and replaces the full recipient list with just a single recipient.
String	generateNotificationResponseMessage(NotificationResponse response) This method will marshall out the NotificationResponse object as a String of XML, using XStream.
private Notification	parseNotificationRequestMessage(byte[] bytes) This method is the meat of the notification message parsing.
Notification	parseNotificationRequestMessage(InputStream stream) This method implements by taking in an InputStream and then coverting that to a byte[].
Notification	parseNotificationRequestMessage(String notificationMessageAsXml) This method implements by taking in a String and then converting that to a byte[];
Notification	parseSerializedNotificationXml(byte[] xmlAsBytes) Uses XPath to parse out the serialized Notification xml into a Notification instance.
private void	validateContent(Notification notification, String contentType, Element contentElement, String content) This method validates the content of a notification message by matching up the namespace of the expected content type to the actual namespace that is passed in as part of the XML message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

private static final org.apache.log4j.Logger LOG

CONTENT_TYPE_NAMESPACE_PREFIX

static final String CONTENT_TYPE_NAMESPACE_PREFIX

Prefix that content type schemas should start with

See Also:

Constant Field Values

DATEFORMAT_CURR_TZ

private static final DateFormat DATEFORMAT_CURR_TZ

boDao

private GenericDao boDao

Our BusinessObjectDao persistence layer

notificationContentTypeService

private NotificationContentTypeService notificationContentTypeService

NotificationContentTypeService impl

Constructor Detail

NotificationMessageContentServiceImpl

public NotificationMessageContentServiceImpl(GenericDao boDao,
                                             NotificationContentTypeService notificationContentTypeService)

Constructor which takes a GenericDao Constructs a NotificationMessageContentServiceImpl.java.

Parameters:

boDao -

Method Detail

parseNotificationRequestMessage

public Notification parseNotificationRequestMessage(String notificationMessageAsXml)
                                             throws IOException,
                                                    InvalidXMLException

This method implements by taking in a String and then converting that to a byte[];

Specified by:

parseNotificationRequestMessage in interface NotificationMessageContentService

Returns:

Throws:

IOException

InvalidXMLException

See Also:

NotificationMessageContentService.parseNotificationRequestMessage(java.lang.String)

parseNotificationRequestMessage

public Notification parseNotificationRequestMessage(InputStream stream)
                                             throws IOException,
                                                    InvalidXMLException

This method implements by taking in an InputStream and then coverting that to a byte[].

Specified by:

parseNotificationRequestMessage in interface NotificationMessageContentService

Parameters:

stream - request message stream

Returns:

Notification business object

Throws:

IOException

InvalidXMLException

See Also:

NotificationMessageContentService.parseNotificationRequestMessage(java.io.InputStream)

parseNotificationRequestMessage

private Notification parseNotificationRequestMessage(byte[] bytes)
                                              throws IOException,
                                                     InvalidXMLException

This method is the meat of the notification message parsing. It uses DOM to parse out the notification message XML and into a Notification BO. It handles lookup of reference objects' primary keys so that it can properly populate the notification object.

Parameters:

bytes -

Returns:

Notification

Throws:

IOException

InvalidXMLException

validateContent

private void validateContent(Notification notification,
                             String contentType,
                             Element contentElement,
                             String content)
                      throws IOException,
                             InvalidXMLException

This method validates the content of a notification message by matching up the namespace of the expected content type to the actual namespace that is passed in as part of the XML message. This is possibly redundant because we are using qualified XPath expressions to obtain content under the correct namespace.

Parameters:

notification -

contentType -

contentElement -

content -

Throws:

IOException

InvalidXMLException

generateNotificationResponseMessage

public String generateNotificationResponseMessage(NotificationResponse response)

This method will marshall out the NotificationResponse object as a String of XML, using XStream.

Specified by:

generateNotificationResponseMessage in interface NotificationMessageContentService

Returns:

String XML representation of a Notification response object

See Also:

NotificationMessageContentService.generateNotificationResponseMessage(org.kuali.rice.ken.bo.NotificationResponse)

generateNotificationMessage

public String generateNotificationMessage(Notification notification,
                                          String userRecipientId)

This method will marshall out the Notification object as a String of XML, using XStream and replaces the full recipient list with just a single recipient.

Specified by:

generateNotificationMessage in interface NotificationMessageContentService

Returns:

String of XML.

See Also:

NotificationMessageContentService.generateNotificationMessage(org.kuali.rice.ken.bo.Notification, java.lang.String)

generateNotificationMessage

public String generateNotificationMessage(Notification notification)

This method will marshall out the Notification object as a String of XML, using XStream.

Specified by:

generateNotificationMessage in interface NotificationMessageContentService

Returns:

String of XML.

See Also:

NotificationMessageContentService.generateNotificationMessage(org.kuali.rice.ken.bo.Notification)

parseSerializedNotificationXml

public Notification parseSerializedNotificationXml(byte[] xmlAsBytes)
                                            throws Exception

Uses XPath to parse out the serialized Notification xml into a Notification instance. Warning: this method does NOT validate the payload content XML

Specified by:

parseSerializedNotificationXml in interface NotificationMessageContentService

Returns:

Notification

Throws:

Exception

See Also:

org.kuali.rice.ken.service.NotificationMessageContentService#parseNotificationXml(byte[])