com.github.jlangch.venice.javainterop

Interface IInterceptor

All Known Implementing Classes:

AcceptAllInterceptor, Interceptor, RejectAllInterceptor, SandboxInterceptor, SandboxRecorder, ValueFilterInterceptor

public interface IInterceptor

Defines a Venice interceptor

Method Summary

Modifier and Type	Method and Description
ILoadPaths	getLoadPaths()
java.lang.Integer	getMaxExecutionTimeSeconds()
java.lang.Integer	getMaxFutureThreadPoolSize()
ReturnValue	onGetBeanProperty(IInvoker invoker, java.lang.Object receiver, java.lang.String property) Gets a Java Bean property
ReturnValue	onGetInstanceField(IInvoker invoker, java.lang.Object receiver, java.lang.Class<?> receiverFormalType, java.lang.String fieldName) Get an instance field's value
ReturnValue	onGetStaticField(IInvoker invoker, java.lang.Class<?> receiver, java.lang.String fieldName) Get a static field's value
ReturnValue	onInvokeConstructor(IInvoker invoker, java.lang.Class<?> receiver, java.lang.Object... args) Invokes a constructor
ReturnValue	onInvokeInstanceMethod(IInvoker invoker, java.lang.Object receiver, java.lang.Class<?> receiverFormalType, java.lang.String method, java.lang.Object... args) Invokes an instance method
ReturnValue	onInvokeStaticMethod(IInvoker invoker, java.lang.Class<?> receiver, java.lang.String method, java.lang.Object... args) Invokes a static method
byte[]	onLoadClassPathResource(java.lang.String resourceName) Loads a classpath resource
java.lang.String	onReadSystemEnv(java.lang.String name) Reads a Java environment variable
java.lang.String	onReadSystemProperty(java.lang.String propertyName) Reads a Java system property
void	onSetBeanProperty(IInvoker invoker, java.lang.Object receiver, java.lang.String property, java.lang.Object value) Sets a Java Bean property
void	validateFileRead(java.io.File file) Validates that the file can be read
void	validateFileWrite(java.io.File file) Validates that the file can be written
void	validateLoadModule(java.lang.String moduleName) Validates the load of a module
void	validateMaxExecutionTime() Validates the execution time
void	validateVeniceFunction(java.lang.String funcName) Validates the invocation of a Venice function.

Method Detail

onInvokeInstanceMethod

ReturnValue onInvokeInstanceMethod(IInvoker invoker,
                                   java.lang.Object receiver,
                                   java.lang.Class<?> receiverFormalType,
                                   java.lang.String method,
                                   java.lang.Object... args)
                            throws SecurityException

Invokes an instance method

Parameters:

invoker - the invoker

receiver - an object

receiverFormalType - the formal type of the receiver (e.g a superclass)

method - a method

args - a list of arguments

Returns:

the return value

Throws:

SecurityException - if the instance method is not whitelisted

onInvokeStaticMethod

ReturnValue onInvokeStaticMethod(IInvoker invoker,
                                 java.lang.Class<?> receiver,
                                 java.lang.String method,
                                 java.lang.Object... args)
                          throws SecurityException

Invokes a static method

Parameters:

invoker - the invoker

receiver - a class

method - a method

args - a list of arguments

Returns:

the return value

Throws:

SecurityException - if the static method is not whitelisted

onInvokeConstructor

ReturnValue onInvokeConstructor(IInvoker invoker,
                                java.lang.Class<?> receiver,
                                java.lang.Object... args)
                         throws SecurityException

Invokes a constructor

Parameters:

invoker - the invoker

receiver - a class

args - a list of arguments

Returns:

the create object

Throws:

SecurityException - if the constructor is not whitelisted

onGetBeanProperty

ReturnValue onGetBeanProperty(IInvoker invoker,
                              java.lang.Object receiver,
                              java.lang.String property)
                       throws SecurityException

Gets a Java Bean property

Parameters:

invoker - the invoker

receiver - an object

property - a property name

Returns:

the property's value

Throws:

SecurityException - if the bean property (instance method) is not whitelisted

onSetBeanProperty

void onSetBeanProperty(IInvoker invoker,
                       java.lang.Object receiver,
                       java.lang.String property,
                       java.lang.Object value)
                throws SecurityException

Sets a Java Bean property

Parameters:

invoker - the invoker

receiver - an object

property - a property name

value - a property value

Throws:

SecurityException - if the bean property (instance method) is not whitelisted

onGetStaticField

ReturnValue onGetStaticField(IInvoker invoker,
                             java.lang.Class<?> receiver,
                             java.lang.String fieldName)
                      throws SecurityException

Get a static field's value

Parameters:

invoker - the invoker

receiver - a class

fieldName - a field name

Returns:

the field's value

Throws:

SecurityException - if the static field is not whitelisted

onGetInstanceField

ReturnValue onGetInstanceField(IInvoker invoker,
                               java.lang.Object receiver,
                               java.lang.Class<?> receiverFormalType,
                               java.lang.String fieldName)
                        throws SecurityException

Get an instance field's value

Parameters:

invoker - the invoker

receiver - an object

receiverFormalType - the formal type of the receiver (e.g a superclass)

fieldName - a field name

Returns:

the field's value

Throws:

SecurityException - if the instance field is not whitelisted

onLoadClassPathResource

byte[] onLoadClassPathResource(java.lang.String resourceName)
                        throws SecurityException

Loads a classpath resource

Parameters:

resourceName - a resource name (e.g.: /foo/org/image.png)

Returns:

the resource data

Throws:

SecurityException - if the classpath resource is not whitelisted

onReadSystemProperty

java.lang.String onReadSystemProperty(java.lang.String propertyName)
                               throws SecurityException

Reads a Java system property

Parameters:

propertyName - a property name (e.g: user.home)

Returns:

the property's value

Throws:

SecurityException - if the property is not whitelisted

onReadSystemEnv

java.lang.String onReadSystemEnv(java.lang.String name)
                          throws SecurityException

Reads a Java environment variable

Parameters:

name - a variable name (e.g: USER)

Returns:

the variable value

Throws:

SecurityException - if the variable is not whitelisted

validateLoadModule

void validateLoadModule(java.lang.String moduleName)
                 throws SecurityException

Validates the load of a module

Parameters:

moduleName - the module name

Throws:

SecurityException - if the module is blacklisted

validateVeniceFunction

void validateVeniceFunction(java.lang.String funcName)
                     throws SecurityException

Validates the invocation of a Venice function.

Parameters:

funcName - A venice function name

Throws:

SecurityException - if the function is blacklisted and not allowed to be invoked.

validateMaxExecutionTime

void validateMaxExecutionTime()
                       throws SecurityException

Validates the execution time

Throws:

SecurityException - if the execution time exceeds the configured limit.

validateFileRead

void validateFileRead(java.io.File file)
               throws SecurityException

Validates that the file can be read

Parameters:

file - A file

Throws:

SecurityException - if the file can not be read.

validateFileWrite

void validateFileWrite(java.io.File file)
                throws SecurityException

Validates that the file can be written

Parameters:

file - A file

Throws:

SecurityException - if the file can not be written.

getLoadPaths

ILoadPaths getLoadPaths()

Returns:

the load paths for loading Venice files and resources

getMaxExecutionTimeSeconds

java.lang.Integer getMaxExecutionTimeSeconds()

Returns:

the max execution time in seconds a Venice script under this Sandbox is allowed to run.

getMaxFutureThreadPoolSize

java.lang.Integer getMaxFutureThreadPoolSize()

Returns:

the max future thread pool size a Venice script under this Sandbox is allowed to use.