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

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

FileCopier	createProviderInstance(java.lang.Class<FileCopier> clazz, java.lang.String name) Create provider instance from a class
FileCopier	createScriptProviderInstance(ScriptPluginProvider provider) Return the instance for a ScriptPluginProvider definition
protected java.lang.String	getDefaultProviderNameForNodeAndProject(INodeEntry node, java.lang.String project) Return name of default provider for this service
static FileCopierService	getInstanceForFramework(Framework framework)
java.lang.String	getName() Return the name used to identify the service
protected java.lang.String	getServiceProviderNodeAttributeForNode(INodeEntry node) Return name of Node attribute that specifies the service provider name for this service.
boolean	isScriptPluggable() Return true if the service supports script plugins
boolean	isValidProviderClass(java.lang.Class clazz) Return true if the class is a valid provider class for the service
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

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

Description copied from interface: FrameworkSupportService

Return the name used to identify the service

Specified by:

getName in interface FrameworkSupportService

getDefaultProviderNameForNodeAndProject

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

Description copied from class: NodeSpecifiedService

Return name of default provider for this service

Specified by:

getDefaultProviderNameForNodeAndProject in class NodeSpecifiedService<FileCopier>

getInstanceForFramework

public static FileCopierService getInstanceForFramework(Framework framework)

getServiceProviderNodeAttributeForNode

protected java.lang.String getServiceProviderNodeAttributeForNode(INodeEntry node)

Description copied from class: NodeSpecifiedService

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

Specified by:

getServiceProviderNodeAttributeForNode in class NodeSpecifiedService<FileCopier>

isValidProviderClass

public boolean isValidProviderClass(java.lang.Class clazz)

Description copied from interface: PluggableService

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

Specified by:

isValidProviderClass in interface PluggableService<FileCopier>

Parameters:

clazz - the class

createProviderInstance

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

Description copied from interface: PluggableService

Create provider instance from a class

Specified by:

createProviderInstance in interface PluggableService<FileCopier>

Parameters:

clazz - the class

name - the provider name

Throws:

PluginException

ProviderCreationException

isScriptPluggable

public boolean isScriptPluggable()

Description copied from interface: PluggableService

Return true if the service supports script plugins

Specified by:

isScriptPluggable in interface PluggableService<FileCopier>

createScriptProviderInstance

public FileCopier createScriptProviderInstance(ScriptPluginProvider provider)
                                        throws PluginException

Description copied from interface: PluggableService

Return the instance for a ScriptPluginProvider definition

Specified by:

createScriptProviderInstance in interface PluggableService<FileCopier>

Parameters:

provider - the script plugin provider

Throws:

PluginException

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