Package org.jenkinsci.plugins.workflow.cps

Class CpsScript

java.lang.Object

groovy.lang.GroovyObjectSupport

groovy.lang.Script

com.cloudbees.groovy.cps.SerializableScript

org.jenkinsci.plugins.workflow.cps.CpsScript

All Implemented Interfaces:

groovy.lang.GroovyObject, Serializable

public abstract class CpsScript
extends SerializableScript

The script of a workflow. Every Script we load in Pipeline execution derives from this subtype.

Author:

Kohsuke Kawaguchi

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CpsScript()	Default constructor for CpsFlowExecution.

Method Summary

Modifier and Type	Method	Description
Run<?,?>	$build()
Run<?,?>	$buildNoException()
Object	evaluate(File file)
Object	evaluate(String script)
Object	getProperty(String property)
Object	invokeMethod(String name, Object args)	We use DSL here to try invoke the step implementation, if there is Step implementation found it's handled or it's an error.
void	print(Object value)
void	printf(String format, Object value)
void	printf(String format, Object[] values)
void	println()
void	println(Object value)
protected Object	readResolve()
void	run(File file, String[] arguments)
Object	sleep(long arg)	Effectively overrides DefaultGroovyStaticMethods.sleep(Object, long) so that SleepStep works even in the bare form sleep 5.

Methods inherited from class groovy.lang.Script

getBinding, run, setBinding, setProperty

Methods inherited from class groovy.lang.GroovyObjectSupport

getMetaClass, setMetaClass

Methods inherited from class java.lang.Object

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

Constructor Detail

CpsScript

public CpsScript()
          throws IOException

Default constructor for CpsFlowExecution.

Throws:

IOException

Method Detail

invokeMethod

public final Object invokeMethod(String name,
                                 Object args)

We use DSL here to try invoke the step implementation, if there is Step implementation found it's handled or it's an error.

sandbox security execution relies on the assumption that CpsScript.invokeMethod() is safe for sandboxed code. That means we cannot let user-written script override this method, hence the final.

Specified by:

invokeMethod in interface groovy.lang.GroovyObject

Overrides:

invokeMethod in class groovy.lang.Script

getProperty

public Object getProperty(String property)

Specified by:

getProperty in interface groovy.lang.GroovyObject

Overrides:

getProperty in class groovy.lang.Script

$build

@CheckForNull
public Run<?,?> $build()
                      throws IOException

Throws:

IOException

$buildNoException

@CheckForNull
public Run<?,?> $buildNoException()

evaluate

public Object evaluate(String script)
                throws org.codehaus.groovy.control.CompilationFailedException

Overrides:

evaluate in class groovy.lang.Script

Throws:

org.codehaus.groovy.control.CompilationFailedException

evaluate

public Object evaluate(File file)
                throws org.codehaus.groovy.control.CompilationFailedException,
                       IOException

Overrides:

evaluate in class groovy.lang.Script

Throws:

org.codehaus.groovy.control.CompilationFailedException

IOException

run

public void run(File file,
                String[] arguments)
         throws org.codehaus.groovy.control.CompilationFailedException,
                IOException

Overrides:

run in class groovy.lang.Script

Throws:

org.codehaus.groovy.control.CompilationFailedException

IOException

readResolve

protected Object readResolve()

println

public void println()

Overrides:

println in class groovy.lang.Script

print

public void print(Object value)

Overrides:

print in class groovy.lang.Script

println

public void println(Object value)

Overrides:

println in class groovy.lang.Script

printf

public void printf(String format,
                   Object value)

Overrides:

printf in class groovy.lang.Script

printf

public void printf(String format,
                   Object[] values)

Overrides:

printf in class groovy.lang.Script

sleep

public Object sleep(long arg)

Effectively overrides DefaultGroovyStaticMethods.sleep(Object, long) so that SleepStep works even in the bare form sleep 5.

See Also:

CpsClosure2.sleep(long)