org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists

Class StaticWhitelist

java.lang.Object

org.jenkinsci.plugins.scriptsecurity.sandbox.Whitelist

org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.EnumeratingWhitelist

org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.StaticWhitelist

All Implemented Interfaces:

hudson.ExtensionPoint

public final class StaticWhitelist
extends EnumeratingWhitelist

Whitelist based on a static file.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
StaticWhitelist(Collection<? extends String> lines)
StaticWhitelist(Reader definition)

Method Summary

Methods

Modifier and Type	Method and Description
static String	fieldDefinition(Object receiver, String field)
protected List<org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.EnumeratingWhitelist.FieldSignature>	fieldSignatures()
static Whitelist	from(URL definition)
static String	methodDefinition(Object receiver, String method, Object[] args) Looks up the most general possible definition of a given method call.
protected List<org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.EnumeratingWhitelist.MethodSignature>	methodSignatures()
static String	newDefinition(Class<?> receiver, Object[] args)
protected List<org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.EnumeratingWhitelist.NewSignature>	newSignatures()
static String	staticMethodDefinition(Class<?> receiver, String method, Object[] args)
protected List<org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.EnumeratingWhitelist.StaticMethodSignature>	staticMethodSignatures()

Methods inherited from class org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.EnumeratingWhitelist

permitsFieldGet, permitsFieldSet, permitsMethod, permitsNew, permitsStaticMethod

Methods inherited from class org.jenkinsci.plugins.scriptsecurity.sandbox.Whitelist

all

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticWhitelist

public StaticWhitelist(Reader definition)
                throws IOException

Throws:

IOException

StaticWhitelist

public StaticWhitelist(Collection<? extends String> lines)
                throws IOException

Throws:

IOException

Method Detail

from

public static Whitelist from(URL definition)
                      throws IOException

Throws:

IOException

methodSignatures

protected List<org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.EnumeratingWhitelist.MethodSignature> methodSignatures()

Specified by:

methodSignatures in class EnumeratingWhitelist

newSignatures

protected List<org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.EnumeratingWhitelist.NewSignature> newSignatures()

Specified by:

newSignatures in class EnumeratingWhitelist

staticMethodSignatures

protected List<org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.EnumeratingWhitelist.StaticMethodSignature> staticMethodSignatures()

Specified by:

staticMethodSignatures in class EnumeratingWhitelist

fieldSignatures

protected List<org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.EnumeratingWhitelist.FieldSignature> fieldSignatures()

Specified by:

fieldSignatures in class EnumeratingWhitelist

methodDefinition

@CheckForNull
public static String methodDefinition(Object receiver,
                                   String method,
                                   Object[] args)

Looks up the most general possible definition of a given method call. Preferentially searches for compatible definitions in supertypes. The result (if not null) may be added to a static whitelist after the keyword method.

Parameters:

receiver - an actual receiver object

method - the method name

args - a set of actual arguments

Returns:

a definition in the format receiver.class.Name methodName parameter1.Type parameter2.Type, or null if not found

newDefinition

@CheckForNull
public static String newDefinition(Class<?> receiver,
                                Object[] args)

staticMethodDefinition

@CheckForNull
public static String staticMethodDefinition(Class<?> receiver,
                                         String method,
                                         Object[] args)

fieldDefinition

@CheckForNull
public static String fieldDefinition(Object receiver,
                                  String field)