Package com.sap.prd.jenkins.plugins.agent_maintenance

Class MaintenanceWindow

java.lang.Object

hudson.model.AbstractDescribableImpl<MaintenanceWindow>

com.sap.prd.jenkins.plugins.agent_maintenance.MaintenanceWindow

All Implemented Interfaces:

Describable<MaintenanceWindow>, Comparable<MaintenanceWindow>

public class MaintenanceWindow
extends AbstractDescribableImpl<MaintenanceWindow>
implements Comparable<MaintenanceWindow>

Describes a maintenance window.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MaintenanceWindow.DescriptorImpl	Descriptor for UI only.

Field Summary

Fields

Modifier and Type	Field	Description
static final DateTimeFormatter	DATE_FORMATTER
static final DateTimeFormatter	DATE_INPUT_FORMATTER

Constructor Summary

Constructors

Constructor	Description
MaintenanceWindow(String startTime, String endTime, String reason, boolean takeOnline, boolean keepUpWhenActive, int maxWaitMinutes, String userid, String id)	Deprecated.
MaintenanceWindow(String startTime, String endTime, String reason, boolean takeOnline, boolean keepUpWhenActive, String maxWaitMinutes, String userid, String id)	Create a new maintenance window.
MaintenanceWindow(LocalDateTime startTime, LocalDateTime endTime, String reason, boolean takeOnline, boolean keepUpWhenActive, String maxWaitMinutes, String userid, String id)	Create a new maintenance window.

Method Summary

Modifier and Type	Method	Description
boolean	buildsHaveBeenAborted()
int	compareTo(MaintenanceWindow other)
boolean	equals(Object obj)
String	getEndTime()
String	getId()
int	getMaxWaitMinutes()
OfflineCause	getOfflineCause(String computerName)
String	getReason()
String	getStartTime()
String	getUserid()
int	hashCode()
boolean	isKeepUpWhenActive()
boolean	isMaintenanceOver()
boolean	isMaintenanceScheduled()	Return the status of the maintenance.
boolean	isMaxWaitTimeFinished()	Checks if max waiting time is finished.
boolean	isTakeOnline()
protected Object	readResolve()
void	setAborted(boolean aborted)

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Field Details

DATE_FORMATTER

public static final DateTimeFormatter DATE_FORMATTER

DATE_INPUT_FORMATTER

public static final DateTimeFormatter DATE_INPUT_FORMATTER

Constructor Details

MaintenanceWindow

@Deprecated
public MaintenanceWindow(String startTime,
 String endTime,
 String reason,
 boolean takeOnline,
 boolean keepUpWhenActive,
 int maxWaitMinutes,
 String userid,
 String id)

Deprecated.

Create a new maintenance window.

Parameters:

startTime - Start time

endTime - End time

reason - Reason

takeOnline - Take online at end of maintenance

keepUpWhenActive - Keep up while builds are running

maxWaitMinutes - Max waiting time before canceling running builds.

userid - Userid that created the maintenance window

id - ID of the maintenance, use null to generate a new id

MaintenanceWindow

@DataBoundConstructor
public MaintenanceWindow(String startTime,
 String endTime,
 String reason,
 boolean takeOnline,
 boolean keepUpWhenActive,
 String maxWaitMinutes,
 String userid,
 String id)

Create a new maintenance window.

Parameters:

startTime - Start time

endTime - End time

reason - Reason

takeOnline - Take online at end of maintenance

keepUpWhenActive - Keep up while builds are running

maxWaitMinutes - Max waiting time before canceling running builds. Can be a number or a string with a timespan, e.g. "1d 2h 15m"

userid - Userid that created the maintenance window

id - ID of the maintenance, use null to generate a new id

MaintenanceWindow

public MaintenanceWindow(LocalDateTime startTime,
 LocalDateTime endTime,
 String reason,
 boolean takeOnline,
 boolean keepUpWhenActive,
 String maxWaitMinutes,
 String userid,
 String id)

Create a new maintenance window.

Parameters:

startTime - Start time

endTime - End time

reason - Reason

takeOnline - Take online at end of maintenance

keepUpWhenActive - Keep up while builds are running

maxWaitMinutes - Max waiting time before canceling running builds. Can be a number or a string with a timespan, e.g. "1d 2h 15m"

userid - Userid that created the maintenance window

id - ID of the maintenance, use null to generate a new id

Method Details

getId

public String getId()

getUserid

public String getUserid()

isKeepUpWhenActive

public boolean isKeepUpWhenActive()

buildsHaveBeenAborted

public boolean buildsHaveBeenAborted()

setAborted

public void setAborted(boolean aborted)

getMaxWaitMinutes

public int getMaxWaitMinutes()

isTakeOnline

public boolean isTakeOnline()

readResolve

protected Object readResolve()

getStartTime

public String getStartTime()

getEndTime

public String getEndTime()

getReason

public String getReason()

isMaxWaitTimeFinished

public boolean isMaxWaitTimeFinished()

Checks if max waiting time is finished.

Returns:

true when waiting is finished

isMaintenanceScheduled

public boolean isMaintenanceScheduled()

Return the status of the maintenance.

Returns:

true if the maintenance is active, false otherwise.

isMaintenanceOver

public boolean isMaintenanceOver()

getOfflineCause

public OfflineCause getOfflineCause(String computerName)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(MaintenanceWindow other)

Specified by:

compareTo in interface Comparable<MaintenanceWindow>