hudson.plugins.jobConfigHistory
Class JobConfigHistory

java.lang.Object
  hudson.Plugin
      hudson.plugins.jobConfigHistory.JobConfigHistory

All Implemented Interfaces:

hudson.model.Saveable

public class JobConfigHistory
extends hudson.Plugin

Class supporting global configuration settings, along with methods associated with the plugin itself.

Author:

jborghi

Nested Class Summary

Nested classes/interfaces inherited from class hudson.Plugin

hudson.Plugin.DummyImpl

Field Summary

static FileFilter	DELETED_FILTER A filter to return only those directories of a file listing that represent deleted jobs history directories.
static FileFilter	HISTORY_FILTER A filter to return only those directories of a file listing that represent configuration history directories.

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

JobConfigHistory()

Method Summary

protected void	checkForPurgeByQuantity(File itemHistoryRoot) Checks if we should purge old history entries under the specified root using the maxHistoryEntries value as the criteria, and if required calls the appropriate method to perform the purge.
void	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
hudson.util.FormValidation	doCheckExcludePattern(String value) Validates the user entry for the regular expression of system file names to exclude from saving.
hudson.util.FormValidation	doCheckMaxDaysToKeepEntries(String value) Validates the user entry for the maximum number of days to keep history items.
hudson.util.FormValidation	doCheckMaxHistoryEntries(String value) Validates the user entry for the maximum number of history items to keep.
protected File	getConfigFile(File historyDir) Returns the configuration data file stored in the specified history directory.
protected File	getConfiguredHistoryRootDir() Returns the File object representing the configured root history directory.
String	getDefaultExcludePattern() Used by the configuration page.
String	getDefaultRootDir()
String	getExcludePattern()
protected Pattern	getExcludeRegexpPattern() Used for testing to verify invalid pattern not loaded.
protected File	getHistoryDir(hudson.XmlFile xmlFile) Returns the configuration history directory for the given configuration file.
String	getHistoryRootDir()
protected File	getJobHistoryRootDir() Returns the File object representing the job history directory, which is for reasons of backwards compatibility either a sibling or child of the configured history root dir.
String	getMaxDaysToKeepEntries()
String	getMaxHistoryEntries()
boolean	getSaveItemGroupConfiguration()
boolean	getSaveModuleConfiguration()
boolean	getSaveSystemConfiguration()
String	getShowBuildBadges()
boolean	getSkipDuplicateHistory()
protected boolean	isSaveable(hudson.model.Saveable item, hudson.XmlFile xmlFile) Returns true if configuration for this item should be saved, based on the plugin settings, the type of item and the configuration file specified.
protected void	setMaxDaysToKeepEntries(String maxDays) This method is for convenience in testing.
protected void	setMaxHistoryEntries(String maxHistoryEntries) This method is for convenience in testing.
void	setSaveSystemConfiguration(boolean bool) Used for testing only.
void	setShowBuildBadges(String showBadges) Used for testing only.
void	start()

Methods inherited from class hudson.Plugin

configure, doDynamic, getConfigXml, getWrapper, load, postInitialize, save, setServletContext, stop

Methods inherited from class java.lang.Object

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

Field Detail

HISTORY_FILTER

public static final FileFilter HISTORY_FILTER

A filter to return only those directories of a file listing that represent configuration history directories.

DELETED_FILTER

public static final FileFilter DELETED_FILTER

A filter to return only those directories of a file listing that represent deleted jobs history directories.

Constructor Detail

JobConfigHistory

public JobConfigHistory()

Method Detail

start

public void start()
           throws Exception

Overrides:

start in class hudson.Plugin

Throws:

Exception

configure

public void configure(org.kohsuke.stapler.StaplerRequest req,
                      net.sf.json.JSONObject formData)
               throws IOException,
                      javax.servlet.ServletException,
                      hudson.model.Descriptor.FormException

Overrides:

configure in class hudson.Plugin

Throws:

IOException

javax.servlet.ServletException

hudson.model.Descriptor.FormException

getHistoryRootDir

public String getHistoryRootDir()

Returns:

The configured history root directory.

getDefaultRootDir

public String getDefaultRootDir()

Returns:

The default history root directory.

getMaxHistoryEntries

public String getMaxHistoryEntries()

Returns:

The maximum number of history entries to keep.

setMaxHistoryEntries

protected void setMaxHistoryEntries(String maxHistoryEntries)

This method is for convenience in testing.

Parameters:

maxHistoryEntries - The maximum number of history entries to keep

getMaxDaysToKeepEntries

public String getMaxDaysToKeepEntries()

Returns:

The maximum number of days to keep history entries.

setMaxDaysToKeepEntries

