com.dtolabs.rundeck.core.plugins

Class ScriptPluginScanner

java.lang.Object

com.dtolabs.rundeck.core.plugins.ScriptPluginScanner

public class ScriptPluginScanner
extends java.lang.Object

ScriptPluginDirScanner is ...

Field Summary

Fields

Modifier and Type	Field and Description
static java.io.FileFilter	FILENAME_FILTER

Constructor Summary

Constructors

Constructor and Description
ScriptPluginScanner(java.io.File extdir, java.io.File cachedir, FileCache<com.dtolabs.rundeck.core.plugins.ProviderLoader> filecache, int rescanInterval)

Method Summary

Methods

Modifier and Type	Method and Description
com.dtolabs.rundeck.core.plugins.ProviderLoader	createCacheItemForFile(java.io.File file)
com.dtolabs.rundeck.core.plugins.ProviderLoader	createLoader(java.io.File file)
void	doScanAll() scan all found files to cache them
java.io.FileFilter	getFileFilter() Return the file filter
protected java.lang.String	getVersionForFile(java.io.File file) Return the version string for the plugin file, or null
boolean	isExpired(ProviderIdent ident, java.io.File file) Return true if the entry has expired
boolean	isValidPluginFile(java.io.File file) Return true if the file is a valid plugin file for the scanner
java.util.List<ProviderIdent>	listProviders() List available providers
java.io.File	scanForFile(ProviderIdent ident) scan for matching file for the provider def
boolean	shouldRescan() Return true if any file has been added/removed/modified, and the last full scan has not happened within a certain interval

Methods inherited from class java.lang.Object

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

Field Detail

FILENAME_FILTER

public static final java.io.FileFilter FILENAME_FILTER

Constructor Detail

ScriptPluginScanner

public ScriptPluginScanner(java.io.File extdir,
                   java.io.File cachedir,
                   FileCache<com.dtolabs.rundeck.core.plugins.ProviderLoader> filecache,
                   int rescanInterval)

Method Detail

createLoader

public com.dtolabs.rundeck.core.plugins.ProviderLoader createLoader(java.io.File file)

createCacheItemForFile

public com.dtolabs.rundeck.core.plugins.ProviderLoader createCacheItemForFile(java.io.File file)

getFileFilter

public java.io.FileFilter getFileFilter()

Return the file filter

isValidPluginFile

public boolean isValidPluginFile(java.io.File file)

Return true if the file is a valid plugin file for the scanner

getVersionForFile

protected java.lang.String getVersionForFile(java.io.File file)

Return the version string for the plugin file, or null

scanForFile

public final java.io.File scanForFile(ProviderIdent ident)
                               throws com.dtolabs.rundeck.core.plugins.PluginScannerException

scan for matching file for the provider def

Throws:

com.dtolabs.rundeck.core.plugins.PluginScannerException

listProviders

public java.util.List<ProviderIdent> listProviders()

List available providers

isExpired

public boolean isExpired(ProviderIdent ident,
                java.io.File file)

Return true if the entry has expired

shouldRescan

public boolean shouldRescan()

Return true if any file has been added/removed/modified, and the last full scan has not happened within a certain interval

doScanAll

public void doScanAll()
               throws com.dtolabs.rundeck.core.plugins.PluginScannerException

scan all found files to cache them

Throws:

PluginScannerException