Class SpelParserConfiguration

java.lang.Object

org.springframework.expression.spel.SpelParserConfiguration

public class SpelParserConfiguration
extends Object

Configuration object for the SpEL expression parser.

Since:

3.0

Author:

Juergen Hoeller, Phillip Webb, Andy Clement, Sam Brannen

See Also:

• SpelExpressionParser(SpelParserConfiguration)

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_MAX_EXPRESSION_LENGTH	Default maximum length permitted for a SpEL expression: 10000.
static final int	DEFAULT_MAX_OPERATIONS	Default maximum number of operations permitted during SpEL expression evaluation: 10000.
static final String	SPRING_EXPRESSION_COMPILER_MODE_PROPERTY_NAME	System property to configure the default compiler mode for SpEL expression parsers: "spring.expression.compiler.mode".
static final String	SPRING_EXPRESSION_MAX_OPERATIONS_PROPERTY_NAME	System property to configure the default maximum number of operations permitted during SpEL expression evaluation: "spring.expression.maxOperations".

Constructor Summary

Constructors

Constructor	Description
SpelParserConfiguration()	Create a new SpelParserConfiguration instance with default settings.
SpelParserConfiguration(boolean autoGrowNullReferences, boolean autoGrowCollections)	Create a new SpelParserConfiguration instance.
SpelParserConfiguration(boolean autoGrowNullReferences, boolean autoGrowCollections, int maximumAutoGrowSize)	Create a new SpelParserConfiguration instance.
SpelParserConfiguration(@Nullable SpelCompilerMode compilerMode, @Nullable ClassLoader compilerClassLoader)	Create a new SpelParserConfiguration instance.
SpelParserConfiguration(@Nullable SpelCompilerMode compilerMode, @Nullable ClassLoader compilerClassLoader, boolean autoGrowNullReferences, boolean autoGrowCollections, int maximumAutoGrowSize)	Create a new SpelParserConfiguration instance.
SpelParserConfiguration(@Nullable SpelCompilerMode compilerMode, @Nullable ClassLoader compilerClassLoader, boolean autoGrowNullReferences, boolean autoGrowCollections, int maximumAutoGrowSize, int maximumExpressionLength)	Create a new SpelParserConfiguration instance.
SpelParserConfiguration(SpelCompilerMode compilerMode, @Nullable ClassLoader compilerClassLoader, boolean autoGrowNullReferences, boolean autoGrowCollections, int maximumAutoGrowSize, int maximumExpressionLength, int maximumOperations)	Create a new SpelParserConfiguration instance.

Method Summary

Modifier and Type	Method	Description
@Nullable ClassLoader	getCompilerClassLoader()	Return the ClassLoader to use as the basis for expression compilation.
SpelCompilerMode	getCompilerMode()	Return the compiler mode for parsers using this configuration object.
int	getMaximumAutoGrowSize()	Return the maximum size to which a collection can auto grow.
int	getMaximumExpressionLength()	Return the maximum number of characters that a SpEL expression can contain.
int	getMaximumOperations()	Return the maximum number of operations permitted during SpEL expression evaluation.
boolean	isAutoGrowCollections()	Return true if collections should be automatically grown.
boolean	isAutoGrowNullReferences()	Return true if null references should be automatically grown.

Methods inherited from class Object

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

Field Details

DEFAULT_MAX_EXPRESSION_LENGTH

public static final int DEFAULT_MAX_EXPRESSION_LENGTH

Default maximum length permitted for a SpEL expression: 10000.

Since:

5.2.24

See Also:

• Constant Field Values

DEFAULT_MAX_OPERATIONS

public static final int DEFAULT_MAX_OPERATIONS

Default maximum number of operations permitted during SpEL expression evaluation: 10000.

Since:

6.2.19

See Also:

• SPRING_EXPRESSION_MAX_OPERATIONS_PROPERTY_NAME
• Constant Field Values

SPRING_EXPRESSION_COMPILER_MODE_PROPERTY_NAME

public static final String SPRING_EXPRESSION_COMPILER_MODE_PROPERTY_NAME

