hudson.plugins.scm_sync_configuration.strategies

Interface ScmSyncStrategy

All Known Implementing Classes:

AbstractScmSyncStrategy, BasicPluginsConfigScmSyncStrategy, JenkinsConfigScmSyncStrategy, JobConfigScmSyncStrategy, ManualIncludesScmSyncStrategy, UserConfigScmSyncStrategy

public interface ScmSyncStrategy

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ScmSyncStrategy.CommitMessageFactory

Method Summary

Methods

Modifier and Type	Method and Description
List<File>	collect() Collects all files, from Jenkins' root directory, that match this strategy.
List<File>	collect(File directory) Collects all files in the given directory, which must be under Jenkins' root directory, that match this strategy.
ScmSyncStrategy.CommitMessageFactory	getCommitMessageFactory()
List<String>	getSyncIncludes()
boolean	isCurrentUrlApplicable(String url) Is the given url eligible for the current strategy ?
boolean	isSaveableApplicable(hudson.model.Saveable saveable, File file) Is the given Saveable eligible for the current strategy ?
boolean	mightHaveBeenApplicableToDeletedSaveable(hudson.model.Saveable saveable, String pathRelativeToRoot, boolean wasDirectory) Determines whether the strategy might have applied to a deleted item.

Method Detail

isSaveableApplicable

boolean isSaveableApplicable(hudson.model.Saveable saveable,
                           File file)

Is the given Saveable eligible for the current strategy ?

Parameters:

saveable - A saveable which is saved

file - Corresponding file to the given Saveable object

Returns:

true if current Saveable instance matches with current ScmSyncStrategy target, false otherwise

mightHaveBeenApplicableToDeletedSaveable

boolean mightHaveBeenApplicableToDeletedSaveable(hudson.model.Saveable saveable,
                                               String pathRelativeToRoot,
                                               boolean wasDirectory)

Determines whether the strategy might have applied to a deleted item.

Parameters:

saveable - that was deleted; still exists in Jenkins' model but has already been eradicated from disk

pathRelativeToRoot - where the item resided

wasDirectory - whether it was a directory

Returns:

isCurrentUrlApplicable

boolean isCurrentUrlApplicable(String url)

Is the given url eligible for the current strategy ?

Parameters:

url - Current url, where hudson root url has been truncated

Returns:

true if current url matches with current ScmSyncStrategy target, false otherwise

collect

List<File> collect()

Collects all files, from Jenkins' root directory, that match this strategy.

Returns:

the list of files matched.

collect

List<File> collect(File directory)

Collects all files in the given directory, which must be under Jenkins' root directory, that match this strategy.

Parameters:

directory - to search in

Returns:

the list of files

Throws:

IllegalArgumentException - if the given directory is not under Jenkins' root directory

getSyncIncludes

List<String> getSyncIncludes()

Returns:

List of sync'ed file includes brought by current strategy. Used only for informational purposes in the UI.

getCommitMessageFactory

ScmSyncStrategy.CommitMessageFactory getCommitMessageFactory()

Returns:

A Factory intended to generate commit message depending on contexts