Package com.cloudbees.groovy.cps.sandbox

Interface Invoker

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefaultInvoker, SandboxInvoker

public interface Invoker
extends Serializable

Abstracts away interactions with Groovy objects, for example to provide an opportunity to intercept calls.

During the execution of CPS code, Invoker is available from Env.getInvoker().

Author:

Kohsuke Kawaguchi

See Also:

• Env.getInvoker()
• Continuable(Script, Env)
• Envs.empty(Invoker)
• "doc/sandbox.md"

Field Summary

Fields

Modifier and Type	Field	Description
static final Invoker	INSTANCE	Default instance to be used.

Method Summary

Modifier and Type	Method	Description
Object	cast(Object value, Class<?> type, boolean ignoreAutoboxing, boolean coerce, boolean strict)
Object	constructorCall(Class lhs, Object[] args)
Invoker	contextualize(CallSiteBlock tags)	Returns a child Invoker used to make a call on behalf of the given CallSiteBlock.
Object	getArray(Object lhs, Object index)
Object	getAttribute(Object lhs, String name)
Object	getProperty(Object lhs, String name)
Object	methodCall(Object receiver, String method, Object[] args)
Object	methodPointer(Object lhs, String name)
void	setArray(Object lhs, Object index, Object value)
void	setAttribute(Object lhs, String name, Object value)
void	setProperty(Object lhs, String name, Object value)
Object	superCall(Class senderType, Object receiver, String method, Object[] args)	Invokespecial equivalent used for "super.foo(...)" kind of method call.

Field Details

INSTANCE

static final Invoker INSTANCE

Default instance to be used.

Method Details

methodCall

Object methodCall(Object receiver,
 String method,
 Object[] args)
           throws Throwable

Throws:

Throwable

constructorCall

Object constructorCall(Class lhs,
 Object[] args)
                throws Throwable

Throws:

Throwable

superCall

Object superCall(Class senderType,
 Object receiver,
 String method,
 Object[] args)
          throws Throwable

Invokespecial equivalent used for "super.foo(...)" kind of method call.

Parameters:

senderType - The type of the current method. Resolution of 'super' depends on this. 'receiver' is an instance of this type.

receiver - Instance that gets the method call

Throws:

Throwable

getProperty

Object getProperty(Object lhs,
 String name)
            throws Throwable

Throws:

Throwable

setProperty

void setProperty(Object lhs,
 String name,
 Object value)
          throws Throwable

Throws:

Throwable

getAttribute

Object getAttribute(Object lhs,
 String name)
             throws Throwable

Throws:

Throwable

setAttribute

void setAttribute(Object lhs,
 String name,
 Object value)
           throws Throwable

Throws:

Throwable

getArray

Object getArray(Object lhs,
 Object index)
         throws Throwable

Throws:

Throwable

setArray

void setArray(Object lhs,
 Object index,
 Object value)
       throws Throwable

Throws:

Throwable

methodPointer

Object methodPointer(Object lhs,
 String name)

cast

Object cast(Object value,
 Class<?> type,
 boolean ignoreAutoboxing,
 boolean coerce,
 boolean strict)
     throws Throwable

Throws:

Throwable

contextualize

Invoker contextualize(CallSiteBlock tags)

Returns a child Invoker used to make a call on behalf of the given CallSiteBlock.