com.dtolabs.rundeck.core.plugins

Class BasePluggableProviderService<T>

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

FrameworkPluggableProviderService

public abstract class BasePluggableProviderService<T>
extends java.lang.Object
implements PluggableProviderService<T>

BasePluggableProviderService is an abstract base for a provider service which can load providers from plugins. Created by greg Date: 4/12/13 Time: 4:52 PM

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class<? extends T>	implementationClass
protected java.lang.String	name

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
<X> ProviderService<X>	adapter(Converter<T,X> converter)
<X extends T> T	createProviderInstance(java.lang.Class<X> clazz, java.lang.String name) default implementation of createProviderInstance
protected T	createProviderInstanceFromType(java.lang.Class<? extends T> execClass, java.lang.String providerName)
T	createScriptProviderInstance(ScriptPluginProvider provider)
java.lang.String	getName()
abstract ServiceProviderLoader	getPluginManager()
protected boolean	hasValidProviderSignature(java.lang.Class clazz)
boolean	isScriptPluggable() default implementation returns false, subclasses should override to
boolean	isValidProviderClass(java.lang.Class clazz)
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
java.util.List<ProviderIdent>	listProviders()
T	providerOfType(java.lang.String providerName)

Methods inherited from class java.lang.Object

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

Field Detail

implementationClass

protected java.lang.Class<? extends T> implementationClass

name

protected java.lang.String name

Constructor Detail

BasePluggableProviderService

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

Method Detail

isValidProviderClass

public boolean isValidProviderClass(java.lang.Class clazz)

Specified by:

isValidProviderClass in interface PluggableService<T>

Parameters:

clazz - the class

Returns:

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

createProviderInstance

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

default implementation of createProviderInstance

Specified by:

createProviderInstance in interface PluggableService<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

providerOfType

public T providerOfType(java.lang.String providerName)
                 throws ExecutionServiceException

Specified by:

providerOfType in interface ProviderService<T>

Parameters:

providerName - name of the service provider

Returns:

the provider instance of the given name.

Throws:

ExecutionServiceException - on error

getPluginManager

public abstract ServiceProviderLoader getPluginManager()

Returns:

the plugin manager to use

listProviders

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

Specified by:

listProviders in interface ProviderService<T>

isScriptPluggable

public boolean isScriptPluggable()

default implementation returns false, subclasses should override to

Specified by:

isScriptPluggable in interface PluggableService<T>

Returns:

true if the service supports script plugins

createScriptProviderInstance

public T createScriptProviderInstance(ScriptPluginProvider provider)
                               throws PluginException

Specified by:

createScriptProviderInstance in interface PluggableService<T>

Parameters:

provider - the script plugin provider

Returns:

the instance for a ScriptPluginProvider definition

Throws:

PluginException - if the plugin has an error

createProviderInstanceFromType

protected T createProviderInstanceFromType(java.lang.Class<? extends T> execClass,
                               java.lang.String providerName)
                                    throws ProviderCreationException

Throws:

ProviderCreationException

hasValidProviderSignature

protected boolean hasValidProviderSignature(java.lang.Class clazz)

listDescriptions

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

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

Specified by:

listDescriptions in interface DescribableService

listDescribableProviders

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

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

Specified by:

listDescribableProviders in interface DescribableService

adapter

public <X> ProviderService<X> adapter(Converter<T,X> converter)

Type Parameters:

X - provider type

Parameters:

converter - converter

Returns:

Create an adapted form of this service given a converter.

getName

public java.lang.String getName()

Specified by:

getName in interface FrameworkSupportService

Returns:

the name used to identify the service