Interface IJEMHMessageFilterProvider
-
- All Superinterfaces:
IJEMHModuleProvider
public interface IJEMHMessageFilterProvider extends IJEMHModuleProvider
Definition of filters for JEMH.- Author:
- andy
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IJEMHFPAuditEventEntiyDef.ProcessingOutcome
filter(javax.mail.Message message, IJEMHRuntimeConfig config, com.atlassian.jira.service.util.handler.MessageHandlerErrorCollector errorCollector, com.atlassian.jira.issue.Issue issue, IJEMHInboundReport report, com.atlassian.jira.user.ApplicationUser applicableUser)
Execute filter processing on the message.String
getReason()
void
init()
Generic init method to allow setup if neededboolean
isLateRunning()
Returns true if the message filter should be run once a project has been determined.-
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:
- If through normal processing, the message is not to be handled for some reason, the message as to WHY this was decided should be accessible here *
-
init
void init() throws InitFailureException
Generic init method to allow setup if needed- Throws:
InitFailureException
- if it breaks
-
filter
IJEMHFPAuditEventEntiyDef.ProcessingOutcome filter(javax.mail.Message message, IJEMHRuntimeConfig config, com.atlassian.jira.service.util.handler.MessageHandlerErrorCollector errorCollector, com.atlassian.jira.issue.Issue issue, IJEMHInboundReport report, com.atlassian.jira.user.ApplicationUser applicableUser) throws FilterFailureException
Execute filter processing on the message.- Parameters:
message
- The original JavaMail message objectconfig
- The JEMH runtime configuration that is used for this messageerrorCollector
- For UI error feedback relating to the execution of the filter.issue
- , relatedIssueIfAny for context regarding the issue that may be under comment/updatereport
- , enabling filter specific detailed logging- Returns:
- ProcessOutcome describing the filter
- Throws:
FilterFailureException
- if it breaks
-
isLateRunning
boolean isLateRunning()
Returns true if the message filter should be run once a project has been determined.- Returns:
- true if the filter should run late, false otherwise.
-
-