Package com.javahollic.jira.emh.api.extension.attfilter

Interface IJEMHAttachmentFilterProvider

All Superinterfaces:

IJEMHModuleProvider

public interface IJEMHAttachmentFilterProvider
extends IJEMHModuleProvider

Definition of attachment filters for JEMH.

Author:

andy

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IJEMHAttachmentFilterProvider.AttachmentOutcome	use means use the given attachment filter means ignore the given attachment replace means replace the given attachment with a potentially mutated one

Field Summary

Fields

Modifier and Type	Field	Description
static String	UTF8

Method Summary

Modifier and Type	Method	Description
IJEMHAttachmentFilterProvider.AttachmentOutcome	filter(javax.mail.Message message, IJEMHRuntimeConfig config, IJEMHInboundReport report, com.atlassian.mail.MailUtils.Attachment attachment)	Execute filter processing on the message.
String	getReason()
void	init()	Generic init method to allow setup if needed

Methods inherited from interface com.javahollic.jira.emh.api.extension.IJEMHModuleProvider

getDescription, getKey, getName, getStatus, getVendor, getVendorUrl, isUsable

Field Detail

UTF8

static final String UTF8

See Also:

Constant Field Values

Method Detail

getReason

String getReason()

Returns:

reason for filter

init

void init()
   throws InitFailureException

Generic init method to allow setup if needed

Throws:

InitFailureException - if it breaks

filter

IJEMHAttachmentFilterProvider.AttachmentOutcome filter(javax.mail.Message message,
                                                       IJEMHRuntimeConfig config,
                                                       IJEMHInboundReport report,
                                                       com.atlassian.mail.MailUtils.Attachment attachment)
                                                throws AttFilterFailureException

Execute filter processing on the message.

Parameters:

message - The original JavaMail message object

config - The JEMH runtime configuration that is used for this message

report - , enabling filter specific detailed logging

attachment - to filter or not

Returns:

AttachmentOutcome describing the filter outcome

Throws:

AttFilterFailureException - if it breaks