Package org.apache.commons.jexl3.internal.introspection

Class SandboxUberspect

java.lang.Object

org.apache.commons.jexl3.internal.introspection.SandboxUberspect

All Implemented Interfaces:

JexlUberspect

public final class SandboxUberspect
extends Object
implements JexlUberspect

An uberspect that controls usage of properties, methods and constructors through a sandbox.

Since:

3.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.commons.jexl3.introspection.JexlUberspect

JexlUberspect.JexlResolver, JexlUberspect.PropertyResolver, JexlUberspect.ResolverStrategy

Field Summary

Fields

Modifier and Type	Field	Description
private final JexlSandbox	sandbox	The sandbox.
private final JexlUberspect	uberspect	The base uberspect.

Fields inherited from interface org.apache.commons.jexl3.introspection.JexlUberspect

JEXL_STRATEGY, MAP, MAP_STRATEGY, POJO

Constructor Summary

Constructors

Constructor	Description
SandboxUberspect(JexlUberspect theUberspect, JexlSandbox theSandbox)	A constructor for JexlSandbox uberspect.

Method Summary

Modifier and Type	Method	Description
private static boolean	eq(Object lhs, Object rhs)	Identity equality.
JexlArithmetic.Uberspect	getArithmetic(JexlArithmetic arithmetic)	Gets an arithmetic operator resolver for a given arithmetic instance.
Class<?>	getClassByName(String className)	Seeks a class by name using this uberspect class-loader.
ClassLoader	getClassLoader()	Gets the current class loader.
JexlMethod	getConstructor(Object ctorHandle, Object... args)	Returns a class constructor.
Iterator<?>	getIterator(Object obj)	Gets an iterator from an object.
JexlMethod	getMethod(Object obj, String method, Object... args)	Returns a JexlMethod.
JexlPropertyGet	getPropertyGet(Object obj, Object identifier)	Property getter.
JexlPropertyGet	getPropertyGet(List<JexlUberspect.PropertyResolver> resolvers, Object obj, Object identifier)	Property getter.
JexlPropertySet	getPropertySet(Object obj, Object identifier, Object arg)	Property setter.
JexlPropertySet	getPropertySet(List<JexlUberspect.PropertyResolver> resolvers, Object obj, Object identifier, Object arg)	Property setter.
List<JexlUberspect.PropertyResolver>	getResolvers(JexlOperator op, Object obj)	Applies this uberspect property resolver strategy.
int	getVersion()	Gets this uberspect version.
void	setClassLoader(ClassLoader loader)	Sets the class loader to use.

Methods inherited from class java.lang.Object

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

Field Details

uberspect

private final JexlUberspect uberspect

The base uberspect.

sandbox

private final JexlSandbox sandbox

The sandbox.

Constructor Details

SandboxUberspect

public SandboxUberspect(JexlUberspect theUberspect,
 JexlSandbox theSandbox)

A constructor for JexlSandbox uberspect.

Parameters:

theUberspect - the JexlUberspect to sandbox

theSandbox - the sandbox which is copied to avoid changes at runtime

Method Details

eq

private static boolean eq(Object lhs,
 Object rhs)

Identity equality.

Spotbugs just hates string identity...

Parameters:

lhs - left hand side

rhs - right hand side

Returns:

true if left is identical to right

getArithmetic

public JexlArithmetic.Uberspect getArithmetic(JexlArithmetic arithmetic)

Description copied from interface: JexlUberspect

Gets an arithmetic operator resolver for a given arithmetic instance.

Specified by:

getArithmetic in interface JexlUberspect

Parameters:

arithmetic - the arithmetic instance

Returns:

the arithmetic uberspect or null if no operator method were overridden

getClassByName

public Class<?> getClassByName(String className)

Description copied from interface: JexlUberspect

Seeks a class by name using this uberspect class-loader.

Specified by:

getClassByName in interface JexlUberspect

Parameters:

className - the class name

Returns:

