org.nhindirect.common.tx

Interface TxService

public interface TxService

Interface for message monitoring/tracking. The monitoring system watches for notification messages (DSN and MDN) to determine if a failure notification needs to be send if no notifications are received within a give time period.

The monitoring system executes basic processing business logic such as parsing a message into a set of attributes, location relevant information that needs to be transformed into monitoring details, and correlating messages together based on linkable headers such as In-Reply-To.

Since:

1.0

Author:

Greg Meyer

Method Summary

Modifier and Type	Method and Description
boolean	suppressNotification(javax.mail.internet.MimeMessage msg) Indicates if a notification message should be suppressed from being delivered to the original message edge client based on existing notifications being received, if the original message is subject to the timely and reliable guidance, and other policies based on a specific HISP implementation.
boolean	suppressNotification(org.nhindirect.common.tx.model.Tx notificationMessage) Indicates if a notification message should be suppressed from being delivered to the original message edge client based on existing notifications being received, if the original message is subject to the timely and reliable guidance, and other policies based on a specific HISP implementation.
void	trackMessage(javax.mail.internet.InternetHeaders headers) Tracks a message as a set of Internet headers
void	trackMessage(javax.mail.internet.MimeMessage msg) Tracks a message in a MimeMessage format
void	trackMessage(org.nhindirect.common.tx.model.Tx tx) Tracks a message as a pre parsed Tx object

Method Detail

trackMessage

void trackMessage(javax.mail.internet.MimeMessage msg)
           throws org.nhindirect.common.rest.exceptions.ServiceException

Tracks a message in a MimeMessage format

Parameters:

msg - The message to track

Throws:

org.nhindirect.common.rest.exceptions.ServiceException

trackMessage

void trackMessage(javax.mail.internet.InternetHeaders headers)
           throws org.nhindirect.common.rest.exceptions.ServiceException

Tracks a message as a set of Internet headers

Parameters:

headers - The message to track

Throws:

org.nhindirect.common.rest.exceptions.ServiceException

trackMessage

void trackMessage(org.nhindirect.common.tx.model.Tx tx)
           throws org.nhindirect.common.rest.exceptions.ServiceException

Tracks a message as a pre parsed Tx object

Parameters:

tx - The message to track

Throws:

org.nhindirect.common.rest.exceptions.ServiceException

suppressNotification

boolean suppressNotification(javax.mail.internet.MimeMessage msg)
                      throws org.nhindirect.common.rest.exceptions.ServiceException

Indicates if a notification message should be suppressed from being delivered to the original message edge client based on existing notifications being received, if the original message is subject to the timely and reliable guidance, and other policies based on a specific HISP implementation.

Parameters:

msg - The notification message. If the message is not a notification message, false will be returned.

Returns:

True if the notification message should be suppressed and not delivered to original edge client.

Throws:

org.nhindirect.common.rest.exceptions.ServiceException

suppressNotification

boolean suppressNotification(org.nhindirect.common.tx.model.Tx notificationMessage)
                      throws org.nhindirect.common.rest.exceptions.ServiceException

Indicates if a notification message should be suppressed from being delivered to the original message edge client based on existing notifications being received, if the original message is subject to the timely and reliable guidance, and other policies based on a specific HISP implementation.

Parameters:

notificationMessage - Pre-parsed Tx object of the notification message.

Returns:

True if the notification message should be suppressed and not delivered to original edge client.

Throws:

org.nhindirect.common.rest.exceptions.ServiceException