Package hudson.plugins.emailext.plugins.trigger

Class AbstractScriptTrigger

java.lang.Object

hudson.plugins.emailext.plugins.EmailTrigger

hudson.plugins.emailext.plugins.trigger.AbstractScriptTrigger

All Implemented Interfaces:

ExtensionPoint, Describable<EmailTrigger>

Direct Known Subclasses:

PreBuildScriptTrigger, ScriptTrigger

public abstract class AbstractScriptTrigger
extends EmailTrigger

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
protected org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SecureGroovyScript	secureTriggerScript
protected String	triggerScript	Deprecated.

Constructor Summary

Constructors

Constructor	Description
AbstractScriptTrigger(boolean sendToList, boolean sendToDevs, boolean sendToRequester, boolean sendToCulprits, String recipientList, String replyTo, String subject, String body, String attachmentsPattern, int attachBuildLog, String contentType, String triggerScript)	Deprecated.
AbstractScriptTrigger(List<RecipientProvider> recipientProviders, String recipientList, String replyTo, String subject, String body, String attachmentsPattern, int attachBuildLog, String contentType, String triggerScript)	Deprecated.
AbstractScriptTrigger(List<RecipientProvider> recipientProviders, String recipientList, String replyTo, String subject, String body, String attachmentsPattern, int attachBuildLog, String contentType, org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SecureGroovyScript secureTriggerScript)

Method Summary

Modifier and Type	Method	Description
boolean	configure(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject formData)
org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SecureGroovyScript	getSecureTriggerScript()
String	getTriggerScript()	Deprecated.
abstract boolean	isPreBuild()	Should this trigger run before the build? Defaults to false.
protected Object	readResolve()	Called when object has been deserialized from a stream.
boolean	trigger(AbstractBuild<?,?> build, TaskListener listener)	Implementors of this method need to return true if the conditions to trigger an email have been met.

Methods inherited from class hudson.plugins.emailext.plugins.EmailTrigger

all, allWatchable, createMailType, createMailType, getDescriptor, getEmail, getNumFailures, setEmail, shouldBypassThrottling

Methods inherited from class java.lang.Object

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

Field Details

secureTriggerScript

protected org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SecureGroovyScript secureTriggerScript

triggerScript

@Deprecated
protected transient String triggerScript

Deprecated.

Constructor Details

AbstractScriptTrigger

public AbstractScriptTrigger(List<RecipientProvider> recipientProviders,
 String recipientList,
 String replyTo,
 String subject,
 String body,
 String attachmentsPattern,
 int attachBuildLog,
 String contentType,
 org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SecureGroovyScript secureTriggerScript)

AbstractScriptTrigger

@Deprecated
public AbstractScriptTrigger(List<RecipientProvider> recipientProviders,
 String recipientList,
 String replyTo,
 String subject,
 String body,
 String attachmentsPattern,
 int attachBuildLog,
 String contentType,
 String triggerScript)
                      throws Descriptor.FormException

Deprecated.

Throws:

Descriptor.FormException

AbstractScriptTrigger

@Deprecated
public AbstractScriptTrigger(boolean sendToList,
 boolean sendToDevs,
 boolean sendToRequester,
 boolean sendToCulprits,
 String recipientList,
 String replyTo,
 String subject,
 String body,
 String attachmentsPattern,
 int attachBuildLog,
 String contentType,
 String triggerScript)

Deprecated.

Method Details

getTriggerScript

@Deprecated
public String getTriggerScript()

Deprecated.

getSecureTriggerScript

public org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SecureGroovyScript getSecureTriggerScript()

configure

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

Overrides:

configure in class EmailTrigger

isPreBuild

public abstract boolean isPreBuild()

Description copied from class: EmailTrigger

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

Overrides:

isPreBuild in class EmailTrigger

Returns:

true if the trigger should be checked before the build.

trigger

public boolean trigger(AbstractBuild<?,?> build,
 TaskListener listener)

Description copied from class: EmailTrigger

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

Specified by:

trigger in class EmailTrigger

Parameters:

build - The Build object after the project has been built

listener - Used for logging to the build log

Returns:

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

readResolve

protected Object readResolve()
                      throws ObjectStreamException,
Descriptor.FormException

Called when object has been deserialized from a stream.

Returns:

this, or a replacement for this.

Throws:

ObjectStreamException - if the object cannot be restored.

Descriptor.FormException

See Also:

• The Java Object Serialization Specification