protected void setMaxDaysToKeepEntries(String maxDays)

This method is for convenience in testing.

Parameters:

maxDays - For how long history entries should be kept (in days)

getSaveSystemConfiguration

public boolean getSaveSystemConfiguration()

Returns:

true if we should save 'system' configurations.

setSaveSystemConfiguration

public void setSaveSystemConfiguration(boolean bool)

Used for testing only.

Parameters:

bool - True if system configuration should be saved.

getSaveItemGroupConfiguration

public boolean getSaveItemGroupConfiguration()

Returns:

True if item group configurations should be saved.

getSkipDuplicateHistory

public boolean getSkipDuplicateHistory()

Returns:

true if we should skip saving history that duplicates the prior saved configuration.

getExcludePattern

public String getExcludePattern()

Returns:

The regular expression for 'system' file names to exclude from saving.

getDefaultExcludePattern

public String getDefaultExcludePattern()

Used by the configuration page.

Returns:

The default regular expression for 'system' file names to exclude from saving.

getSaveModuleConfiguration

public boolean getSaveModuleConfiguration()

Returns:

true if we should save 'system' configurations.

getShowBuildBadges

public String getShowBuildBadges()

Returns:

Whether build badges should appear always, never or only for users with config rights.

setShowBuildBadges

public void setShowBuildBadges(String showBadges)

Used for testing only.

Parameters:

showBadges - Never, always, userWithConfigPermission or adminUser.

getExcludeRegexpPattern

protected Pattern getExcludeRegexpPattern()

Used for testing to verify invalid pattern not loaded.

Returns:

The loaded regexp pattern, or null if pattern was invalid.

getJobHistoryRootDir

protected File getJobHistoryRootDir()

Returns the File object representing the job history directory, which is for reasons of backwards compatibility either a sibling or child of the configured history root dir.

Returns:

The job history File object.

getConfiguredHistoryRootDir

protected File getConfiguredHistoryRootDir()

Returns the File object representing the configured root history directory.

Returns:

The configured root history File object.

getHistoryDir

protected File getHistoryDir(hudson.XmlFile xmlFile)

Returns the configuration history directory for the given configuration file.

Parameters:

xmlFile - The configuration file whose content we are saving.

Returns:

The base directory where to store the history, or null if the file is not a valid Hudson configuration file.

getConfigFile

protected File getConfigFile(File historyDir)

Returns the configuration data file stored in the specified history directory. It looks for a file with an 'xml' extension that is not named JobConfigHistoryConsts.HISTORY_FILE.

Relies on the assumption that random '.xml' files will not appear in the history directories.

Checks that we are in an actual 'history directory' to prevent use for getting random xml files.

Parameters:

historyDir - The history directory to look under.

Returns:

The configuration file or null if no file is found.

isSaveable

protected boolean isSaveable(hudson.model.Saveable item,
                             hudson.XmlFile xmlFile)

Returns true if configuration for this item should be saved, based on the plugin settings, the type of item and the configuration file specified.

If the item is an instance of AbstractProject or the configuration file is stored directly in HUDSON_ROOT, it is considered for saving. If the plugin is configured to skip saving duplicated history, we also evaluate if this configuration duplicates the previous saved history (if such history exists).

Parameters:

item - The item whose configuration is under consideration.

xmlFile - The configuration file for the above item.

Returns:

true if the item configuration should be saved.

checkForPurgeByQuantity

protected void checkForPurgeByQuantity(File itemHistoryRoot)

Checks if we should purge old history entries under the specified root using the maxHistoryEntries value as the criteria, and if required calls the appropriate method to perform the purge.

Parameters:

itemHistoryRoot - The directory to consider purging history under.

doCheckMaxHistoryEntries

public hudson.util.FormValidation doCheckMaxHistoryEntries(@QueryParameter
                                                           String value)

Validates the user entry for the maximum number of history items to keep. Must be blank or a non-negative integer.

Parameters:

value - The form input entered by the user.

Returns:

ok if the entry is blank or a non-negative integer.

doCheckMaxDaysToKeepEntries

public hudson.util.FormValidation doCheckMaxDaysToKeepEntries(@QueryParameter
                                                              String value)

Validates the user entry for the maximum number of days to keep history items. Must be blank or a non-negative integer.

Parameters:

value - The form input entered by the user.

Returns:

ok if the entry is blank or a non-negative integer.

doCheckExcludePattern

public hudson.util.FormValidation doCheckExcludePattern(@QueryParameter
                                                        String value)

Validates the user entry for the regular expression of system file names to exclude from saving.

Parameters:

value - The form input entered by the user.

Returns:

ok if the entry is a valid regular expression.