Package org.jenkinsci.plugins.scriptsecurity.sandbox.groovy

Class SecureGroovyScript

java.lang.Object

hudson.model.AbstractDescribableImpl<SecureGroovyScript>

org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SecureGroovyScript

All Implemented Interfaces:

Describable<SecureGroovyScript>, Serializable

public final class SecureGroovyScript
extends AbstractDescribableImpl<SecureGroovyScript>
implements Serializable

Convenience structure encapsulating a Groovy script that may either be approved whole or sandboxed. May be kept as the value of a field and passed in a DataBoundConstructor parameter; you must call configuring(org.jenkinsci.plugins.scriptsecurity.scripts.ApprovalContext) or a related method from your own constructor. Use <f:property field="…"/> to configure it from Jelly.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SecureGroovyScript.DescriptorImpl

Constructor Summary

Constructors

Constructor	Description
SecureGroovyScript(String script, boolean sandbox)	Deprecated.
SecureGroovyScript(String script, boolean sandbox, List<ClasspathEntry> classpath)

Method Summary

Modifier and Type	Method	Description
SecureGroovyScript	configuring(ApprovalContext context)	To be called in your own DataBoundConstructor when storing the field of this type.
SecureGroovyScript	configuringWithKeyItem()	Convenience form of configuring(org.jenkinsci.plugins.scriptsecurity.scripts.ApprovalContext) that calls ApprovalContext.withCurrentUser() and ApprovalContext.withItemAsKey(hudson.model.Item).
SecureGroovyScript	configuringWithNonKeyItem()	Convenience form of configuring(org.jenkinsci.plugins.scriptsecurity.scripts.ApprovalContext) that calls ApprovalContext.withCurrentUser() and ApprovalContext.withItem(hudson.model.Item).
Object	evaluate(ClassLoader loader, groovy.lang.Binding binding)	Deprecated. use evaluate(ClassLoader, Binding, TaskListener)
Object	evaluate(ClassLoader loader, groovy.lang.Binding binding, TaskListener listener)	Runs the Groovy script, using the sandbox if so configured.
List<ClasspathEntry>	getClasspath()
String	getOldScript()
String	getScript()
boolean	isSandbox()
boolean	isScriptAutoApprovalEnabled()
void	setOldScript(String oldScript)

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

SecureGroovyScript

@DataBoundConstructor
public SecureGroovyScript(@NonNull
 String script,
 boolean sandbox,
 @CheckForNull
 List<ClasspathEntry> classpath)

SecureGroovyScript

@Deprecated
public SecureGroovyScript(@NonNull
 String script,
 boolean sandbox)

Deprecated.

Method Details

getScript

@NonNull
public String getScript()

isSandbox

public boolean isSandbox()

getClasspath

@NonNull
public List<ClasspathEntry> getClasspath()

getOldScript

public String getOldScript()

setOldScript

@DataBoundSetter
public void setOldScript(String oldScript)

isScriptAutoApprovalEnabled

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public boolean isScriptAutoApprovalEnabled()

configuring

public SecureGroovyScript configuring(ApprovalContext context)

To be called in your own DataBoundConstructor when storing the field of this type.

Parameters:

context - an approval context

Returns:

this object

configuringWithKeyItem

public SecureGroovyScript configuringWithKeyItem()

Convenience form of configuring(org.jenkinsci.plugins.scriptsecurity.scripts.ApprovalContext) that calls ApprovalContext.withCurrentUser() and ApprovalContext.withItemAsKey(hudson.model.Item).

configuringWithNonKeyItem

public SecureGroovyScript configuringWithNonKeyItem()

Convenience form of configuring(org.jenkinsci.plugins.scriptsecurity.scripts.ApprovalContext) that calls ApprovalContext.withCurrentUser() and ApprovalContext.withItem(hudson.model.Item).

evaluate

@Deprecated
public Object evaluate(ClassLoader loader,
 groovy.lang.Binding binding)
                throws Exception

Deprecated.

use evaluate(ClassLoader, Binding, TaskListener)

Throws:

Exception

evaluate

public Object evaluate(ClassLoader loader,
 groovy.lang.Binding binding,
 @CheckForNull
 TaskListener listener)
                throws Exception

Runs the Groovy script, using the sandbox if so configured.

Parameters:

loader - a class loader for constructing the shell, such as PluginManager.uberClassLoader (will be augmented by getClasspath() if nonempty)

binding - Groovy variable bindings

listener - a way to print messages

Returns:

the result of evaluating script using GroovyShell.evaluate(String)

Throws:

Exception - in case of a general problem

RejectedAccessException - in case of a sandbox issue

UnapprovedUsageException - in case of a non-sandbox issue

UnapprovedClasspathException - in case some unapproved classpath entries were requested