System property to configure the default compiler mode for SpEL expression parsers: "spring.expression.compiler.mode".

NOTE: Instead of relying on a global default, applications and frameworks should ideally set an explicit custom value via the SpelParserConfiguration(SpelCompilerMode, ClassLoader, boolean, boolean, int, int, int) constructor which provides complete configuration control and the ability to override global defaults per use case.

Can also be configured via the SpringProperties mechanism.

See Also:

• Constant Field Values

SPRING_EXPRESSION_MAX_OPERATIONS_PROPERTY_NAME

public static final String SPRING_EXPRESSION_MAX_OPERATIONS_PROPERTY_NAME

System property to configure the default maximum number of operations permitted during SpEL expression evaluation: "spring.expression.maxOperations".

NOTE: Instead of relying on a global default, applications and frameworks should ideally set an explicit custom value via the SpelParserConfiguration(SpelCompilerMode, ClassLoader, boolean, boolean, int, int, int) constructor which provides complete configuration control and the ability to override global defaults per use case.

Can also be configured via the SpringProperties mechanism.

Since:

6.2.19

See Also:

• DEFAULT_MAX_OPERATIONS
• Constant Field Values

Constructor Details

SpelParserConfiguration

public SpelParserConfiguration()

Create a new SpelParserConfiguration instance with default settings.

NOTE: Favor the SpelParserConfiguration(SpelCompilerMode, ClassLoader, boolean, boolean, int, int, int) constructor for complete configuration control and the ability to override global defaults per use case.

See Also:

• SPRING_EXPRESSION_COMPILER_MODE_PROPERTY_NAME
• SPRING_EXPRESSION_MAX_OPERATIONS_PROPERTY_NAME

SpelParserConfiguration

public SpelParserConfiguration(@Nullable SpelCompilerMode compilerMode,
 @Nullable ClassLoader compilerClassLoader)

Create a new SpelParserConfiguration instance.

NOTE: Favor the SpelParserConfiguration(SpelCompilerMode, ClassLoader, boolean, boolean, int, int, int) constructor for complete configuration control and the ability to override global defaults per use case.

Parameters:

compilerMode - the compiler mode that parsers using this configuration should use; or null to use the default mode

compilerClassLoader - the ClassLoader to use as the basis for expression compilation; or null to use the default ClassLoader

See Also:

• SPRING_EXPRESSION_COMPILER_MODE_PROPERTY_NAME
• SPRING_EXPRESSION_MAX_OPERATIONS_PROPERTY_NAME

SpelParserConfiguration

public SpelParserConfiguration(boolean autoGrowNullReferences,
 boolean autoGrowCollections)

Create a new SpelParserConfiguration instance.

NOTE: Favor the SpelParserConfiguration(SpelCompilerMode, ClassLoader, boolean, boolean, int, int, int) constructor for complete configuration control and the ability to override global defaults per use case.

Parameters:

autoGrowNullReferences - if null references should automatically grow

autoGrowCollections - if collections should automatically grow

See Also:

• SPRING_EXPRESSION_COMPILER_MODE_PROPERTY_NAME
• SPRING_EXPRESSION_MAX_OPERATIONS_PROPERTY_NAME

SpelParserConfiguration

public SpelParserConfiguration(boolean autoGrowNullReferences,
 boolean autoGrowCollections,
 int maximumAutoGrowSize)

Create a new SpelParserConfiguration instance.

NOTE: Favor the SpelParserConfiguration(SpelCompilerMode, ClassLoader, boolean, boolean, int, int, int) constructor for complete configuration control and the ability to override global defaults per use case.

Parameters:

autoGrowNullReferences - if null references should automatically grow

autoGrowCollections - if collections should automatically grow

maximumAutoGrowSize - the maximum size to which a collection can auto grow

See Also:

• SPRING_EXPRESSION_COMPILER_MODE_PROPERTY_NAME
• SPRING_EXPRESSION_MAX_OPERATIONS_PROPERTY_NAME

SpelParserConfiguration

