Package org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists

Class AbstractWhitelist

java.lang.Object

org.jenkinsci.plugins.scriptsecurity.sandbox.Whitelist

org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.AbstractWhitelist

All Implemented Interfaces:

ExtensionPoint

public abstract class AbstractWhitelist
extends Whitelist

Convenience whitelist base class that denies everything by default. Thus you need only override things you wish to explicitly allow. Also reduces the risk of incompatibilities in case further abstract methods are added to Whitelist.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
AbstractWhitelist()

Method Summary

Modifier and Type	Method	Description
boolean	permitsConstructor(Constructor<?> constructor, Object[] args)
boolean	permitsFieldGet(Field field, Object receiver)
boolean	permitsFieldSet(Field field, Object receiver, Object value)
boolean	permitsMethod(Method method, Object receiver, Object[] args)	Checks whether a given virtual method may be invoked.
boolean	permitsStaticFieldGet(Field field)
boolean	permitsStaticFieldSet(Field field, Object value)
boolean	permitsStaticMethod(Method method, Object[] args)

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

AbstractWhitelist

public AbstractWhitelist()

Method Detail

permitsMethod

public boolean permitsMethod(@NonNull
                             Method method,
                             @NonNull
                             Object receiver,
                             @NonNull
                             Object[] args)

Description copied from class: Whitelist

Checks whether a given virtual method may be invoked.

Note that method should not be implementing or overriding a method in a supertype; in such a case the caller must pass that supertype method instead. In other words, call site selection is the responsibility of the caller (such as GroovySandbox), not the whitelist.

Specified by:

permitsMethod in class Whitelist

Parameters:

method - a method defined in the JVM

receiver - this, the receiver of the method call

args - zero or more arguments

Returns:

true to allow the method to be called, false to reject it

permitsConstructor

public boolean permitsConstructor(@NonNull
                                  Constructor<?> constructor,
                                  @NonNull
                                  Object[] args)

Specified by:

permitsConstructor in class Whitelist

permitsStaticMethod

public boolean permitsStaticMethod(@NonNull
                                   Method method,
                                   @NonNull
                                   Object[] args)

Specified by:

permitsStaticMethod in class Whitelist

permitsFieldSet

public boolean permitsFieldSet(@NonNull
                               Field field,
                               @NonNull
                               Object receiver,
                               Object value)

Specified by:

permitsFieldSet in class Whitelist

permitsFieldGet

public boolean permitsFieldGet(@NonNull
                               Field field,
                               @NonNull
                               Object receiver)

Specified by:

permitsFieldGet in class Whitelist

permitsStaticFieldSet

public boolean permitsStaticFieldSet(@NonNull
                                     Field field,
                                     Object value)

Specified by:

permitsStaticFieldSet in class Whitelist

permitsStaticFieldGet

public boolean permitsStaticFieldGet(@NonNull
                                     Field field)

Specified by:

permitsStaticFieldGet in class Whitelist