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.

  • Constructor Details

    • AbstractWhitelist

      public AbstractWhitelist()

  • Method Details

    • 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