Package com.dtolabs.rundeck.core.execution.service

Class FileCopierService

java.lang.Object

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

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

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

com.dtolabs.rundeck.core.execution.service.NodeSpecifiedService<FileCopier>

com.dtolabs.rundeck.core.execution.service.FileCopierService

All Implemented Interfaces:

FrameworkSupportService, ProviderService<FileCopier>, DescribableService, JavaClassProviderLoadable<FileCopier>, PluggableProviderService<FileCopier>, PluggableService<FileCopier>, ProviderRegistryService<FileCopier>, ScriptPluginProviderLoadable<FileCopier>

public class FileCopierService
extends NodeSpecifiedService<FileCopier>
implements DescribableService, PluggableProviderService<FileCopier>, JavaClassProviderLoadable<FileCopier>, ScriptPluginProviderLoadable<FileCopier>

FileCopierService is ...

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_LOCAL_PROVIDER
static java.lang.String	DEFAULT_REMOTE_PROVIDER
static java.lang.String	LOCAL_NODE_SERVICE_SPECIFIER_ATTRIBUTE
static java.lang.String	REMOTE_NODE_SERVICE_SPECIFIER_ATTRIBUTE
static java.lang.String	SERVICE_DEFAULT_PROVIDER_PROPERTY

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	Description
FileCopierService(Framework framework)

Method Summary

Modifier and Type	Method	Description
<X extends FileCopier> FileCopier	createProviderInstance(java.lang.Class<X> clazz, java.lang.String name)
FileCopier	createScriptProviderInstance(ScriptPluginProvider provider)
java.util.List<java.lang.String>	getBundledProviderNames()
java.lang.String	getDefaultProviderNameForNodeAndProject(INodeEntry node, java.lang.String project)
static FileCopierService	getInstanceForFramework(Framework framework, IServicesRegistration registration)
java.lang.String	getName()
static java.lang.String	getNodeAttributeForProvider(boolean isLocal)
static java.lang.String	getProviderNameForNode(boolean isLocal, IRundeckProjectConfig iRundeckProjectConfig)
java.lang.String	getServiceProviderNodeAttributeForNode(INodeEntry node)
static boolean	isRegistered(java.lang.String name)
boolean	isValidProviderClass(java.lang.Class clazz)
java.util.List<ProviderIdent>	listDescribableProviders()
java.util.List<Description>	listDescriptions()

Methods inherited from class com.dtolabs.rundeck.core.execution.service.NodeSpecifiedService

getProviderForNodeAndProject

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.plugins.PluggableService

canLoadWithLoader, loadCloseableWithLoader, loadWithLoader

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

isCacheInstances, registerClass, registerInstance, setCacheInstances

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

closeableProviderOfType, listProviders, providerOfType

Field Detail

SERVICE_DEFAULT_PROVIDER_PROPERTY

public static final java.lang.String SERVICE_DEFAULT_PROVIDER_PROPERTY

See Also:

Constant Field Values

REMOTE_NODE_SERVICE_SPECIFIER_ATTRIBUTE

public static final java.lang.String REMOTE_NODE_SERVICE_SPECIFIER_ATTRIBUTE

See Also:

Constant Field Values

LOCAL_NODE_SERVICE_SPECIFIER_ATTRIBUTE

public static final java.lang.String LOCAL_NODE_SERVICE_SPECIFIER_ATTRIBUTE

See Also:

Constant Field Values

DEFAULT_REMOTE_PROVIDER

public static final java.lang.String DEFAULT_REMOTE_PROVIDER

See Also:

Constant Field Values

DEFAULT_LOCAL_PROVIDER

public static final java.lang.String DEFAULT_LOCAL_PROVIDER

See Also:

Constant Field Values

Constructor Detail

FileCopierService

public FileCopierService(Framework framework)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface FrameworkSupportService

Returns:

the name used to identify the service

getBundledProviderNames

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

isRegistered

public static boolean isRegistered(java.lang.String name)

getDefaultProviderNameForNodeAndProject

public java.lang.String getDefaultProviderNameForNodeAndProject(INodeEntry node,
                                                                java.lang.String project)

Specified by:

getDefaultProviderNameForNodeAndProject in class NodeSpecifiedService<FileCopier>

Parameters:

node - node

project - project

Returns:

name of default provider for this service

getProviderNameForNode

public static java.lang.String getProviderNameForNode(boolean isLocal,
                                                      IRundeckProjectConfig iRundeckProjectConfig)

getInstanceForFramework

public static FileCopierService getInstanceForFramework(Framework framework,
                                                        IServicesRegistration registration)

getServiceProviderNodeAttributeForNode

public java.lang.String getServiceProviderNodeAttributeForNode(INodeEntry node)

Specified by:

getServiceProviderNodeAttributeForNode in class NodeSpecifiedService<FileCopier>

Parameters:

node - node

Returns:

name of Node attribute that specifies the service provider name for this service.

getNodeAttributeForProvider

public static java.lang.String getNodeAttributeForProvider(boolean isLocal)

isValidProviderClass

public boolean isValidProviderClass(java.lang.Class clazz)

Specified by:

isValidProviderClass in interface JavaClassProviderLoadable<FileCopier>

Parameters:

clazz - the class

Returns:

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

createProviderInstance

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

Specified by:

createProviderInstance in interface JavaClassProviderLoadable<FileCopier>

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 FileCopier createScriptProviderInstance(ScriptPluginProvider provider)
                                        throws PluginException

Specified by:

createScriptProviderInstance in interface ScriptPluginProviderLoadable<FileCopier>

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()

Specified by:

listDescriptions in interface DescribableService

listDescribableProviders

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

Specified by:

listDescribableProviders in interface DescribableService