com.adaptris.util.text.mime

Class SelectByHeader

java.lang.Object

com.adaptris.util.text.mime.SelectByHeader

All Implemented Interfaces:

PartSelector

public class SelectByHeader
extends java.lang.Object
implements PartSelector

PartSelector implementation that parses a specific header examining the value to see if it matches the configured regular expression.

In the adapter configuration file this class is aliased as mime-select-by-header which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor and Description
SelectByHeader()
SelectByHeader(java.lang.String header, java.lang.String regexp)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHeaderName()
java.lang.String	getHeaderValueRegExp()
javax.mail.internet.MimeBodyPart	select(BodyPartIterator m) Select the body part that should form the AdaptrisMessage payload.
java.util.List<javax.mail.internet.MimeBodyPart>	select(javax.mail.internet.MimeMultipart in) Select the body part that should form the AdaptrisMessage payload.
void	setHeaderName(java.lang.String s) Specify the header name whose value will be examined .
void	setHeaderValueRegExp(java.lang.String s) Set the value of the regular expression that will be used to match against the header value.

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectByHeader

public SelectByHeader()

SelectByHeader

public SelectByHeader(java.lang.String header,
                      java.lang.String regexp)

Method Detail

select

public javax.mail.internet.MimeBodyPart select(BodyPartIterator m)
                                        throws javax.mail.MessagingException

Description copied from interface: PartSelector

Select the body part that should form the AdaptrisMessage payload.

Specified by:

select in interface PartSelector

Returns:

the MimeBodyPart that should be the body, or null if no match found.

Throws:

javax.mail.MessagingException

select

public java.util.List<javax.mail.internet.MimeBodyPart> select(javax.mail.internet.MimeMultipart in)
                                                        throws javax.mail.MessagingException

Description copied from interface: PartSelector

Select the body part that should form the AdaptrisMessage payload.

Specified by:

select in interface PartSelector

Parameters:

in - a MimeMultipart

Returns:

a list of MimeBodyPart that should be the body, empty if no match found.

Throws:

javax.mail.MessagingException

getHeaderName

public java.lang.String getHeaderName()

Returns:

the headerName

setHeaderName

public void setHeaderName(java.lang.String s)

Specify the header name whose value will be examined .

Parameters:

s - the headerName to set, e.g. "Content-Type"

getHeaderValueRegExp

public java.lang.String getHeaderValueRegExp()

Returns:

the headerValueRegExp

setHeaderValueRegExp

public void setHeaderValueRegExp(java.lang.String s)

Set the value of the regular expression that will be used to match against the header value.

Parameters:

s - the headerValueRegExp to set