public SpelParserConfiguration(@Nullable SpelCompilerMode compilerMode,
 @Nullable ClassLoader compilerClassLoader,
 boolean autoGrowNullReferences,
 boolean autoGrowCollections,
 int maximumAutoGrowSize)

Create a new SpelParserConfiguration instance.

NOTE: Favor the SpelParserConfiguration(SpelCompilerMode, ClassLoader, boolean, boolean, int, int, int) constructor for complete configuration control and the ability to override global defaults per use case.

Parameters:

compilerMode - the compiler mode that parsers using this configuration should use; or null to use the default mode

compilerClassLoader - the ClassLoader to use as the basis for expression compilation; or null to use the default ClassLoader

autoGrowNullReferences - if null references should automatically grow

autoGrowCollections - if collections should automatically grow

maximumAutoGrowSize - the maximum size to which a collection can auto grow

See Also:

• SPRING_EXPRESSION_COMPILER_MODE_PROPERTY_NAME
• SPRING_EXPRESSION_MAX_OPERATIONS_PROPERTY_NAME

SpelParserConfiguration

public SpelParserConfiguration(@Nullable SpelCompilerMode compilerMode,
 @Nullable ClassLoader compilerClassLoader,
 boolean autoGrowNullReferences,
 boolean autoGrowCollections,
 int maximumAutoGrowSize,
 int maximumExpressionLength)

Create a new SpelParserConfiguration instance.

NOTE: Favor the SpelParserConfiguration(SpelCompilerMode, ClassLoader, boolean, boolean, int, int, int) constructor for complete configuration control and the ability to override global defaults per use case.

Parameters:

compilerMode - the compiler mode that parsers using this configuration should use; or null to use the default mode

compilerClassLoader - the ClassLoader to use as the basis for expression compilation; or null to use the default ClassLoader

autoGrowNullReferences - if null references should automatically grow

autoGrowCollections - if collections should automatically grow

maximumAutoGrowSize - the maximum size to which a collection can auto grow

maximumExpressionLength - the maximum length of a SpEL expression; must be a positive number

Since:

5.2.25

See Also:

• SPRING_EXPRESSION_COMPILER_MODE_PROPERTY_NAME
• SPRING_EXPRESSION_MAX_OPERATIONS_PROPERTY_NAME

SpelParserConfiguration

public SpelParserConfiguration(SpelCompilerMode compilerMode,
 @Nullable ClassLoader compilerClassLoader,
 boolean autoGrowNullReferences,
 boolean autoGrowCollections,
 int maximumAutoGrowSize,
 int maximumExpressionLength,
 int maximumOperations)

Create a new SpelParserConfiguration instance.

Parameters:

compilerMode - the compiler mode that parsers using this configuration should use; must not be null

compilerClassLoader - the ClassLoader to use as the basis for expression compilation; or null to use the default ClassLoader

autoGrowNullReferences - if null references should automatically grow

autoGrowCollections - if collections should automatically grow

maximumAutoGrowSize - the maximum size to which a collection can auto grow

maximumExpressionLength - the maximum length of a SpEL expression; must be a positive number

maximumOperations - the maximum number of operations permitted during SpEL expression evaluation; must be a positive number

Since:

6.2.19

Method Details

getCompilerMode

public SpelCompilerMode getCompilerMode()

Return the compiler mode for parsers using this configuration object.

getCompilerClassLoader

public @Nullable ClassLoader getCompilerClassLoader()

Return the ClassLoader to use as the basis for expression compilation.

isAutoGrowNullReferences

public boolean isAutoGrowNullReferences()

Return true if null references should be automatically grown.

isAutoGrowCollections

public boolean isAutoGrowCollections()

Return true if collections should be automatically grown.

getMaximumAutoGrowSize

public int getMaximumAutoGrowSize()

Return the maximum size to which a collection can auto grow.

getMaximumExpressionLength

public int getMaximumExpressionLength()

Return the maximum number of characters that a SpEL expression can contain.

Since:

5.2.25

getMaximumOperations

public int getMaximumOperations()

Return the maximum number of operations permitted during SpEL expression evaluation.

Since:

6.2.19