org.kohsuke.groovy.sandbox

Class GroovyValueFilter

java.lang.Object

org.kohsuke.groovy.sandbox.GroovyInterceptor

org.kohsuke.groovy.sandbox.GroovyValueFilter

public class GroovyValueFilter
extends GroovyInterceptor

GroovyInterceptor that looks at individual values that are coming into/out of a call, without regard to any context.

One of the common strategies for filtering is to ensure that the sandboxed script don't acquire a reference to objects that they are not supposed to. This implementation works as a convenient base class for such interceptor by providing a smaller number of methods that can be overridden.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from class org.kohsuke.groovy.sandbox.GroovyInterceptor

GroovyInterceptor.Invoker

Constructor Summary

Constructors

Constructor and Description
GroovyValueFilter()

Method Summary

Modifier and Type	Method and Description
Object	filter(Object o) All the specific filterXXX() methods delegate to this method.
Object	filterArgument(Object arg) Called for every argument to method/constructor calls.
Object	filterIndex(Object index) Called for every index of the array get/set access.
Object	filterReceiver(Object receiver) Called for every receiver.
Object	filterReturnValue(Object returnValue) Called for a return value of a method call, newly created object, retrieve property/attribute values.
Object	onGetArray(GroovyInterceptor.Invoker invoker, Object receiver, Object index) Intercepts an array access, like "z=foo[bar]"
Object	onGetAttribute(GroovyInterceptor.Invoker invoker, Object receiver, String attribute) Intercepts an attribute access, like "z=foo.@bar"
Object	onGetProperty(GroovyInterceptor.Invoker invoker, Object receiver, String property) Intercepts a property access, like "z=foo.bar"
Object	onMethodCall(GroovyInterceptor.Invoker invoker, Object receiver, String method, Object... args) Intercepts an instance method call on some object of the form "foo.bar(...)"
Object	onNewInstance(GroovyInterceptor.Invoker invoker, Class receiver, Object... args) Intercepts an object instantiation, like "new Receiver(...)"
Object	onSetArray(GroovyInterceptor.Invoker invoker, Object receiver, Object index, Object value) Intercepts an attribute assignment like "foo[bar]=z"
Object	onSetAttribute(GroovyInterceptor.Invoker invoker, Object receiver, String attribute, Object value) Intercepts an attribute assignment like "foo.@bar=z"
Object	onSetProperty(GroovyInterceptor.Invoker invoker, Object receiver, String property, Object value) Intercepts a property assignment like "foo.bar=z"
Object	onStaticCall(GroovyInterceptor.Invoker invoker, Class receiver, String method, Object... args) Intercepts a static method call on some class, like "Class.forName(...)".

Methods inherited from class org.kohsuke.groovy.sandbox.GroovyInterceptor

getApplicableInterceptors, onSuperCall, onSuperConstructor, register, unregister

Methods inherited from class java.lang.Object

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

Constructor Detail

GroovyValueFilter

public GroovyValueFilter()

Method Detail

filterReceiver

public Object filterReceiver(Object receiver)

Called for every receiver.

filterReturnValue

public Object filterReturnValue(Object returnValue)

Called for a return value of a method call, newly created object, retrieve property/attribute values.

filterArgument

public Object filterArgument(Object arg)

Called for every argument to method/constructor calls.

filterIndex

public Object filterIndex(Object index)

Called for every index of the array get/set access.

filter

public Object filter(Object o)

All the specific filterXXX() methods delegate to this method.

onMethodCall

public Object onMethodCall(GroovyInterceptor.Invoker invoker,
                           Object receiver,
                           String method,
                           Object... args)
                    throws Throwable

Description copied from class: GroovyInterceptor

Intercepts an instance method call on some object of the form "foo.bar(...)"

Overrides:

onMethodCall in class GroovyInterceptor

Throws:

Throwable

onStaticCall

public Object onStaticCall(GroovyInterceptor.Invoker invoker,
                           Class receiver,
                           String method,
                           Object... args)
                    throws Throwable

