com.github.sbugat.rundeckmonitor.configuration

Class RundeckMonitorConfiguration

java.lang.Object

com.github.sbugat.rundeckmonitor.configuration.RundeckMonitorConfiguration

public final class RundeckMonitorConfiguration
extends Object

Configurationloading class of the RunDeck Monitor.

Author:

Sylvain Bugat

Field Summary

Fields

Modifier and Type	Field and Description
private String	dateFormat Displayed date format.
private int	failedJobNumber Number of displayed failed jobs.
private String	interfaceType Type of GUI interface used.
private String	jobTabRedirection Job tab redirection.
private int	lateThreshold Threshold for detecting long execution.
private int	refreshDelay Delay between 2 refresh of rundeck's data.
static String	RUNDECK_MONITOR_PROPERTIES_FILE Configuration file name.
static String	RUNDECK_MONITOR_PROPERTY_API_KEY RunDeck API key property name.
private static String	RUNDECK_MONITOR_PROPERTY_API_VERSION RunDeck monitor API version property name.
private static int	RUNDECK_MONITOR_PROPERTY_API_VERSION_DEFAULT_VALUE RunDeck monitor API version default value.
private static String	RUNDECK_MONITOR_PROPERTY_DATE_FORMAT RunDeck monitor date format property name.
static String	RUNDECK_MONITOR_PROPERTY_DATE_FORMAT_DEFAULT_VALUE RunDeck monitor date format default value.
private static String	RUNDECK_MONITOR_PROPERTY_DISABLE_VERSION_CHECKER RunDeck monitor version checker property name.
private static boolean	RUNDECK_MONITOR_PROPERTY_DISABLE_VERSION_CHECKER_DEFAULT_VALUE RunDeck monitor version checker default value.
private static String	RUNDECK_MONITOR_PROPERTY_EXECUTION_LATE_THRESHOLD RunDeck monitor late threshold property name.
private static int	RUNDECK_MONITOR_PROPERTY_EXECUTION_LATE_THRESHOLD_DEFAULT_VALUE RunDeck monitor late threshold default value.
private static String	RUNDECK_MONITOR_PROPERTY_FAILED_JOB_NUMBER RunDeck monitor failed job number property name.
private static int	RUNDECK_MONITOR_PROPERTY_FAILED_JOB_NUMBER_DEFAULT_VALUE RunDeck monitor failed job number default value.
private static String	RUNDECK_MONITOR_PROPERTY_FAILED_JOB_REDIRECTION RunDeck monitor job redirection property name.
private static String	RUNDECK_MONITOR_PROPERTY_FAILED_JOB_REDIRECTION_DEFAULT_VALUE RunDeck monitor job redirection default value.
private static String	RUNDECK_MONITOR_PROPERTY_INTERFACE_TYPE RunDeck monitor GUI type property name.
private static String	RUNDECK_MONITOR_PROPERTY_INTERFACE_TYPE_DEFAULT_VALUE RunDeck monitor GUI type default value.
static String	RUNDECK_MONITOR_PROPERTY_LOGIN RunDeck login property name.
private static String	RUNDECK_MONITOR_PROPERTY_NAME RunDeck monitor name property name.
static String	RUNDECK_MONITOR_PROPERTY_NAME_DEFAULT_VALUE RunDeck monitor name default value.
static String	RUNDECK_MONITOR_PROPERTY_PASSWORD RunDeck password property name.
static String	RUNDECK_MONITOR_PROPERTY_PROJECT RunDeck project property name.
private static String	RUNDECK_MONITOR_PROPERTY_REFRESH_DELAY RunDeck monitor refresh delay property name.
private static int	RUNDECK_MONITOR_PROPERTY_REFRESH_DELAY_DEFAULT_VALUE RunDeck monitor refresh delay default value.
static String	RUNDECK_MONITOR_PROPERTY_URL RunDeck URL property name.
private String	rundeckAPIKey Rundeck API key.
private int	rundeckAPIversion RunDeck API version.
private String	rundeckLogin RunDeck login.
private String	rundeckMonitorName RunDeck monitor name.
private String	rundeckPassword RunDeck password.
private String	rundeckProject Name of the rundeck project to access.
private String	rundeckUrl RunDeck URL.
private boolean	versionCheckerDisabled Version checker flag.

Constructor Summary

Constructors

