com.dtolabs.rundeck.core.plugins

Class BasePluginProviderService<T>

java.lang.Object

com.dtolabs.rundeck.core.plugins.BasePluggableProviderService<T>

com.dtolabs.rundeck.core.plugins.BasePluginProviderService<T>

All Implemented Interfaces:

FrameworkSupportService, ProviderService<T>, DescribableService, PluggableProviderService<T>, PluggableService<T>

public class BasePluginProviderService<T>
extends BasePluggableProviderService<T>

Created by greg on 9/9/15.

Field Summary

Fields inherited from class com.dtolabs.rundeck.core.plugins.BasePluggableProviderService

implementationClass, name

Constructor Summary

Constructors

Constructor and Description
BasePluginProviderService(java.lang.String name, java.lang.Class<? extends T> implementationClass)

Method Summary

Modifier and Type	Method and Description
<X extends T> T	createProviderInstance(java.lang.Class<X> clazz, java.lang.String name) default implementation of createProviderInstance
T	createScriptProviderInstance(ScriptPluginProvider provider)
ServiceProviderLoader	getPluginManager()
ServiceProviderLoader	getRundeckServerServiceProviderLoader()
boolean	isScriptPluggable() default implementation returns false, subclasses should override to
java.util.List<ProviderIdent>	listDescribableProviders() default implementation of listDescribableProviders that can be used if subclasses implement DescribableService
java.util.List<Description>	listDescriptions() default implementation of listDescriptions that can be used if subclasses implement DescribableService
void	setRundeckServerServiceProviderLoader(ServiceProviderLoader rundeckServerServiceProviderLoader)

Methods inherited from class com.dtolabs.rundeck.core.plugins.BasePluggableProviderService

adapter, closeableProviderOfType, createProviderInstanceFromType, getName, hasValidProviderSignature, isValidProviderClass, listProviders, providerOfType

Methods inherited from class java.lang.Object

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

Constructor Detail

BasePluginProviderService

public BasePluginProviderService(java.lang.String name,
                                 java.lang.Class<? extends T> implementationClass)

Method Detail

getPluginManager

public ServiceProviderLoader getPluginManager()

Specified by:

getPluginManager in class BasePluggableProviderService<T>

Returns:

the plugin manager to use

getRundeckServerServiceProviderLoader

public ServiceProviderLoader getRundeckServerServiceProviderLoader()

setRundeckServerServiceProviderLoader

public void setRundeckServerServiceProviderLoader(ServiceProviderLoader rundeckServerServiceProviderLoader)

createProviderInstance

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

Description copied from class: BasePluggableProviderService

default implementation of createProviderInstance

Specified by:

createProviderInstance in interface PluggableService<T>

Overrides:

createProviderInstance in class BasePluggableProviderService<T>

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

public boolean isScriptPluggable()

Description copied from class: BasePluggableProviderService

default implementation returns false, subclasses should override to

Specified by:

isScriptPluggable in interface PluggableService<T>

Overrides:

isScriptPluggable in class BasePluggableProviderService<T>

Returns:

true if the service supports script plugins

createScriptProviderInstance

public T createScriptProviderInstance(ScriptPluginProvider provider)
                               throws PluginException

Specified by:

createScriptProviderInstance in interface PluggableService<T>

Overrides:

createScriptProviderInstance in class BasePluggableProviderService<T>

Parameters:

provider - the script plugin provider

Returns:

the instance for a ScriptPluginProvider definition

Throws:

PluginException - if the plugin has an error

listDescriptions

public java.util.List<Description> listDescriptions()

Description copied from class: BasePluggableProviderService

default implementation of listDescriptions that can be used if subclasses implement DescribableService

Specified by:

listDescriptions in interface DescribableService

Overrides:

listDescriptions in class BasePluggableProviderService<T>

listDescribableProviders

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

Description copied from class: BasePluggableProviderService

default implementation of listDescribableProviders that can be used if subclasses implement DescribableService

Specified by:

listDescribableProviders in interface DescribableService

Overrides:

listDescribableProviders in class BasePluggableProviderService<T>