com.dtolabs.rundeck.core.plugins

Class DirPluginScanner

java.lang.Object

com.dtolabs.rundeck.core.plugins.DirPluginScanner

All Implemented Interfaces:

PluginDirChangeEventListener, PluginScanner, FileCache.ItemCreator<ProviderLoader>

Direct Known Subclasses:

JarPluginScanner, ScriptPluginScanner

public abstract class DirPluginScanner
extends java.lang.Object
implements PluginScanner, PluginDirChangeEventListener

DirPluginScanner will scan all files in a directory matching a filter for valid plugins.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DirPluginScanner(PluginDirProvider pluginDirProvider, FileCache<ProviderLoader> filecache)

Method Summary

Modifier and Type	Method and Description
abstract java.io.FileFilter	getFileFilter() Return the file filter
protected abstract 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
abstract 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
void	onDirChangeEvent(PluginDirChangeEvent event)
java.io.File	scanForFile(ProviderIdent ident) scan for matching file for the provider def

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.dtolabs.rundeck.core.plugins.PluginScanner

createLoader

Methods inherited from interface com.dtolabs.rundeck.core.utils.cache.FileCache.ItemCreator

createCacheItemForFile

Constructor Detail

DirPluginScanner

protected DirPluginScanner(PluginDirProvider pluginDirProvider,
                           FileCache<ProviderLoader> filecache)

Method Detail

onDirChangeEvent

public void onDirChangeEvent(PluginDirChangeEvent event)

Specified by:

onDirChangeEvent in interface PluginDirChangeEventListener

isValidPluginFile

public abstract boolean isValidPluginFile(java.io.File file)

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

getFileFilter

public abstract java.io.FileFilter getFileFilter()

Return the file filter

getVersionForFile

protected abstract 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

Specified by:

scanForFile in interface PluginScanner

Throws:

com.dtolabs.rundeck.core.plugins.PluginScannerException

listProviders

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

Description copied from interface: PluginScanner

List available providers

Specified by:

listProviders in interface PluginScanner

isExpired

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

Return true if the entry has expired

Specified by:

isExpired in interface PluginScanner