com.sap.prd.jenkins.plugins.agent_maintenance

Class MaintenanceHelper

java.lang.Object

com.sap.prd.jenkins.plugins.agent_maintenance.MaintenanceHelper

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class MaintenanceHelper
extends Object

Helper class to manage maintenance windows.

Method Summary

Modifier and Type	Method and Description
void	addMaintenanceWindow(String computerName, MaintenanceWindow mw) Adds a maintenance window to a computer.
void	createAgent(String nodeName)
void	deleteAgent(String computerName)
void	deleteMaintenanceWindow(String computerName, String id) Delete maintenance window from computer.
static MaintenanceHelper	getInstance()
MaintenanceWindow	getMaintenance(String computerName) Returns the first maintenance that is currently active or null if configured maintenance windows are not active.
SortedSet<MaintenanceWindow>	getMaintenanceWindows(String computerName) Returns the list of all configured maintenance windows for the computer with the given name.
boolean	hasMaintenanceWindows(String computerName)
boolean	injectRetentionStrategy(Computer c) Inject the agent maintenance retention strategy from the given computer.
boolean	removeRetentionStrategy(Computer c) Remove the agent maintenance retention strategy from the given computer.
void	renameAgent(String oldName, String newName) Keeps track of agent renames.
void	saveMaintenanceWindows(String computerName, SortedSet<MaintenanceWindow> maintenanceWindows) Save maintenance window for computer.

Methods inherited from class java.lang.Object

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

Method Detail

hasMaintenanceWindows

public boolean hasMaintenanceWindows(String computerName)
                              throws IOException

Throws:

IOException

addMaintenanceWindow

public void addMaintenanceWindow(String computerName,
                                 MaintenanceWindow mw)
                          throws IOException

Adds a maintenance window to a computer.

Parameters:

computerName - Name of the computer for which to add the maintenance window

mw - The maintance windows

Throws:

IOException - when writing the xml failed

deleteMaintenanceWindow

public void deleteMaintenanceWindow(String computerName,
                                    String id)
                             throws IOException

Delete maintenance window from computer.

Parameters:

computerName - Name of the computer

id - Id of the maintenance window

Throws:

IOException - when writing the xml failed

getMaintenanceWindows

@NonNull
public SortedSet<MaintenanceWindow> getMaintenanceWindows(String computerName)
                                                            throws IOException

Returns the list of all configured maintenance windows for the computer with the given name.

Parameters:

computerName - name of the agent for which to return maintenance windows

Returns:

Set of maintenance windows

Throws:

IOException - when an error occured reading the xml

getMaintenance

@CheckForNull
public MaintenanceWindow getMaintenance(String computerName)

Returns the first maintenance that is currently active or null if configured maintenance windows are not active. All maintenance windows that are finished are removed.

Parameters:

computerName - Name of computer

Returns:

active maintenance or null

getInstance

public static MaintenanceHelper getInstance()

saveMaintenanceWindows

public void saveMaintenanceWindows(String computerName,
                                   SortedSet<MaintenanceWindow> maintenanceWindows)
                            throws IOException

Save maintenance window for computer.

Parameters:

computerName - Name of computer

maintenanceWindows - A set of maintenance windows

Throws:

IOException - when writing the xml failed

deleteAgent

public void deleteAgent(String computerName)

renameAgent

public void renameAgent(String oldName,
                        String newName)

Keeps track of agent renames.

Parameters:

oldName - Old name of the agent

newName - new name of the agent

createAgent

public void createAgent(String nodeName)

injectRetentionStrategy

public boolean injectRetentionStrategy(Computer c)

Inject the agent maintenance retention strategy from the given computer.

Parameters:

c - The computer for which to inject the strategy

Returns:

true if strategy was injected, false otherwise

removeRetentionStrategy

public boolean removeRetentionStrategy(Computer c)

Remove the agent maintenance retention strategy from the given computer.

Parameters:

c - The computer for which to remove the strategy

Returns:

true if strategy was removed, false otherwise