org.nhindirect.common.tx

Interface TxDetailParser

public interface TxDetailParser

Interface for a parser the transforms a message into a set of Tx details

Since:

1.0

Author:

Greg Meyer

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,TxDetail>	getMessageDetails(java.io.InputStream stream) Processed a MimeMessage represented as an input stream to a set attributes that will be stored as a set of transaction details.
java.util.Map<java.lang.String,TxDetail>	getMessageDetails(javax.mail.internet.InternetHeaders headers) Processed a collection InternetHeaders into a set attributes that will be stored as a set of transaction details.
java.util.Map<java.lang.String,TxDetail>	getMessageDetails(javax.mail.internet.MimeMessage msg) Processed a MimeMessage into set attributes that will be stored as a set of transaction details.

Method Detail

getMessageDetails

java.util.Map<java.lang.String,TxDetail> getMessageDetails(javax.mail.internet.InternetHeaders headers)

Processed a collection InternetHeaders into a set attributes that will be stored as a set of transaction details. Most details will take the same name as their corresponding Mime standard header name.

This method is particularly helpful when dealing with very large messages that are streamed and you do not wish to load the entire message into memory. Instead, only the headers are extracted from the message stream and processed.
NOTE:<\b> Using only message headers will not disable the ability to process some attributes such as MDN dispositions and DNS messages because they need to be parsed from the message body.

Parameters:

headers - The Internet headers to be processed.

Returns:

A map of detail names to values.

getMessageDetails

java.util.Map<java.lang.String,TxDetail> getMessageDetails(java.io.InputStream stream)

Processed a MimeMessage represented as an input stream to a set attributes that will be stored as a set of transaction details. Most details will take the same name as their corresponding Mime standard header name.

Parameters:

stream - The message that will be processed.

Returns:

A map of detail names to values.

getMessageDetails

java.util.Map<java.lang.String,TxDetail> getMessageDetails(javax.mail.internet.MimeMessage msg)

Processed a MimeMessage into set attributes that will be stored as a set of transaction details. Most details will take the same name as their corresponding Mime standard header name.

Parameters:

msg - The message that will be processed.

Returns:

A map of detail names to values.