com.dtolabs.rundeck.core.plugins

Class PluginManagerService

java.lang.Object

com.dtolabs.rundeck.core.plugins.PluginManagerService

All Implemented Interfaces:

FrameworkSupportService, ServiceProviderLoader

public class PluginManagerService
extends java.lang.Object
implements FrameworkSupportService, ServiceProviderLoader

PluginManagerService is ...

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
PluginManagerService() Create a PluginManagerService
PluginManagerService(java.io.File extdir, java.io.File cachedir, PluginCache cache) Create a PluginManagerService for the given directory and cache directory

Method Summary

Modifier and Type	Method and Description
<T> PluggableProviderService<T>	createPluginService(java.lang.Class<T> type, java.lang.String serviceName) Create
static FileCache<com.dtolabs.rundeck.core.plugins.ProviderLoader>	createProviderLoaderFileCache()
PluginCache	getCache()
java.io.File	getCachedir()
java.io.File	getExtdir()
static PluginManagerService	getInstanceForFramework(Framework framework)
java.lang.String	getName()
PluginMetadata	getPluginMetadata(java.lang.String service, java.lang.String provider)
PluginResourceLoader	getResourceLoader(java.lang.String service, java.lang.String provider)
java.util.Map<java.lang.String,java.lang.String>	getServiceAliases()
java.util.List<ProviderIdent>	listProviders()
<T> CloseableProvider<T>	loadCloseableProvider(PluggableService<T> service, java.lang.String providerName) Create a provider instance for the service
<T> T	loadProvider(PluggableService<T> service, java.lang.String providerName) Create a provider instance for the service
void	setCache(PluginCache cache)
void	setCachedir(java.io.File cachedir)
void	setExtdir(java.io.File extdir)
void	setServiceAliases(java.util.Map<java.lang.String,java.lang.String> serviceAliases)

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME

See Also:

Constant Field Values

Constructor Detail

PluginManagerService

public PluginManagerService()

Create a PluginManagerService

PluginManagerService

public PluginManagerService(java.io.File extdir,
                            java.io.File cachedir,
                            PluginCache cache)

Create a PluginManagerService for the given directory and cache directory

Parameters:

extdir - plugin dir

cachedir - cache dir

Method Detail

createPluginService

public <T> PluggableProviderService<T> createPluginService(java.lang.Class<T> type,
                                                           java.lang.String serviceName)

Create

Specified by:

createPluginService in interface ServiceProviderLoader

Type Parameters:

T -

Parameters:

type -

serviceName -

Returns:

createProviderLoaderFileCache

public static FileCache<com.dtolabs.rundeck.core.plugins.ProviderLoader> createProviderLoaderFileCache()

getName

public java.lang.String getName()

Specified by:

getName in interface FrameworkSupportService

Returns:

the name used to identify the service

getInstanceForFramework

public static PluginManagerService getInstanceForFramework(Framework framework)

listProviders

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

Specified by:

listProviders in interface ServiceProviderLoader

Returns:

the available providers

loadCloseableProvider

public <T> CloseableProvider<T> loadCloseableProvider(PluggableService<T> service,
                                                      java.lang.String providerName)
                                               throws ProviderLoaderException

Description copied from interface: ServiceProviderLoader

Create a provider instance for the service

Specified by:

loadCloseableProvider in interface ServiceProviderLoader

Type Parameters:

T - service type

Parameters:

service - service

providerName - provider

Returns:

closeable provider which can close loaded resources at completion

Throws:

ProviderLoaderException

loadProvider

public <T> T loadProvider(PluggableService<T> service,
                          java.lang.String providerName)
                   throws ProviderLoaderException

Description copied from interface: ServiceProviderLoader

Create a provider instance for the service

Specified by:

loadProvider in interface ServiceProviderLoader

Type Parameters:

T - service class

Parameters:

service - the service

providerName - the name of the provider to load

Returns:

the provider instance

Throws:

ProviderLoaderException - if the provider cannot be found or there is an error loading it

getResourceLoader

public PluginResourceLoader getResourceLoader(java.lang.String service,
                                              java.lang.String provider)
                                       throws ProviderLoaderException

Specified by:

getResourceLoader in interface ServiceProviderLoader

Throws:

ProviderLoaderException

getPluginMetadata

public PluginMetadata getPluginMetadata(java.lang.String service,
                                        java.lang.String provider)
                                 throws ProviderLoaderException

Specified by:

getPluginMetadata in interface ServiceProviderLoader

Throws:

ProviderLoaderException

getExtdir

public java.io.File getExtdir()

setExtdir

public void setExtdir(java.io.File extdir)

getCachedir

public java.io.File getCachedir()

setCachedir

public void setCachedir(java.io.File cachedir)

getCache

public PluginCache getCache()

setCache

public void setCache(PluginCache cache)

getServiceAliases

public java.util.Map<java.lang.String,java.lang.String> getServiceAliases()

setServiceAliases

public void setServiceAliases(java.util.Map<java.lang.String,java.lang.String> serviceAliases)