com.dtolabs.rundeck.core.plugins

Interface PluggableService<T>

All Superinterfaces:

FrameworkSupportService

All Known Subinterfaces:

PluggableProviderService<T>

All Known Implementing Classes:

AdapterService, BasePluggableProviderService, BasePluggableProviderServiceImpl, BasePluginProviderService, FileCopierService, FrameworkPluggableProviderService, NodeExecutorService, NodeSpecifiedService, NodeStepExecutionService, OrchestratorService, PluggableProviderRegistryService, ResourceFormatGeneratorService, ResourceFormatParserService, ResourceModelSourceService, StepExecutionService, WorkflowExecutionService, WorkflowStrategyService

public interface PluggableService<T>
extends FrameworkSupportService

PluggableService is a service that supports loading plugins via provider loaders.

Method Summary

Modifier and Type	Method and Description
default boolean	canLoadWithLoader(ProviderLoader loader)
default CloseableProvider<T>	loadCloseableWithLoader(java.lang.String providerName, ProviderLoader loader) Load a closeable provider with the given loader
default T	loadWithLoader(java.lang.String providerName, ProviderLoader loader) Load provider with the given loader

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

getName

Method Detail

canLoadWithLoader

default boolean canLoadWithLoader(ProviderLoader loader)

Parameters:

loader - loader

Returns:

true if the loader can be used for this service, by default delegates to the loader's ProviderLoader.canLoadForService(FrameworkSupportService)

loadWithLoader

default T loadWithLoader(java.lang.String providerName,
                         ProviderLoader loader)
                  throws ProviderLoaderException

Load provider with the given loader

Parameters:

providerName - provider name

loader - loader

Returns:

loaded provider instance, by default delegates to the loader's ProviderLoader.load(PluggableService, String)

Throws:

ProviderLoaderException - if an error occurs

loadCloseableWithLoader

default CloseableProvider<T> loadCloseableWithLoader(java.lang.String providerName,
                                                     ProviderLoader loader)
                                              throws ProviderLoaderException

Load a closeable provider with the given loader

Parameters:

providerName - provider name

loader - loader

Returns:

closeable provider for instance, by default delegates to the loader's ProviderLoader.loadCloseable(PluggableService, String)

Throws:

ProviderLoaderException - if an error occurs