com.dtolabs.rundeck.core.resources

Class ResourceModelSourceService

java.lang.Object

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

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

com.dtolabs.rundeck.core.plugins.PluggableProviderRegistryService<ResourceModelSourceFactory>

com.dtolabs.rundeck.core.resources.ResourceModelSourceService

All Implemented Interfaces:

FrameworkSupportService, ProviderService<ResourceModelSourceFactory>, ConfigurableService<ResourceModelSource>, DescribableService, JavaClassProviderLoadable<ResourceModelSourceFactory>, PluggableProviderService<ResourceModelSourceFactory>, PluggableService<ResourceModelSourceFactory>, ProviderRegistryService<ResourceModelSourceFactory>, ScriptPluginProviderLoadable<ResourceModelSourceFactory>

public class ResourceModelSourceService
extends PluggableProviderRegistryService<ResourceModelSourceFactory>
implements ConfigurableService<ResourceModelSource>, DescribableService, PluggableProviderService<ResourceModelSourceFactory>, JavaClassProviderLoadable<ResourceModelSourceFactory>, ScriptPluginProviderLoadable<ResourceModelSourceFactory>

ResourceModelSourceService provides NodeSource factories

Field Summary

Fields

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

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

framework

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

instanceregistry, registry

Constructor Summary

Constructors

Constructor and Description
ResourceModelSourceService(Framework framework)

Method Summary

Modifier and Type	Method and Description
<X extends ResourceModelSourceFactory> ResourceModelSourceFactory	createProviderInstance(java.lang.Class<X> clazz, java.lang.String name)
ResourceModelSourceFactory	createScriptProviderInstance(ScriptPluginProvider provider)
static java.util.function.Function<ResourceModelSourceFactory,ResourceModelSource>	factoryConverter(java.util.Properties configuration) Given input configuration, produce a function to convert from a factory to model source
static java.util.function.Function<ResourceModelSourceFactory,ResourceModelSource>	factoryConverter(Services services, java.util.Properties configuration) Given input configuration, produce a function to convert from a factory to model source
java.util.List<java.lang.String>	getBundledProviderNames()
CloseableProvider<ResourceModelSource>	getCloseableProviderForConfiguration(java.lang.String type, java.util.Properties configuration) Return a provider of type T which can be closed
CloseableProvider<ResourceModelSource>	getCloseableSourceForConfiguration(java.lang.String type, java.util.Properties configuration)
CloseableProvider<ResourceModelSource>	getCloseableSourceForConfiguration(java.lang.String type, java.util.Properties configuration, Services services)
static ResourceModelSourceService	getInstanceForFramework(Framework framework)
java.lang.String	getName()
ResourceModelSource	getProviderForConfiguration(java.lang.String type, java.util.Properties configuration)
ResourceModelSource	getSourceForConfiguration(java.lang.String type, java.util.Properties configuration)
boolean	isValidProviderClass(java.lang.Class clazz)
java.util.List<ProviderIdent>	listDescribableProviders()
java.util.List<Description>	listDescriptions()

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

closeableProviderOfType, listProviders, providerOfType

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

createProviderInstanceFromType, hasValidProviderSignature

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

registerClass, registerInstance

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.dtolabs.rundeck.core.plugins.PluggableProviderService

adapter

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

closeableProviderOfType, listProviders, providerOfType

Methods inherited from interface com.dtolabs.rundeck.core.plugins.PluggableService

canLoadWithLoader, loadCloseableWithLoader, loadWithLoader

Methods inherited from interface com.dtolabs.rundeck.core.plugins.ProviderRegistryService

isCacheInstances, registerClass, registerInstance, setCacheInstances

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME

See Also:

Constant Field Values

Constructor Detail

ResourceModelSourceService

public ResourceModelSourceService(Framework framework)

Method Detail

getBundledProviderNames

public java.util.List<java.lang.String> getBundledProviderNames()

