com.dtolabs.rundeck.core.plugins

Interface PluggableService<T>

All Superinterfaces:

FrameworkSupportService

All Known Subinterfaces:

PluggableProviderService<T>

All Known Implementing Classes:

BasePluggableProviderService, FileCopierService, FrameworkPluggableProviderService, NodeExecutorService, NodeSpecifiedService, OrchestratorService, PluggableProviderRegistryService, ResourceFormatGeneratorService, ResourceFormatParserService, ResourceModelSourceService, WorkflowStrategyService

public interface PluggableService<T>
extends FrameworkSupportService

PluggableService is a service that supports plugin provider classes and optionally supports plugin provider scripts.

Method Summary

Methods

Modifier and Type	Method and Description
<X extends T> T	createProviderInstance(java.lang.Class<X> clazz, java.lang.String name)
T	createScriptProviderInstance(ScriptPluginProvider provider)
boolean	isScriptPluggable()
boolean	isValidProviderClass(java.lang.Class clazz)

Methods inherited from interface com.dtolabs.rundeck.core.common.FrameworkSupportService

getName

Method Detail

isValidProviderClass

boolean isValidProviderClass(java.lang.Class clazz)

Parameters:

clazz - the class

Returns:

true if the class is a valid provider class for the service

createProviderInstance

<X extends T> T createProviderInstance(java.lang.Class<X> clazz,
                                     java.lang.String name)
                         throws PluginException,
                                ProviderCreationException

Type Parameters:

X - subtype of T

Parameters:

clazz - the class

name - the provider name

Returns:

Create provider instance from a class

Throws:

PluginException - if the plugin has an error

ProviderCreationException - if creating the instance has an error

isScriptPluggable

boolean isScriptPluggable()

Returns:

true if the service supports script plugins

createScriptProviderInstance

T createScriptProviderInstance(ScriptPluginProvider provider)
                               throws PluginException

Parameters:

provider - the script plugin provider

Returns:

the instance for a ScriptPluginProvider definition

Throws:

PluginException - if the plugin has an error