the class instance or null if the class cannot be located by this uberspect class loader or if permissions deny access to the class

getClassLoader

public ClassLoader getClassLoader()

Description copied from interface: JexlUberspect

Gets the current class loader.

Specified by:

getClassLoader in interface JexlUberspect

Returns:

the class loader

getConstructor

public JexlMethod getConstructor(Object ctorHandle,
 Object... args)

Description copied from interface: JexlUberspect

Returns a class constructor.

Specified by:

getConstructor in interface JexlUberspect

Parameters:

ctorHandle - a class or class name

args - constructor arguments

Returns:

a JexlMethod

getIterator

public Iterator<?> getIterator(Object obj)

Description copied from interface: JexlUberspect

Gets an iterator from an object.

Specified by:

getIterator in interface JexlUberspect

Parameters:

obj - to get the iterator from

Returns:

an iterator over obj or null

getMethod

public JexlMethod getMethod(Object obj,
 String method,
 Object... args)

Description copied from interface: JexlUberspect

Returns a JexlMethod.

Specified by:

getMethod in interface JexlUberspect

Parameters:

obj - the object

method - the method name

args - method arguments

Returns:

a JexlMethod

getPropertyGet

public JexlPropertyGet getPropertyGet(List<JexlUberspect.PropertyResolver> resolvers,
 Object obj,
 Object identifier)

Description copied from interface: JexlUberspect

Property getter.

Seeks a JexlPropertyGet apropos to an expression like bar.woogie.

See JexlUberspect.ResolverStrategy.apply(JexlOperator, java.lang.Object)

Specified by:

getPropertyGet in interface JexlUberspect

Parameters:

resolvers - the list of property resolvers to try

obj - the object to get the property from

identifier - property name

Returns:

a JexlPropertyGet or null

getPropertyGet

public JexlPropertyGet getPropertyGet(Object obj,
 Object identifier)

Description copied from interface: JexlUberspect

Property getter.

returns a JelPropertySet apropos to an expression like bar.woogie.

Specified by:

getPropertyGet in interface JexlUberspect

Parameters:

obj - the object to get the property from

identifier - property name

Returns:

a JexlPropertyGet or null

getPropertySet

public JexlPropertySet getPropertySet(List<JexlUberspect.PropertyResolver> resolvers,
 Object obj,
 Object identifier,
 Object arg)

Description copied from interface: JexlUberspect

Property setter.

Seeks a JelPropertySet apropos to an expression like foo.bar = "geir".

See JexlUberspect.ResolverStrategy.apply(JexlOperator, java.lang.Object)

Specified by:

getPropertySet in interface JexlUberspect

Parameters:

resolvers - the list of property resolvers to try,

obj - the object to get the property from

identifier - property name

arg - value to set

Returns:

a JexlPropertySet or null

getPropertySet

public JexlPropertySet getPropertySet(Object obj,
 Object identifier,
 Object arg)

Description copied from interface: JexlUberspect

Property setter.

Seeks a JelPropertySet apropos to an expression like foo.bar = "geir".

Specified by:

getPropertySet in interface JexlUberspect

Parameters:

obj - the object to get the property from.

identifier - property name

arg - value to set

Returns:

a JexlPropertySet or null

getResolvers

public List<JexlUberspect.PropertyResolver> getResolvers(JexlOperator op,
 Object obj)

Description copied from interface: JexlUberspect

Applies this uberspect property resolver strategy.

Specified by:

getResolvers in interface JexlUberspect

Parameters:

op - the operator

obj - the object

Returns:

the applied strategy resolver list

getVersion

public int getVersion()

Description copied from interface: JexlUberspect

Gets this uberspect version.

Specified by:

getVersion in interface JexlUberspect

Returns:

the class loader modification count

setClassLoader

public void setClassLoader(ClassLoader loader)

Description copied from interface: JexlUberspect

Sets the class loader to use.

This increments the version.

Specified by:

setClassLoader in interface JexlUberspect

Parameters:

loader - the class loader