Package hudson.plugins.groovy

Class ScriptSource

java.lang.Object

hudson.plugins.groovy.ScriptSource

All Implemented Interfaces:

Describable<ScriptSource>

Direct Known Subclasses:

FileScriptSource, StringScriptSource

public abstract class ScriptSource
extends Object
implements Describable<ScriptSource>

Base interface for Groovy script sources.

Author:

dvrzalik

Constructor Summary

Constructors

Constructor	Description
ScriptSource()

Method Summary

Modifier and Type	Method	Description
static final DescriptorExtensionList<ScriptSource,Descriptor<ScriptSource>>	all()
Descriptor<ScriptSource>	getDescriptor()
FilePath	getScriptFile(FilePath projectWorkspace)	Deprecated. Unused.
abstract FilePath	getScriptFile(FilePath projectWorkspace, AbstractBuild<?,?> build, BuildListener listener)	Able to load script when script path contains parameters
InputStream	getScriptStream(FilePath projectWorkspace)	Deprecated. Unused
InputStream	getScriptStream(FilePath projectWorkspace, AbstractBuild<?,?> build, BuildListener listener)	Deprecated. Unused.

Methods inherited from class java.lang.Object

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

Constructor Details

ScriptSource

public ScriptSource()

Method Details

getScriptFile

public abstract FilePath getScriptFile(FilePath projectWorkspace,
 AbstractBuild<?,?> build,
 BuildListener listener)
                                throws IOException,
InterruptedException

Able to load script when script path contains parameters

Parameters:

projectWorkspace - Project workspace to create tmp file

build - - needed to obtain environment variables

listener - - build listener needed by Environment

Returns:

Path to the executed script file

Throws:

IOException

InterruptedException

getScriptStream

@Deprecated
public InputStream getScriptStream(FilePath projectWorkspace,
 AbstractBuild<?,?> build,
 BuildListener listener)
                            throws IOException,
InterruptedException

Deprecated.

Unused.

Returns:

Stream containing the script, able to load script when script path contains parameters

Throws:

IOException

InterruptedException

getScriptFile

@Deprecated
public FilePath getScriptFile(FilePath projectWorkspace)
                       throws IOException,
InterruptedException

Deprecated.

Unused.

In the end, every script is a file...

Parameters:

projectWorkspace - Project workspace (useful when the source has to create temporary file)

Returns:

Path to the executed script file

Throws:

IOException

InterruptedException

getScriptStream

@Deprecated
public InputStream getScriptStream(FilePath projectWorkspace)
                            throws IOException,
InterruptedException

Deprecated.

Unused

Throws:

IOException

InterruptedException

getDescriptor

public Descriptor<ScriptSource> getDescriptor()

Specified by:

getDescriptor in interface Describable<ScriptSource>

all

public static final DescriptorExtensionList<ScriptSource,Descriptor<ScriptSource>> all()