Package com.dtolabs.rundeck.core.execution.script

Class ScriptfileUtils

java.lang.Object

com.dtolabs.rundeck.core.execution.script.ScriptfileUtils

public class ScriptfileUtils
extends java.lang.Object

Utility methods for writing temp files for scripts and setting file permissions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScriptfileUtils.LineEndingStyle	Line ending style

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ScriptfileUtils()

Method Summary

Modifier and Type	Method	Description
static java.io.File	createTempFile(Framework framework)	Deprecated.
static java.io.File	createTempFile(IFramework framework)	Creates a temp file and marks it for deleteOnExit, to clean up proactively call releaseTempFile(java.io.File) with the result when complete
static ScriptfileUtils.LineEndingStyle	lineEndingStyleForNode(INodeEntry node)
static boolean	releaseTempFile(java.io.File file)	Remove a file that may have been created by createTempFile(com.dtolabs.rundeck.core.common.Framework).
static void	setExecutePermissions(java.io.File scriptfile)	Set the executable flag on a file if supported by the OS
static boolean	shouldAddBomForNode(INodeEntry node)
static void	writeScriptFile(java.io.InputStream stream, java.lang.String scriptString, java.io.Reader reader, ScriptfileUtils.LineEndingStyle style, java.io.File scriptfile)	Write script content to a destination file from one of the sources
static void	writeScriptFile(java.io.InputStream stream, java.lang.String scriptString, java.io.Reader reader, ScriptfileUtils.LineEndingStyle style, java.io.File scriptfile, boolean addBom)	Write script content to a destination file from one of the sources
static void	writeScriptFile(java.io.InputStream stream, java.lang.String scriptString, java.io.Reader reader, ScriptfileUtils.LineEndingStyle style, java.io.File scriptfile, boolean addBom, FileCopierUtil.ContentModifier modifier)	Write script content to a destination file from one of the sources
static java.io.File	writeScriptTempfile(Framework framework, java.io.InputStream stream, java.lang.String source, java.io.Reader reader, ScriptfileUtils.LineEndingStyle style)	Copy a source stream or string content to a tempfile for script execution
static java.io.File	writeScriptTempfile(Framework framework, java.io.Reader source, ScriptfileUtils.LineEndingStyle style)	Copy reader content to a tempfile for script execution

Methods inherited from class java.lang.Object

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

Field Detail

SHOULD_ADD_BOM

public static final java.lang.String SHOULD_ADD_BOM

See Also:

Constant Field Values

Constructor Detail

ScriptfileUtils

public ScriptfileUtils()

Method Detail

lineEndingStyleForNode

public static ScriptfileUtils.LineEndingStyle lineEndingStyleForNode(INodeEntry node)

Parameters:

node - node

Returns:

the line ending style for the node, based on the osFamily, or use LOCAL if undetermined

shouldAddBomForNode

public static boolean shouldAddBomForNode(INodeEntry node)

writeScriptTempfile

public static java.io.File writeScriptTempfile(Framework framework,
                                               java.io.Reader source,
                                               ScriptfileUtils.LineEndingStyle style)
                                        throws java.io.IOException

Copy reader content to a tempfile for script execution

Parameters:

framework - framework

source - string content

style - style

Returns:

tempfile

Throws:

java.io.IOException - if an error occurs

writeScriptTempfile

public static java.io.File writeScriptTempfile(Framework framework,
                                               java.io.InputStream stream,
                                               java.lang.String source,
                                               java.io.Reader reader,
                                               ScriptfileUtils.LineEndingStyle style)
                                        throws java.io.IOException

Copy a source stream or string content to a tempfile for script execution

Parameters:

framework - framework

stream - source stream

source - content

style - file line ending style to use

reader - reader

Returns:

tempfile

Throws:

java.io.IOException - if an error occurs

writeScriptFile

public static void writeScriptFile(java.io.InputStream stream,
                                   java.lang.String scriptString,
                                   java.io.Reader reader,
                                   ScriptfileUtils.LineEndingStyle style,
                                   java.io.File scriptfile,
                                   boolean addBom)
                            throws java.io.IOException

Write script content to a destination file from one of the sources

Parameters:

stream - stream source

scriptString - script content

reader - reader source

style - line ending style

scriptfile - destination file

Throws:

java.io.IOException - on io error

writeScriptFile

public static void writeScriptFile(java.io.InputStream stream,
                                   java.lang.String scriptString,
                                   java.io.Reader reader,
                                   ScriptfileUtils.LineEndingStyle style,
                                   java.io.File scriptfile,
                                   boolean addBom,
                                   FileCopierUtil.ContentModifier modifier)
                            throws java.io.IOException

Write script content to a destination file from one of the sources

Parameters:

stream - stream source

scriptString - script content

reader - reader source

style - line ending style

scriptfile - destination file

Throws:

java.io.IOException - on io error

writeScriptFile

public static void writeScriptFile(java.io.InputStream stream,
                                   java.lang.String scriptString,
                                   java.io.Reader reader,
                                   ScriptfileUtils.LineEndingStyle style,
                                   java.io.File scriptfile)
                            throws java.io.IOException

Write script content to a destination file from one of the sources

Parameters:

stream - stream source

scriptString - script content

reader - reader source

style - line ending style

scriptfile - destination file

Throws:

java.io.IOException - on io error

createTempFile

@Deprecated
public static java.io.File createTempFile(Framework framework)
                                   throws java.io.IOException

Deprecated.

Creates a temp file and marks it for deleteOnExit, to clean up proactively call releaseTempFile(java.io.File) with the result when complete

Parameters:

framework - fwk

Returns:

Create a temp file in the framework

Throws:

java.io.IOException - on io error

createTempFile

public static java.io.File createTempFile(IFramework framework)
                                   throws java.io.IOException

Creates a temp file and marks it for deleteOnExit, to clean up proactively call releaseTempFile(java.io.File) with the result when complete

Parameters:

framework - fwk

Returns:

Create a temp file in the framework

Throws:

java.io.IOException - on io error

releaseTempFile

public static boolean releaseTempFile(java.io.File file)

Remove a file that may have been created by createTempFile(com.dtolabs.rundeck.core.common.Framework). If the file was not created that way, it will not be deleted.

Parameters:

file - a temp file created with createTempFile(com.dtolabs.rundeck.core.common.Framework)

Returns:

true if the temp file was known and was deleted

setExecutePermissions

public static void setExecutePermissions(java.io.File scriptfile)
                                  throws java.io.IOException

Set the executable flag on a file if supported by the OS

Parameters:

scriptfile - target file

Throws:

java.io.IOException - if an error occurs