getName

public java.lang.String getName()

Specified by:

getName in interface FrameworkSupportService

Returns:

the name used to identify the service

getInstanceForFramework

public static ResourceModelSourceService getInstanceForFramework(Framework framework)

getSourceForConfiguration

public ResourceModelSource getSourceForConfiguration(java.lang.String type,
                                                     java.util.Properties configuration)
                                              throws ExecutionServiceException

Parameters:

configuration - configuration

type - provider name

Returns:

a ResourceModelSource of a give type with a given configuration, without retention

Throws:

ExecutionServiceException - on error

getCloseableSourceForConfiguration

public CloseableProvider<ResourceModelSource> getCloseableSourceForConfiguration(java.lang.String type,
                                                                                 java.util.Properties configuration)
                                                                          throws ExecutionServiceException

Parameters:

configuration - configuration

type - provider name

Returns:

a ResourceModelSource of a give type with a given configuration with a closeable

Throws:

ExecutionServiceException - on error

getCloseableSourceForConfiguration

public CloseableProvider<ResourceModelSource> getCloseableSourceForConfiguration(java.lang.String type,
                                                                                 java.util.Properties configuration,
                                                                                 Services services)
                                                                          throws ExecutionServiceException

Parameters:

configuration - configuration

type - provider name

Returns:

a ResourceModelSource of a give type with a given configuration with a closeable

Throws:

ExecutionServiceException - on error

factoryConverter

public static java.util.function.Function<ResourceModelSourceFactory,ResourceModelSource> factoryConverter(java.util.Properties configuration)

Given input configuration, produce a function to convert from a factory to model source

Parameters:

configuration -

Returns:

factoryConverter

public static java.util.function.Function<ResourceModelSourceFactory,ResourceModelSource> factoryConverter(Services services,
                                                                                                           java.util.Properties configuration)

Given input configuration, produce a function to convert from a factory to model source

Parameters:

configuration -

Returns:

isValidProviderClass

public boolean isValidProviderClass(java.lang.Class clazz)

Specified by:

isValidProviderClass in interface JavaClassProviderLoadable<ResourceModelSourceFactory>

Parameters:

clazz - the class

Returns:

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

createProviderInstance

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

Specified by:

createProviderInstance in interface JavaClassProviderLoadable<ResourceModelSourceFactory>

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

createScriptProviderInstance

public ResourceModelSourceFactory createScriptProviderInstance(ScriptPluginProvider provider)
                                                        throws PluginException

Specified by:

createScriptProviderInstance in interface ScriptPluginProviderLoadable<ResourceModelSourceFactory>

Parameters:

provider - the script plugin provider

Returns:

the instance for a ScriptPluginProvider definition

Throws:

PluginException - if the plugin has an error

getProviderForConfiguration

public ResourceModelSource getProviderForConfiguration(java.lang.String type,
                                                       java.util.Properties configuration)
                                                throws ExecutionServiceException

Specified by:

getProviderForConfiguration in interface ConfigurableService<ResourceModelSource>

Parameters:

type - provider name

configuration - configuration properties

Returns:

a ResourceModelSource of a give type with a given configuration

Throws:

ExecutionServiceException - on error

getCloseableProviderForConfiguration

public CloseableProvider<ResourceModelSource> getCloseableProviderForConfiguration(java.lang.String type,
                                                                                   java.util.Properties configuration)
                                                                            throws ExecutionServiceException

Description copied from interface: ConfigurableService

Return a provider of type T which can be closed

Specified by:

getCloseableProviderForConfiguration in interface ConfigurableService<ResourceModelSource>

Parameters:

type - plugin type

configuration - configuration properties

Returns:

closeable provider of T

Throws:

ExecutionServiceException

listDescriptions

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

Specified by:

listDescriptions in interface DescribableService

listDescribableProviders

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

Specified by:

listDescribableProviders in interface DescribableService