Constructor and Description
RundeckMonitorConfiguration() Default constructor.
RundeckMonitorConfiguration(RundeckMonitorConfiguration rundeckMonitorConfiguration) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
private static void	checkMandatoryStringProperty(String property, String propertyName) Check a property value.
void	disableVersionChecker() Disable the version checker.
private static boolean	getBooleanProperty(Properties properties, String propertyName, boolean defaultValue) Get an optional boolean property.
String	getDateFormat() Return the RunDeck monitor date format.
int	getFailedJobNumber() Return the RunDeck monitor failed job number.
private static int	getIntegerProperty(Properties properties, String propertyName, int defaultValue) Get an optional integer property.
String	getInterfaceType() Return the RunDeck monitor GUI type.
String	getJobTabRedirection() Return the RunDeck monitor job tab redirection.
int	getLateThreshold() Return the RunDeck monitor late threshold.
int	getRefreshDelay() Return the RunDeck monitor refresh delay.
String	getRundeckAPIKey() Return the RunDeck API key.
int	getRundeckAPIversion() Return the RunDeck monitor API version.
String	getRundeckLogin() Return the RunDeck login.
String	getRundeckMonitorName() Return the RunDeck monitor name.
String	getRundeckPassword() Return the RunDeck paswword.
String	getRundeckProject() Return the RunDeck project.
String	getRundeckUrl() Return the RunDeck URL.
boolean	isVersionCheckerEnabled() Return the RunDeck monitor version checker flag.
void	loadConfigurationPropertieFile() Load configuration.
static boolean	propertiesFileExists() Check if the configuration file exists and is readable.
static boolean	propertiesFileUpdated(Date date) Check if the configuration file has been updated.
void	saveMonitorConfigurationPropertieFile() Save the current loaded configuration to the configuration file.
void	setDateFormat(String dateFormatArg) Set the RunDeck monitor date format.
void	setFailedJobNumber(int failedJobNumberArg) Set the RunDeck monitor failed job number.
void	setInterfaceType(String interfaceTypeArg) Set the RunDeck monitor GUI type.
void	setJobTabRedirection(String jobTabRedirectionArg) Set the RunDeck monitor job tab redirection.
void	setLateThreshold(int lateThresholdArg) Set the RunDeck monitor late threshold.
void	setRefreshDelay(int refreshDelayArg) Set the RunDeck monitor refresh delay.
void	setRundeckAPIKey(String rundeckAPIKeyArg) Set the RunDeck API key.
void	setRundeckAPIversion(int rundeckAPIversionArg) Set the RunDeck monitor API version.
void	setRundeckLogin(String rundeckLoginArg) Set the RunDeck login.
void	setRundeckMonitorName(String rundeckMonitorNameArg) Set the RunDeck monitor name.
void	setRundeckPassword(String rundeckPasswordArg) Set the RunDeck password.
void	setRundeckProject(String rundeckProjectArg) Set the RunDeck project.
void	setRundeckUrl(String rundeckUrlArg) Set the RunDeck URL.
void	verifyConfiguration() Check loaded configuration.

Methods inherited from class java.lang.Object

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

Field Detail

RUNDECK_MONITOR_PROPERTIES_FILE

public static final String RUNDECK_MONITOR_PROPERTIES_FILE

Configuration file name.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_URL

public static final String RUNDECK_MONITOR_PROPERTY_URL

RunDeck URL property name.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_API_KEY

public static final String RUNDECK_MONITOR_PROPERTY_API_KEY

RunDeck API key property name.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_LOGIN

public static final String RUNDECK_MONITOR_PROPERTY_LOGIN

RunDeck login property name.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_PASSWORD

public static final String RUNDECK_MONITOR_PROPERTY_PASSWORD

RunDeck password property name.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_PROJECT

public static final String RUNDECK_MONITOR_PROPERTY_PROJECT

RunDeck project property name.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_NAME

private static final String RUNDECK_MONITOR_PROPERTY_NAME

RunDeck monitor name property name.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_NAME_DEFAULT_VALUE

public static final String RUNDECK_MONITOR_PROPERTY_NAME_DEFAULT_VALUE

RunDeck monitor name default value.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_REFRESH_DELAY

private static final String RUNDECK_MONITOR_PROPERTY_REFRESH_DELAY

RunDeck monitor refresh delay property name.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_REFRESH_DELAY_DEFAULT_VALUE

private static final int RUNDECK_MONITOR_PROPERTY_REFRESH_DELAY_DEFAULT_VALUE

RunDeck monitor refresh delay default value.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_EXECUTION_LATE_THRESHOLD

private static final String RUNDECK_MONITOR_PROPERTY_EXECUTION_LATE_THRESHOLD

RunDeck monitor late threshold property name.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_EXECUTION_LATE_THRESHOLD_DEFAULT_VALUE

private static final int RUNDECK_MONITOR_PROPERTY_EXECUTION_LATE_THRESHOLD_DEFAULT_VALUE

RunDeck monitor late threshold default value.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_FAILED_JOB_NUMBER

private static final String RUNDECK_MONITOR_PROPERTY_FAILED_JOB_NUMBER

RunDeck monitor failed job number property name.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_FAILED_JOB_NUMBER_DEFAULT_VALUE

private static final int RUNDECK_MONITOR_PROPERTY_FAILED_JOB_NUMBER_DEFAULT_VALUE

