com.dtolabs.rundeck.core.execution.service

Class FileCopierService

java.lang.Object

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, PluggableService<FileCopier>

public class FileCopierService
extends NodeSpecifiedService<FileCopier>
implements DescribableService

FileCopierService is ...

Field Summary

Fields

Modifier and Type	Field and 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, instanceregistry, registry

Method Summary

Modifier and Type	Method and 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()
protected java.lang.String	getDefaultProviderNameForNodeAndProject(INodeEntry node, java.lang.String project)
static FileCopierService	getInstanceForFramework(Framework framework)
java.lang.String	getName()
protected java.lang.String	getServiceProviderNodeAttributeForNode(INodeEntry node)
boolean	isScriptPluggable()
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, registerClass, registerInstance

Methods inherited from class java.lang.Object

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

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

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

getDefaultProviderNameForNodeAndProject

protected 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

getInstanceForFramework

public static FileCopierService getInstanceForFramework(Framework framework)

getServiceProviderNodeAttributeForNode

protected 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.

isValidProviderClass

public boolean isValidProviderClass(java.lang.Class clazz)

Specified by:

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

isScriptPluggable

public boolean isScriptPluggable()

Specified by:

isScriptPluggable in interface PluggableService<FileCopier>

Returns:

true if the service supports script plugins

createScriptProviderInstance

public FileCopier createScriptProviderInstance(ScriptPluginProvider provider)
                                        throws PluginException

Specified by:

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