org.jenkinsci.plugins.periodicreincarnation

Class PeriodicTrigger

java.lang.Object

org.jenkinsci.plugins.periodicreincarnation.PeriodicTrigger

Direct Known Subclasses:

BuildFailureObject, RegEx

public class PeriodicTrigger
extends Object

Class for the periodic Triggers. Like Regular Expression or Build Failure Cause.

Author:

Jochen Gietzen

Field Summary

Fields

Modifier and Type	Field and Description
String	cronTime Cron time format for this periodic trigger.
String	description Description for this periodic trigger.
String	masterAction Script for master.
String	nodeAction Script for node.
String	value Value of the periodic trigger as String.

Constructor Summary

Constructors

Constructor and Description
PeriodicTrigger(String value, String description, String cronTime, String nodeAction, String masterAction) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getCronTime() Returns the cron time for this particular periodic trigger.
String	getDescription() Returns a description for this periodic trigger.
String	getMasterAction() Returns the master script.
String	getNodeAction() Returns the node script.
String	getValue() Returns this periodic trigger value.
boolean	isTimeToRestart(long currentTime) Checks if the current time corresponds to the cron tab configured for this value.

Methods inherited from class java.lang.Object

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

Field Detail

value

public String value

Value of the periodic trigger as String.

description

public String description

Description for this periodic trigger.

cronTime

public String cronTime

Cron time format for this periodic trigger. Overrides the globally configured cron time if set.

nodeAction

public String nodeAction

Script for node.

masterAction

public String masterAction

Script for master.

Constructor Detail

PeriodicTrigger

@DataBoundConstructor
public PeriodicTrigger(String value,
                                             String description,
                                             String cronTime,
                                             String nodeAction,
                                             String masterAction)

Constructor. Creates a periodic trigger.

Parameters:

value - the value of the specific class - like a regex or failure id.

description - periodic trigger description

cronTime - cron time format.

nodeAction - node script.

masterAction - master script

Method Detail

getValue

public String getValue()

Returns this periodic trigger value.

Returns:

the periodic trigger value.

getDescription

public String getDescription()

Returns a description for this periodic trigger.

Returns:

Description as String.

getCronTime

public String getCronTime()

Returns the cron time for this particular periodic trigger.

Returns:

crontime as String.

getNodeAction

public String getNodeAction()

Returns the node script.

Returns:

the script as String.

getMasterAction

public String getMasterAction()

Returns the master script.

Returns:

the script as String.

isTimeToRestart

public boolean isTimeToRestart(long currentTime)

Checks if the current time corresponds to the cron tab configured for this value. If such cron tab is missing or could not be parsed then the global cron tab is used.

Parameters:

currentTime - current time from System

Returns:

true if global cron time covers the current time, false otherwise.