RunDeck monitor failed job number default value.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_DATE_FORMAT

private static final String RUNDECK_MONITOR_PROPERTY_DATE_FORMAT

RunDeck monitor date format property name.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_DATE_FORMAT_DEFAULT_VALUE

public static final String RUNDECK_MONITOR_PROPERTY_DATE_FORMAT_DEFAULT_VALUE

RunDeck monitor date format default value.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_API_VERSION

private static final String RUNDECK_MONITOR_PROPERTY_API_VERSION

RunDeck monitor API version property name.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_API_VERSION_DEFAULT_VALUE

private static final int RUNDECK_MONITOR_PROPERTY_API_VERSION_DEFAULT_VALUE

RunDeck monitor API version default value.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_FAILED_JOB_REDIRECTION

private static final String RUNDECK_MONITOR_PROPERTY_FAILED_JOB_REDIRECTION

RunDeck monitor job redirection property name.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_FAILED_JOB_REDIRECTION_DEFAULT_VALUE

private static final String RUNDECK_MONITOR_PROPERTY_FAILED_JOB_REDIRECTION_DEFAULT_VALUE

RunDeck monitor job redirection default value.

RUNDECK_MONITOR_PROPERTY_DISABLE_VERSION_CHECKER

private static final String RUNDECK_MONITOR_PROPERTY_DISABLE_VERSION_CHECKER

RunDeck monitor version checker property name.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_DISABLE_VERSION_CHECKER_DEFAULT_VALUE

private static final boolean RUNDECK_MONITOR_PROPERTY_DISABLE_VERSION_CHECKER_DEFAULT_VALUE

RunDeck monitor version checker default value.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_INTERFACE_TYPE

private static final String RUNDECK_MONITOR_PROPERTY_INTERFACE_TYPE

RunDeck monitor GUI type property name.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROPERTY_INTERFACE_TYPE_DEFAULT_VALUE

private static final String RUNDECK_MONITOR_PROPERTY_INTERFACE_TYPE_DEFAULT_VALUE

RunDeck monitor GUI type default value.

rundeckUrl

private String rundeckUrl

RunDeck URL.

rundeckAPIKey

private String rundeckAPIKey

Rundeck API key.

rundeckLogin

private String rundeckLogin

RunDeck login.

rundeckPassword

private String rundeckPassword

RunDeck password.

rundeckProject

private String rundeckProject

Name of the rundeck project to access.

rundeckMonitorName

private String rundeckMonitorName

RunDeck monitor name.

refreshDelay

private int refreshDelay

Delay between 2 refresh of rundeck's data.

lateThreshold

private int lateThreshold

Threshold for detecting long execution.

failedJobNumber

private int failedJobNumber

Number of displayed failed jobs.

dateFormat

private String dateFormat

Displayed date format.

rundeckAPIversion

private int rundeckAPIversion

RunDeck API version.

jobTabRedirection

private String jobTabRedirection

Job tab redirection.

versionCheckerDisabled

private boolean versionCheckerDisabled

Version checker flag.

interfaceType

private String interfaceType

Type of GUI interface used.

Constructor Detail

RundeckMonitorConfiguration

public RundeckMonitorConfiguration()

Default constructor.

RundeckMonitorConfiguration

public RundeckMonitorConfiguration(RundeckMonitorConfiguration rundeckMonitorConfiguration)

Copy constructor.

Parameters:

rundeckMonitorConfiguration - configuration to copy

Method Detail

loadConfigurationPropertieFile

public void loadConfigurationPropertieFile()
                                    throws IOException

Load configuration.

Throws:

IOException - in case of loading configuration error

verifyConfiguration

public void verifyConfiguration()
                         throws MissingPropertyException,
                                InvalidPropertyException

Check loaded configuration.

Throws:

InvalidPropertyException - in case of loading configuration property error

MissingPropertyException - in case of loading configuration property error

checkMandatoryStringProperty

private static void checkMandatoryStringProperty(String property,
                                String propertyName)
                                          throws MissingPropertyException,
                                                 InvalidPropertyException

Check a property value.

Parameters:

property - property loaded (can be null)

propertyName - name of the loaded property

Throws:

MissingPropertyException - if the property is null

InvalidPropertyException - if the property is empty

getIntegerProperty

private static int getIntegerProperty(Properties properties,
                     String propertyName,
                     int defaultValue)

Get an optional integer property.

Parameters:

properties - loaded properties

propertyName - property name to get

defaultValue - value to set if the property is missing or is invalid

Returns:

property value

getBooleanProperty

private static boolean getBooleanProperty(Properties properties,
                         String propertyName,
                         boolean defaultValue)

Get an optional boolean property.

Parameters:

properties - loaded properties

propertyName - property name to get

defaultValue - value to set if the property is missing or is invalid

