Package org.jenkinsci.plugins.pollmailboxtrigger

Class PollMailboxTrigger

java.lang.Object

hudson.triggers.Trigger<BuildableItem>

org.jenkinsci.lib.xtrigger.AbstractTrigger

org.jenkinsci.plugins.scripttrigger.AbstractTriggerExt

org.jenkinsci.plugins.pollmailboxtrigger.PollMailboxTrigger

All Implemented Interfaces:

ExtensionPoint, Describable<Trigger<?>>, Serializable

public class PollMailboxTrigger
extends AbstractTriggerExt

Author:

Nick Grealy

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	PollMailboxTrigger.InternalPollMailboxTriggerAction
static class	PollMailboxTrigger.PollMailboxTriggerDescriptor
static enum	PollMailboxTrigger.Properties

Nested classes/interfaces inherited from class hudson.triggers.Trigger

Trigger.Cron

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATE_FORMAT_TEXT
static final int	ONE_DAY_IN_MINUTES
static final int	PORT_IMAP
static final int	PORT_IMAPS
static final int	PORT_POP3
static final int	PORT_POP3S
static final String	STORE_IMAP
static final String	STORE_IMAPS
static final String	STORE_POP3
static final String	STORE_POP3S
static final String	TEST_JOB_START_MODE

Fields inherited from class org.jenkinsci.lib.xtrigger.AbstractTrigger

LOGGER, offlineSlaveOnStartup

Fields inherited from class hudson.triggers.Trigger

CRON_THRESHOLD, job, spec, tabs, timer

Constructor Summary

Constructors

Constructor	Description
PollMailboxTrigger(String cronTabSpec, LabelRestrictionClass labelRestriction, boolean enableConcurrentBuild, String host, String username, Secret password, String script, String attachments)

Method Summary

Modifier and Type	Method	Description
static String	buildEmailRetryLink(CustomProperties properties)
static FormValidation	checkForEmails(CustomProperties properties, org.jenkinsci.lib.xtrigger.XTriggerLog logger, boolean testConnection, PollMailboxTrigger pmt)
protected boolean	checkIfModified(Node executingNode, org.jenkinsci.lib.xtrigger.XTriggerLog log)
String	getAttachments()
protected String	getDefaultMessageCause()
PollMailboxTrigger.PollMailboxTriggerDescriptor	getDescriptor()
String	getHost()
protected AbstractProject	getJob()
protected File	getLogFile()
protected String	getName()
Secret	getPassword()
Collection<? extends Action>	getProjectActions()
protected List<Action>	getScheduledXTriggerActions(org.jenkinsci.lib.xtrigger.XTriggerLog log)
String	getScript()
String	getUsername()
static CustomProperties	initialiseDefaults(String pHost, String pUsername, Secret password, String pScript, String attachments)
void	setAttachments(String attachments)
void	setHost(String host)
void	setPassword(Secret password)
void	setScript(String script)
void	setUsername(String username)
protected void	startJob(org.jenkinsci.lib.xtrigger.XTriggerLog log, String jobTriggerCause, Map<String,String> envVars)

Methods inherited from class org.jenkinsci.plugins.scripttrigger.AbstractTriggerExt

getCause, getScheduledActions, isEnableConcurrentBuild, isLabelRestriction, requiresWorkspaceForPolling, start

Methods inherited from class org.jenkinsci.lib.xtrigger.AbstractTrigger

checkIfModified, getBuildCause, getScheduledXTriggerActions, getTriggerLabel, requirePollingNode, resolveEnvVars, run, start

Methods inherited from class hudson.triggers.Trigger

all, checkTriggers, for_, getProjectAction, getSpec, readResolve, stop, toString

Methods inherited from class java.lang.Object

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

Field Details

DATE_FORMAT_TEXT

public static final String DATE_FORMAT_TEXT

See Also:

• Constant Field Values

ONE_DAY_IN_MINUTES

public static final int ONE_DAY_IN_MINUTES

See Also:

• Constant Field Values

PORT_IMAP

public static final int PORT_IMAP

See Also:

• Constant Field Values

PORT_IMAPS

public static final int PORT_IMAPS

See Also:

• Constant Field Values

PORT_POP3

public static final int PORT_POP3

See Also:

• Constant Field Values

PORT_POP3S

public static final int PORT_POP3S

See Also:

• Constant Field Values

STORE_IMAP

public static final String STORE_IMAP

See Also:

• Constant Field Values

STORE_IMAPS

public static final String STORE_IMAPS

See Also:

• Constant Field Values

STORE_POP3

public static final String STORE_POP3

See Also:

• Constant Field Values

STORE_POP3S

public static final String STORE_POP3S

See Also:

• Constant Field Values

TEST_JOB_START_MODE

public static final String TEST_JOB_START_MODE

See Also:

• Constant Field Values

Constructor Details

PollMailboxTrigger

@DataBoundConstructor
public PollMailboxTrigger(String cronTabSpec,
 LabelRestrictionClass labelRestriction,
 boolean enableConcurrentBuild,
 String host,
 String username,
 Secret password,
 String script,
 String attachments)
                   throws ANTLRException

Throws:

ANTLRException

Method Details

initialiseDefaults

public static CustomProperties initialiseDefaults(String pHost,
 String pUsername,
 Secret password,
 String pScript,
 String attachments)

checkForEmails

public static FormValidation checkForEmails(CustomProperties properties,
 org.jenkinsci.lib.xtrigger.XTriggerLog logger,
 boolean testConnection,
 PollMailboxTrigger pmt)

buildEmailRetryLink

public static String buildEmailRetryLink(CustomProperties properties)

getHost

public String getHost()

setHost

public void setHost(String host)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getPassword

public Secret getPassword()

setPassword

public void setPassword(Secret password)

getScript

public String getScript()

setScript

public void setScript(String script)

getAttachments

public String getAttachments()

setAttachments

public void setAttachments(String attachments)

getProjectActions

public Collection<? extends Action> getProjectActions()

Overrides:

getProjectActions in class Trigger<BuildableItem>

getName

protected String getName()

Overrides:

getName in class AbstractTriggerExt

getDescriptor

public PollMailboxTrigger.PollMailboxTriggerDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<Trigger<?>>

Overrides:

getDescriptor in class org.jenkinsci.lib.xtrigger.AbstractTrigger

getLogFile

protected File getLogFile()

Specified by:

getLogFile in class org.jenkinsci.lib.xtrigger.AbstractTrigger

getDefaultMessageCause

protected String getDefaultMessageCause()

Specified by:

getDefaultMessageCause in class AbstractTriggerExt

checkIfModified

protected boolean checkIfModified(Node executingNode,
 org.jenkinsci.lib.xtrigger.XTriggerLog log)

Specified by:

checkIfModified in class org.jenkinsci.lib.xtrigger.AbstractTrigger

startJob

protected void startJob(org.jenkinsci.lib.xtrigger.XTriggerLog log,
 String jobTriggerCause,
 Map<String,String> envVars)
                 throws Throwable

Throws:

Throwable

getJob

protected AbstractProject getJob()

getScheduledXTriggerActions

protected List<Action> getScheduledXTriggerActions(org.jenkinsci.lib.xtrigger.XTriggerLog log)
                                            throws org.jenkinsci.lib.xtrigger.XTriggerException

Throws:

org.jenkinsci.lib.xtrigger.XTriggerException