Package hudson.triggers

Class Trigger<J extends Item>

java.lang.Object

hudson.triggers.Trigger<J>

All Implemented Interfaces:

ExtensionPoint, Describable<Trigger<?>>

Direct Known Subclasses:

ReverseBuildTrigger, SCMTrigger, TimerTrigger

public abstract class Trigger<J extends Item>
extends Object
implements Describable<Trigger<?>>, ExtensionPoint

Triggers a Build.

To register a custom Trigger from a plugin, put Extension on your TriggerDescriptor class.

Author:

Kohsuke Kawaguchi

See Also:

TriggeredItem

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Trigger.Cron	Runs every minute to check TimerTrigger and schedules build.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static long	CRON_THRESHOLD	Used to be milliseconds, now is seconds since Jenkins 2.289.
protected J	job
protected String	spec
protected CronTabList	tabs
static Timer	timer	Deprecated. Use Timer.get() instead.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Trigger()	Creates a new Trigger without using cron.
protected	Trigger(String cronTabSpec)	Creates a new Trigger that gets run periodically.

Method Summary

Modifier and Type	Method	Description
static DescriptorExtensionList<Trigger<?>,TriggerDescriptor>	all()	Returns all the registered Trigger descriptors.
static void	checkTriggers(Calendar cal)
static List<TriggerDescriptor>	for_(Item i)	Returns a subset of TriggerDescriptors that applies to the given item.
TriggerDescriptor	getDescriptor()	Gets the descriptor for this instance.
Action	getProjectAction()	Deprecated. as of 1.341 Use getProjectActions() instead.
Collection<? extends Action>	getProjectActions()	Actions to be displayed in the job page.
String	getSpec()	Gets the crontab specification.
protected Object	readResolve()
void	run()	Executes the triggered task.
void	start(J project, boolean newInstance)	Called when a Trigger is loaded into memory and started.
void	stop()	Called before a Trigger is removed.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

spec

protected final String spec

tabs

protected transient CronTabList tabs

job

@CheckForNull
protected transient J extends Item job

CRON_THRESHOLD

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@RestrictedSince("2.289")
public static long CRON_THRESHOLD

Used to be milliseconds, now is seconds since Jenkins 2.289.

timer

@Deprecated
@CheckForNull
public static Timer timer

Deprecated.

Use Timer.get() instead.

This timer is available for all the components inside Hudson to schedule some work. Initialized and cleaned up by Jenkins, but value kept here for compatibility. If plugins want to run periodic jobs, they should implement PeriodicWork.

Constructor Detail

Trigger

protected Trigger(@NonNull
                  String cronTabSpec)

Creates a new Trigger that gets run periodically. This is useful when your trigger does some polling work.

Parameters:

cronTabSpec - the crontab entry to be parsed

Throws:

IllegalArgumentException - if the crontab entry cannot be parsed

Trigger

protected Trigger()

Creates a new Trigger without using cron.

Method Detail

start

public void start(J project,
                  boolean newInstance)

Called when a Trigger is loaded into memory and started.

Parameters:

project - given so that the persisted form of this object won't have to have a back pointer.

newInstance - True if this may be a newly created trigger first attached to the Project (generally if the project is being created or configured). False if this is invoked for a Project loaded from disk.

See Also:

Items.currentlyUpdatingByXml()

run

public void run()

Executes the triggered task. This method is invoked when Trigger(String) is used to create an instance, and the crontab matches the current time.

Maybe run even before start(hudson.model.Item, boolean), prepare for it.

stop

public void stop()

Called before a Trigger is removed. Under some circumstances, this may be invoked more than once for a given Trigger, so be prepared for that.

When the configuration is changed for a project, all triggers are removed once and then added back.

getProjectAction

@Deprecated
public Action getProjectAction()

Deprecated.

as of 1.341 Use getProjectActions() instead.

Returns an action object if this Trigger has an action to contribute to a Project.

getProjectActions

public Collection<? extends Action> getProjectActions()

Actions to be displayed in the job page.

Returns:

can be empty but never null

Since:

1.341

getDescriptor

public TriggerDescriptor getDescriptor()

Description copied from interface: Describable

Gets the descriptor for this instance.

Descriptor is a singleton for every concrete Describable implementation, so if a.getClass() == b.getClass() then by default a.getDescriptor() == b.getDescriptor() as well. (In rare cases a single implementation class may be used for instances with distinct descriptors.)

Specified by:

getDescriptor in interface Describable<J extends Item>

getSpec

public final String getSpec()

Gets the crontab specification. If you are not using cron service, just ignore it.

readResolve

protected Object readResolve()
                      throws ObjectStreamException

Throws:

ObjectStreamException

toString

public String toString()

Overrides:

toString in class Object

checkTriggers

public static void checkTriggers(Calendar cal)

all

public static DescriptorExtensionList<Trigger<?>,TriggerDescriptor> all()

Returns all the registered Trigger descriptors.

for_

public static List<TriggerDescriptor> for_(Item i)

Returns a subset of TriggerDescriptors that applies to the given item.