Description copied from class: GroovyInterceptor

Intercepts a static method call on some class, like "Class.forName(...)". Note that Groovy doesn't clearly differentiate static method calls from instance method calls. If calls are determined to be static at compile-time, you get this method called, but method calls whose receivers are Class can invoke static methods, too (that is, x=Integer.class;x.valueOf(5) results in onMethodCall(invoker,Integer.class,"valueOf",5)

Overrides:

onStaticCall in class GroovyInterceptor

Throws:

Throwable

onNewInstance

public Object onNewInstance(GroovyInterceptor.Invoker invoker,
                            Class receiver,
                            Object... args)
                     throws Throwable

Description copied from class: GroovyInterceptor

Intercepts an object instantiation, like "new Receiver(...)"

Overrides:

onNewInstance in class GroovyInterceptor

Throws:

Throwable

onGetProperty

public Object onGetProperty(GroovyInterceptor.Invoker invoker,
                            Object receiver,
                            String property)
                     throws Throwable

Description copied from class: GroovyInterceptor

Intercepts a property access, like "z=foo.bar"

Overrides:

onGetProperty in class GroovyInterceptor

receiver - 'foo' in the above example, the object whose property is accessed.

property - 'bar' in the above example, the name of the property

Throws:

Throwable

onSetProperty

public Object onSetProperty(GroovyInterceptor.Invoker invoker,
                            Object receiver,
                            String property,
                            Object value)
                     throws Throwable

Description copied from class: GroovyInterceptor

Intercepts a property assignment like "foo.bar=z"

Overrides:

onSetProperty in class GroovyInterceptor

receiver - 'foo' in the above example, the object whose property is accessed.

property - 'bar' in the above example, the name of the property

value - The value to be assigned.

Returns:

The result of the assignment expression. Normally, you should return the same object as value.

Throws:

Throwable

onGetAttribute

public Object onGetAttribute(GroovyInterceptor.Invoker invoker,
                             Object receiver,
                             String attribute)
                      throws Throwable

Description copied from class: GroovyInterceptor

Intercepts an attribute access, like "z=foo.@bar"

Overrides:

onGetAttribute in class GroovyInterceptor

receiver - 'foo' in the above example, the object whose attribute is accessed.

attribute - 'bar' in the above example, the name of the attribute

Throws:

Throwable

onSetAttribute

public Object onSetAttribute(GroovyInterceptor.Invoker invoker,
                             Object receiver,
                             String attribute,
                             Object value)
                      throws Throwable

Description copied from class: GroovyInterceptor

Intercepts an attribute assignment like "foo.@bar=z"

Overrides:

onSetAttribute in class GroovyInterceptor

receiver - 'foo' in the above example, the object whose attribute is accessed.

attribute - 'bar' in the above example, the name of the attribute

value - The value to be assigned.

Returns:

The result of the assignment expression. Normally, you should return the same object as value.

Throws:

Throwable

onGetArray

public Object onGetArray(GroovyInterceptor.Invoker invoker,
                         Object receiver,
                         Object index)
                  throws Throwable

Description copied from class: GroovyInterceptor

Intercepts an array access, like "z=foo[bar]"

Overrides:

onGetArray in class GroovyInterceptor

receiver - 'foo' in the above example, the array-like object.

index - 'bar' in the above example, the object that acts as an index.

Throws:

Throwable

onSetArray

public Object onSetArray(GroovyInterceptor.Invoker invoker,
                         Object receiver,
                         Object index,
                         Object value)
                  throws Throwable

Description copied from class: GroovyInterceptor

Intercepts an attribute assignment like "foo[bar]=z"

Overrides:

onSetArray in class GroovyInterceptor

receiver - 'foo' in the above example, the array-like object.

index - 'bar' in the above example, the object that acts as an index.

value - The value to be assigned.

Returns:

The result of the assignment expression. Normally, you should return the same object as value.

Throws:

Throwable