com.sap.prd.jenkins.plugins.agent_maintenance

Class MaintenanceAction

java.lang.Object

com.sap.prd.jenkins.plugins.agent_maintenance.MaintenanceAction

All Implemented Interfaces:

Action, ModelObject, IconSpec

public class MaintenanceAction
extends Object
implements Action, IconSpec

Action to display link to maintenance window configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static Permission[]	CONFIGURE_AND_DISCONNECT

Constructor Summary

Constructors

Constructor and Description
MaintenanceAction(SlaveComputer computer)

Method Summary

Modifier and Type	Method and Description
void	doAdd(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) UI method to add a smaintenance window.
void	doConfigSubmit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) UI method to submit the configuration.
void	doDeleteMaintenance(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, String id) UI method to delete a maintenance window.
void	doDeleteMultiple(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) UI method to delete multiple maintenance windows.
void	doDisable(org.kohsuke.stapler.StaplerResponse rsp) UI method to remove the retention strategy.
void	doEnable(org.kohsuke.stapler.StaplerResponse rsp) UI method to enable the retention strategy.
Computer	getComputer()
static String	getDefaultEndTime() The default end time shown in the UI when adding a new maintenance windows.
static String	getDefaultStartTime()
String	getDisplayName()
String	getIconClassName()
String	getIconFileName()
Class<MaintenanceWindow>	getMaintenanceWindowClass()
SortedSet<MaintenanceWindow>	getMaintenanceWindows() Returns a list of maintenance windows.
String	getUrlName()
boolean	hasMaintenanceWindows() The default start time shown in the UI when adding a new maintenance windows.
boolean	isEnabled()

Methods inherited from class java.lang.Object

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

Field Detail

CONFIGURE_AND_DISCONNECT

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static final Permission[] CONFIGURE_AND_DISCONNECT

Constructor Detail

MaintenanceAction

public MaintenanceAction(SlaveComputer computer)

Method Detail

getComputer

public Computer getComputer()

getIconClassName

public String getIconClassName()

Specified by:

getIconClassName in interface IconSpec

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

getMaintenanceWindowClass

public Class<MaintenanceWindow> getMaintenanceWindowClass()

isEnabled

public boolean isEnabled()

getDefaultStartTime

public static String getDefaultStartTime()

getDefaultEndTime

public static String getDefaultEndTime()

The default end time shown in the UI when adding a new maintenance windows. Current time + 1 day.

Returns:

end time

hasMaintenanceWindows

public boolean hasMaintenanceWindows()

The default start time shown in the UI when adding a new maintenance windows. Current time.

Returns:

end time

getMaintenanceWindows

public SortedSet<MaintenanceWindow> getMaintenanceWindows()

Returns a list of maintenance windows.

Returns:

A list of maintenance windows

doAdd

@POST
public void doAdd(org.kohsuke.stapler.StaplerRequest req,
                        org.kohsuke.stapler.StaplerResponse rsp)
                 throws IOException,
                        javax.servlet.ServletException

UI method to add a smaintenance window.

Parameters:

req - Stapler Request

rsp - Stapler Response

Throws:

IOException - when writing fails

javax.servlet.ServletException - if an error occurs reading the form

doDeleteMultiple

@POST
public void doDeleteMultiple(org.kohsuke.stapler.StaplerRequest req,
                                   org.kohsuke.stapler.StaplerResponse rsp)
                            throws IOException,
                                   javax.servlet.ServletException

UI method to delete multiple maintenance windows.

Parameters:

req - Stapler Request

rsp - Stapler Response

Throws:

IOException - when writing fails

javax.servlet.ServletException - if an error occurs reading the form

doDeleteMaintenance

@POST
public void doDeleteMaintenance(org.kohsuke.stapler.StaplerRequest req,
                                      org.kohsuke.stapler.StaplerResponse rsp,
                                      @QueryParameter
                                      String id)
                               throws IOException

UI method to delete a maintenance window.

Parameters:

req - Stapler Request

rsp - Stapler Response

Throws:

IOException - when writing fails

doConfigSubmit

@POST
public void doConfigSubmit(org.kohsuke.stapler.StaplerRequest req,
                                 org.kohsuke.stapler.StaplerResponse rsp)
                          throws IOException,
                                 javax.servlet.ServletException

UI method to submit the configuration.

Parameters:

req - Stapler Request

rsp - Stapler Response

Throws:

IOException - when writing fails

javax.servlet.ServletException - if an error occurs reading the form

doEnable

@POST
public void doEnable(org.kohsuke.stapler.StaplerResponse rsp)
                    throws IOException

UI method to enable the retention strategy.

Parameters:

rsp - Stapler Response

Throws:

IOException - when something goes wrong

doDisable

@POST
public void doDisable(org.kohsuke.stapler.StaplerResponse rsp)
                     throws IOException

UI method to remove the retention strategy.

Parameters:

rsp - Stapler Response

Throws:

IOException - when something goes wrong