Returns:

property value

saveMonitorConfigurationPropertieFile

public void saveMonitorConfigurationPropertieFile()
                                           throws IOException

Save the current loaded configuration to the configuration file.

Throws:

IOException - in case of writing error

disableVersionChecker

public void disableVersionChecker()

Disable the version checker.

propertiesFileExists

public static boolean propertiesFileExists()

Check if the configuration file exists and is readable.

Returns:

true if the configuration file exists and can be read

propertiesFileUpdated

public static boolean propertiesFileUpdated(Date date)

Check if the configuration file has been updated.

Parameters:

date - date of the last configuration loading

Returns:

true if the configuration file is newer than the date

getRundeckUrl

public String getRundeckUrl()

Return the RunDeck URL.

Returns:

RunDeck URL

getRundeckAPIKey

public String getRundeckAPIKey()

Return the RunDeck API key.

Returns:

RunDeck API key

getRundeckLogin

public String getRundeckLogin()

Return the RunDeck login.

Returns:

RunDeck login

getRundeckPassword

public String getRundeckPassword()

Return the RunDeck paswword.

Returns:

RunDeck paswword

getRundeckProject

public String getRundeckProject()

Return the RunDeck project.

Returns:

RunDeck project

getRundeckMonitorName

public String getRundeckMonitorName()

Return the RunDeck monitor name.

Returns:

RunDeck monitor name

getRefreshDelay

public int getRefreshDelay()

Return the RunDeck monitor refresh delay.

Returns:

RunDeck monitor refresh delay

getLateThreshold

public int getLateThreshold()

Return the RunDeck monitor late threshold.

Returns:

RunDeck monitor late threshold

getFailedJobNumber

public int getFailedJobNumber()

Return the RunDeck monitor failed job number.

Returns:

RunDeck monitor failed job number

getDateFormat

public String getDateFormat()

Return the RunDeck monitor date format.

Returns:

RunDeck monitor date format

getRundeckAPIversion

public int getRundeckAPIversion()

Return the RunDeck monitor API version.

Returns:

RunDeck monitor API version

getJobTabRedirection

public String getJobTabRedirection()

Return the RunDeck monitor job tab redirection.

Returns:

RunDeck monitor job tab redirection

getInterfaceType

public String getInterfaceType()

Return the RunDeck monitor GUI type.

Returns:

RunDeck monitor GUI type

isVersionCheckerEnabled

public boolean isVersionCheckerEnabled()

Return the RunDeck monitor version checker flag.

Returns:

true if the version checker is enabled

setRundeckUrl

public void setRundeckUrl(String rundeckUrlArg)

Set the RunDeck URL.

Parameters:

rundeckUrlArg - RunDeck URL to set

setRundeckAPIKey

public void setRundeckAPIKey(String rundeckAPIKeyArg)

Set the RunDeck API key.

Parameters:

rundeckAPIKeyArg - API key to set

setRundeckLogin

public void setRundeckLogin(String rundeckLoginArg)

Set the RunDeck login.

Parameters:

rundeckLoginArg - login to set

setRundeckPassword

public void setRundeckPassword(String rundeckPasswordArg)

Set the RunDeck password.

Parameters:

rundeckPasswordArg - password to set

setRundeckProject

public void setRundeckProject(String rundeckProjectArg)

Set the RunDeck project.

Parameters:

rundeckProjectArg - project to set

setRundeckMonitorName

public void setRundeckMonitorName(String rundeckMonitorNameArg)

Set the RunDeck monitor name.

Parameters:

rundeckMonitorNameArg - monitor name to set

setRefreshDelay

public void setRefreshDelay(int refreshDelayArg)

Set the RunDeck monitor refresh delay.

Parameters:

refreshDelayArg - refresh delay to set

setLateThreshold

public void setLateThreshold(int lateThresholdArg)

Set the RunDeck monitor late threshold.

Parameters:

lateThresholdArg - late threashold to set

setFailedJobNumber

public void setFailedJobNumber(int failedJobNumberArg)

Set the RunDeck monitor failed job number.

Parameters:

failedJobNumberArg - failed job number to set

setDateFormat

public void setDateFormat(String dateFormatArg)

Set the RunDeck monitor date format.

Parameters:

dateFormatArg - date format to set

setRundeckAPIversion

public void setRundeckAPIversion(int rundeckAPIversionArg)

Set the RunDeck monitor API version.

Parameters:

rundeckAPIversionArg - API version to set

setJobTabRedirection

public void setJobTabRedirection(String jobTabRedirectionArg)

Set the RunDeck monitor job tab redirection.

Parameters:

jobTabRedirectionArg - job tab redirection to set

setInterfaceType

public void setInterfaceType(String interfaceTypeArg)

Set the RunDeck monitor GUI type.

Parameters:

interfaceTypeArg - GUI type to set