hudson.plugins.emailext.plugins

Class EmailTrigger

java.lang.Object

hudson.plugins.emailext.plugins.EmailTrigger

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<EmailTrigger>

Direct Known Subclasses:

AbortedTrigger, AbstractScriptTrigger, BuildingTrigger, FailureTrigger, FixedTrigger, ImprovementTrigger, NotBuiltTrigger, NthFailureTrigger, PreBuildTrigger, RegressionTrigger, StillFailingTrigger, StillUnstableTrigger, SuccessTrigger, UnstableTrigger

public abstract class EmailTrigger
extends Object
implements hudson.model.Describable<EmailTrigger>, hudson.ExtensionPoint

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EmailTrigger(boolean sendToList, boolean sendToDevs, boolean sendToRequestor, String recipientList, String replyTo, String subject, String body, String attachmentsPattern, int attachBuildLog)
protected	EmailTrigger(net.sf.json.JSONObject formData)

Method Summary

Methods

Modifier and Type	Method and Description
static hudson.DescriptorExtensionList<EmailTrigger,EmailTriggerDescriptor>	all()
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
protected EmailType	createMailType(net.sf.json.JSONObject formData)
EmailTriggerDescriptor	getDescriptor()
EmailType	getEmail() Get the email that is with this trigger.
protected int	getNumFailures(hudson.model.AbstractBuild<?,?> build) Determine the number of direct failures in the given build.
boolean	isPreBuild() Should this trigger run before the build? Defaults to false.
void	setEmail(EmailType email)
abstract boolean	trigger(hudson.model.AbstractBuild<?,?> build, hudson.model.TaskListener listener) Implementors of this method need to return true if the conditions to trigger an email have been met.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailTrigger

protected EmailTrigger(boolean sendToList,
            boolean sendToDevs,
            boolean sendToRequestor,
            String recipientList,
            String replyTo,
            String subject,
            String body,
            String attachmentsPattern,
            int attachBuildLog)

EmailTrigger

protected EmailTrigger(net.sf.json.JSONObject formData)

Method Detail

all

public static hudson.DescriptorExtensionList<EmailTrigger,EmailTriggerDescriptor> all()

trigger

public abstract boolean trigger(hudson.model.AbstractBuild<?,?> build,
              hudson.model.TaskListener listener)

Implementors of this method need to return true if the conditions to trigger an email have been met.

Parameters:

build - The Build object after the project has been built

Returns:

true if the conditions have been met to trigger a build of this type

getEmail

public EmailType getEmail()

Get the email that is with this trigger.

Returns:

the email

setEmail

public void setEmail(EmailType email)

getDescriptor

public EmailTriggerDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<EmailTrigger>

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                net.sf.json.JSONObject formData)

getNumFailures

protected int getNumFailures(hudson.model.AbstractBuild<?,?> build)

Determine the number of direct failures in the given build. If it aggregates downstream results, ignore contributed failures. This is because at the time this trigger runs, the current build's aggregated results aren't available yet, but those of the previous build may be.

isPreBuild

public boolean isPreBuild()

Should this trigger run before the build? Defaults to false.

createMailType

protected EmailType createMailType(net.sf.json.JSONObject formData)