com.dtolabs.rundeck.core.execution.service

Class ScriptPluginFileCopier

java.lang.Object

com.dtolabs.rundeck.core.plugins.AbstractDescribableScriptPlugin

com.dtolabs.rundeck.core.plugins.BaseScriptPlugin

com.dtolabs.rundeck.core.execution.service.ScriptPluginFileCopier

All Implemented Interfaces:

ProxySecretBundleCreator, FileCopier, Describable

public class ScriptPluginFileCopier
extends BaseScriptPlugin
implements FileCopier

ScriptPluginFileCopier wraps the execution of the script and supplies the FileCopier interface.

Field Summary

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

CONFIG_DEFAULT, CONFIG_DESCRIPTION, CONFIG_LABELS, CONFIG_NAME, CONFIG_PROP_PREFIX, CONFIG_RENDERING_OPTIONS, CONFIG_REQUIRED, CONFIG_SCOPE, CONFIG_TITLE, CONFIG_TYPE, CONFIG_VALUES, DESCRIPTION_PROP, SETTING_MERGE_ENVIRONMENT, TITLE_PROP

Constructor Summary

Constructors

Constructor and Description
ScriptPluginFileCopier(ScriptPluginProvider provider, Framework framework)

Method Summary

Modifier and Type	Method and Description
java.lang.String	copyFile(ExecutionContext executionContext, java.io.File file, INodeEntry node, java.lang.String destination) Copy existing file
java.lang.String	copyFileStream(ExecutionContext executionContext, java.io.InputStream inputStream, INodeEntry node, java.lang.String destination) Copy inputstream
java.lang.String	copyScriptContent(ExecutionContext executionContext, java.lang.String s, INodeEntry node, java.lang.String destination) Copy string content
boolean	isAllowCustomProperties()
boolean	isUseConventionalPropertiesMapping()

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

createScriptArgs, createScriptArgsList, createScriptDataContext, createScriptDataContext, createStepItemDataContext, getScriptExecHelper, prepareSecretBundle, prepareSecretBundleWorkflowNodeStep, prepareSecretBundleWorkflowStep, runPluginScript, setScriptExecHelper

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

createDescription, createDescription, createPluginData, getDescription, getFramework, getProvider, loadConfigData, loadContentConversionPropertyValues, loadInstanceDataFromNodeAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptPluginFileCopier

public ScriptPluginFileCopier(ScriptPluginProvider provider,
                              Framework framework)

Method Detail

isAllowCustomProperties

public boolean isAllowCustomProperties()

Specified by:

isAllowCustomProperties in class AbstractDescribableScriptPlugin

Returns:

true if the script-plugin allows custom configuration properties defined in plugin metadata.

isUseConventionalPropertiesMapping

public boolean isUseConventionalPropertiesMapping()

Overrides:

isUseConventionalPropertiesMapping in class AbstractDescribableScriptPlugin

Returns:

true to provide conventional mapping from config properties to framework/project properties.

copyFileStream

public java.lang.String copyFileStream(ExecutionContext executionContext,
                                       java.io.InputStream inputStream,
                                       INodeEntry node,
                                       java.lang.String destination)
                                throws FileCopierException

Copy inputstream

Specified by:

copyFileStream in interface FileCopier

Parameters:

executionContext - context

inputStream - the input stream

node - node

destination - the full path destination for the file

Returns:

File path of the file after copying to the node

Throws:

FileCopierException - if an error occurs

copyFile

public java.lang.String copyFile(ExecutionContext executionContext,
                                 java.io.File file,
                                 INodeEntry node,
                                 java.lang.String destination)
                          throws FileCopierException

Copy existing file

Specified by:

copyFile in interface FileCopier

Parameters:

executionContext - context

file - local file tocopy

node - node

destination - the full path destination for the file

Returns:

File path of the file after copying to the node

Throws:

FileCopierException - if an error occurs

copyScriptContent

public java.lang.String copyScriptContent(ExecutionContext executionContext,
                                          java.lang.String s,
                                          INodeEntry node,
                                          java.lang.String destination)
                                   throws FileCopierException

Copy string content

Specified by:

copyScriptContent in interface FileCopier

Parameters:

executionContext - context

s - file content string

node - node

destination - the full path destination for the file

Returns:

File path of the file after copying to the node

Throws:

FileCopierException - if an error occurs