Class SecureASTCustomizer
- All Implemented Interfaces:
CompilationUnit.IPrimaryClassNodeOperation
public class SecureASTCustomizer extends CompilationCustomizer
Most of the security customization options found in this class work with either allowed or disallowed lists. This means that, for a single option, you can set an allowed list OR a disallowed list, but not both. You can mix allowed/disallowed strategies for different options. For example, you can have an allowed import list and a disallowed tokens list.
The recommended way of securing shells is to use allowed lists because it is guaranteed that future features of the Groovy language won't be accidentally allowed unless explicitly added to the allowed list. Using disallowed lists, you can limit the features of the language constructs supported by your shell by opting out, but new language features are then implicitly also available and this may not be desirable. The implication is that you might need to update your configuration with each new release.
If neither an allowed list nor a disallowed list is set, then everything is permitted.
Combinations of import and star import constraints are authorized as long as you use the same type of list for both. For example, you may use an import allowed list and a star import allowed list together, but you cannot use an import allowed list with a star import disallowed list. Static imports are handled separately, meaning that disallowing an import does not prevent from allowing a static import.
Eventually, if the features provided here are not sufficient, you may implement custom AST filtering handlers, either
implementing the SecureASTCustomizer.StatementChecker interface or SecureASTCustomizer.ExpressionChecker interface then register your
handlers thanks to the addExpressionCheckers(ExpressionChecker...)
and addStatementCheckers(StatementChecker...)
methods.
Here is an example of usage. We will create a groovy classloader which only supports arithmetic operations and imports
the java.lang.Math classes by default.
final ImportCustomizer imports = new ImportCustomizer().addStaticStars('java.lang.Math') // add static import of java.lang.Math
final SecureASTCustomizer secure = new SecureASTCustomizer()
secure.with {
closuresAllowed = false
methodDefinitionAllowed = false
allowedImports = []
allowedStaticImports = []
allowedStaticStarImports = ['java.lang.Math'] // only java.lang.Math is allowed
allowedTokens = [
PLUS,
MINUS,
MULTIPLY,
DIVIDE,
MOD,
POWER,
PLUS_PLUS,
MINUS_MINUS,
COMPARE_EQUAL,
COMPARE_NOT_EQUAL,
COMPARE_LESS_THAN,
COMPARE_LESS_THAN_EQUAL,
COMPARE_GREATER_THAN,
COMPARE_GREATER_THAN_EQUAL,
].asImmutable()
allowedConstantTypesClasses = [
Integer,
Float,
Long,
Double,
BigDecimal,
Integer.TYPE,
Long.TYPE,
Float.TYPE,
Double.TYPE
].asImmutable()
allowedReceiversClasses = [
Math,
Integer,
Float,
Double,
Long,
BigDecimal
].asImmutable()
}
CompilerConfiguration config = new CompilerConfiguration()
config.addCompilationCustomizers(imports, secure)
GroovyClassLoader loader = new GroovyClassLoader(this.class.classLoader, config)
Note: SecureASTCustomizer allows you to lock down the grammar of scripts but by itself isn't intended
to be the complete solution of all security issues when running scripts on the JVM. You might also want to
consider setting the groovy.grape.enable System property to false, augmenting use of the customizer
with additional techniques, and following standard security principles for JVM applications.
For more information, please read:
- Since:
- 1.8.0
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSecureASTCustomizer.ExpressionCheckerThis interface allows the user to provide a custom expression checker if the dis/allowed expression lists are not sufficientprotected classSecureASTCustomizer.SecuringCodeVisitorThis visitor directly implements theGroovyCodeVisitorinterface instead of using theCodeVisitorSupportclass to make sure that future features of the language gets managed by this visitor.static interfaceSecureASTCustomizer.StatementCheckerThis interface allows the user to provide a custom statement checker if the dis/allowed statement lists are not sufficient -
Constructor Summary
Constructors Constructor Description SecureASTCustomizer() -
Method Summary
Modifier and Type Method Description voidaddExpressionCheckers(SecureASTCustomizer.ExpressionChecker... checkers)voidaddStatementCheckers(SecureASTCustomizer.StatementChecker... checkers)protected voidassertImportIsAllowed(java.lang.String className)protected voidassertStarImportIsAllowed(java.lang.String packageName)protected voidassertStaticImportIsAllowed(java.lang.String member, java.lang.String className)voidcall(SourceUnit source, GeneratorContext context, ClassNode classNode)protected voidcheckMethodDefinitionAllowed(ClassNode owner)protected GroovyCodeVisitorcreateGroovyCodeVisitor()protected static java.util.List<MethodNode>filterMethods(ClassNode owner)java.util.List<java.lang.String>getAllowedConstantTypes()java.util.List<java.lang.Class<? extends Expression>>getAllowedExpressions()java.util.List<java.lang.String>getAllowedImports()java.util.List<java.lang.String>getAllowedReceivers()java.util.List<java.lang.String>getAllowedStarImports()java.util.List<java.lang.Class<? extends Statement>>getAllowedStatements()java.util.List<java.lang.String>getAllowedStaticImports()java.util.List<java.lang.String>getAllowedStaticStarImports()java.util.List<java.lang.Integer>getAllowedTokens()java.util.List<java.lang.String>getConstantTypesBlackList()Legacy alias forgetDisallowedConstantTypes()java.util.List<java.lang.String>getConstantTypesWhiteList()Legacy alias forgetAllowedStatements()java.util.List<java.lang.String>getDisallowedConstantTypes()java.util.List<java.lang.Class<? extends Expression>>getDisallowedExpressions()java.util.List<java.lang.String>getDisallowedImports()java.util.List<java.lang.String>getDisallowedReceivers()java.util.List<java.lang.String>getDisallowedStarImports()java.util.List<java.lang.Class<? extends Statement>>getDisallowedStatements()java.util.List<java.lang.String>getDisallowedStaticImports()java.util.List<java.lang.String>getDisallowedStaticStarImports()java.util.List<java.lang.Integer>getDisallowedTokens()java.util.List<java.lang.Class<? extends Expression>>getExpressionsBlacklist()Legacy alias forgetDisallowedExpressions()java.util.List<java.lang.Class<? extends Expression>>getExpressionsWhitelist()Legacy alias forgetAllowedExpressions()java.util.List<java.lang.String>getImportsBlacklist()Legacy alias forgetDisallowedImports()java.util.List<java.lang.String>getImportsWhitelist()Legacy alias forgetAllowedImports()java.util.List<java.lang.String>getReceiversBlackList()Legacy alias forgetDisallowedReceivers()java.util.List<java.lang.String>getReceiversWhiteList()Legacy alias forgetAllowedReceivers()java.util.List<java.lang.String>getStarImportsBlacklist()Legacy alias forgetDisallowedStarImports()java.util.List<java.lang.String>getStarImportsWhitelist()Legacy alias forgetAllowedStarImports()java.util.List<java.lang.Class<? extends Statement>>getStatementsBlacklist()Legacy alias forgetDisallowedStatements()java.util.List<java.lang.Class<? extends Statement>>getStatementsWhitelist()Legacy alias forgetAllowedStatements()java.util.List<java.lang.String>getStaticImportsBlacklist()Legacy alias forgetDisallowedStaticImports()java.util.List<java.lang.String>getStaticImportsWhitelist()Legacy alias forgetAllowedStaticImports()java.util.List<java.lang.String>getStaticStarImportsBlacklist()Legacy alias forgetDisallowedStaticStarImports()java.util.List<java.lang.String>getStaticStarImportsWhitelist()Legacy alias forgetAllowedStaticStarImports()java.util.List<java.lang.Integer>getTokensBlacklist()Legacy alias forgetDisallowedTokens()java.util.List<java.lang.Integer>getTokensWhitelist()Legacy alias forgetAllowedTokens()booleanisClosuresAllowed()booleanisIndirectImportCheckEnabled()booleanisMethodDefinitionAllowed()booleanisPackageAllowed()voidsetAllowedConstantTypes(java.util.List<java.lang.String> allowedConstantTypes)voidsetAllowedConstantTypesClasses(java.util.List<java.lang.Class> allowedConstantTypes)An alternative way of setting constant types.voidsetAllowedExpressions(java.util.List<java.lang.Class<? extends Expression>> allowedExpressions)voidsetAllowedImports(java.util.List<java.lang.String> allowedImports)voidsetAllowedReceivers(java.util.List<java.lang.String> allowedReceivers)Sets the list of classes which may accept method calls.voidsetAllowedReceiversClasses(java.util.List<java.lang.Class> allowedReceivers)An alternative way of settingreceiver classes.voidsetAllowedStarImports(java.util.List<java.lang.String> allowedStarImports)voidsetAllowedStatements(java.util.List<java.lang.Class<? extends Statement>> allowedStatements)voidsetAllowedStaticImports(java.util.List<java.lang.String> allowedStaticImports)voidsetAllowedStaticStarImports(java.util.List<java.lang.String> allowedStaticStarImports)voidsetAllowedTokens(java.util.List<java.lang.Integer> allowedTokens)Sets the list of tokens which are permitted.voidsetClosuresAllowed(boolean closuresAllowed)voidsetConstantTypesBlackList(java.util.List<java.lang.String> constantTypesBlackList)voidsetConstantTypesClassesBlackList(java.util.List<java.lang.Class> disallowedConstantTypes)Legacy alias forsetDisallowedConstantTypesClasses(List)voidsetConstantTypesClassesWhiteList(java.util.List<java.lang.Class> allowedConstantTypes)Legacy alias forsetAllowedConstantTypesClasses(List)voidsetConstantTypesWhiteList(java.util.List<java.lang.String> allowedConstantTypes)Legacy alias forsetAllowedConstantTypes(List)voidsetDisallowedConstantTypesClasses(java.util.List<java.lang.Class> disallowedConstantTypes)An alternative way of setting constant types.voidsetDisallowedExpressions(java.util.List<java.lang.Class<? extends Expression>> disallowedExpressions)voidsetDisallowedImports(java.util.List<java.lang.String> disallowedImports)voidsetDisallowedReceivers(java.util.List<java.lang.String> disallowedReceivers)Sets the list of classes which deny method calls.voidsetDisallowedReceiversClasses(java.util.List<java.lang.Class> disallowedReceivers)An alternative way of settingreceiver classes.voidsetDisallowedStarImports(java.util.List<java.lang.String> disallowedStarImports)voidsetDisallowedStatements(java.util.List<java.lang.Class<? extends Statement>> disallowedStatements)voidsetDisallowedStaticImports(java.util.List<java.lang.String> disallowedStaticImports)voidsetDisallowedStaticStarImports(java.util.List<java.lang.String> disallowedStaticStarImports)voidsetDisallowedTokens(java.util.List<java.lang.Integer> disallowedTokens)Sets the list of tokens which are not permitted.voidsetExpressionsBlacklist(java.util.List<java.lang.Class<? extends Expression>> disallowedExpressions)Legacy alias forsetDisallowedExpressions(List)voidsetExpressionsWhitelist(java.util.List<java.lang.Class<? extends Expression>> allowedExpressions)Legacy alias forsetAllowedExpressions(List)voidsetImportsBlacklist(java.util.List<java.lang.String> disallowedImports)Legacy alias forsetDisallowedImports(List)voidsetImportsWhitelist(java.util.List<java.lang.String> allowedImports)Legacy alias forsetAllowedImports(List)voidsetIndirectImportCheckEnabled(boolean indirectImportCheckEnabled)Set this option to true if you want your import rules to be checked against every class node.voidsetMethodDefinitionAllowed(boolean methodDefinitionAllowed)voidsetPackageAllowed(boolean packageAllowed)voidsetReceiversBlackList(java.util.List<java.lang.String> disallowedReceivers)Legacy alias forsetDisallowedReceivers(List)voidsetReceiversClassesBlackList(java.util.List<java.lang.Class> disallowedReceivers)Legacy alias forsetDisallowedReceiversClasses(List).voidsetReceiversClassesWhiteList(java.util.List<java.lang.Class> allowedReceivers)Legacy alias forsetAllowedReceiversClasses(List)voidsetReceiversWhiteList(java.util.List<java.lang.String> allowedReceivers)Legacy alias forsetAllowedReceivers(List)voidsetStarImportsBlacklist(java.util.List<java.lang.String> disallowedStarImports)Legacy alias forsetDisallowedStarImports(List)voidsetStarImportsWhitelist(java.util.List<java.lang.String> allowedStarImports)Legacy alias forsetAllowedStarImports(List)voidsetStatementsBlacklist(java.util.List<java.lang.Class<? extends Statement>> disallowedStatements)Legacy alias forsetDisallowedStatements(List)voidsetStatementsWhitelist(java.util.List<java.lang.Class<? extends Statement>> allowedStatements)Legacy alias forsetAllowedStatements(List)voidsetStaticImportsBlacklist(java.util.List<java.lang.String> disallowedStaticImports)Legacy alias forsetDisallowedStaticImports(List)voidsetStaticImportsWhitelist(java.util.List<java.lang.String> allowedStaticImports)Legacy alias forsetAllowedStaticImports(List)voidsetStaticStarImportsBlacklist(java.util.List<java.lang.String> disallowedStaticStarImports)Legacy alias forsetDisallowedStaticStarImports(List)voidsetStaticStarImportsWhitelist(java.util.List<java.lang.String> allowedStaticStarImports)Legacy alias forsetAllowedStaticStarImports(List)voidsetTokensBlacklist(java.util.List<java.lang.Integer> disallowedTokens)Alias forsetDisallowedTokens(List).voidsetTokensWhitelist(java.util.List<java.lang.Integer> allowedTokens)Legacy alias forsetAllowedTokens(List)Methods inherited from class org.codehaus.groovy.control.customizers.CompilationCustomizer
getPhaseMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.codehaus.groovy.control.CompilationUnit.IPrimaryClassNodeOperation
doPhaseOperation, needSortedInput
-
Constructor Details
-
SecureASTCustomizer
public SecureASTCustomizer()
-
-
Method Details
-
isMethodDefinitionAllowed
public boolean isMethodDefinitionAllowed() -
setMethodDefinitionAllowed
public void setMethodDefinitionAllowed(boolean methodDefinitionAllowed) -
isPackageAllowed
public boolean isPackageAllowed() -
isClosuresAllowed
public boolean isClosuresAllowed() -
setClosuresAllowed
public void setClosuresAllowed(boolean closuresAllowed) -
setPackageAllowed
public void setPackageAllowed(boolean packageAllowed) -
getDisallowedImports
public java.util.List<java.lang.String> getDisallowedImports() -
getImportsBlacklist
public java.util.List<java.lang.String> getImportsBlacklist()Legacy alias forgetDisallowedImports() -
setDisallowedImports
public void setDisallowedImports(java.util.List<java.lang.String> disallowedImports) -
setImportsBlacklist
public void setImportsBlacklist(java.util.List<java.lang.String> disallowedImports)Legacy alias forsetDisallowedImports(List) -
getAllowedImports
public java.util.List<java.lang.String> getAllowedImports() -
getImportsWhitelist
public java.util.List<java.lang.String> getImportsWhitelist()Legacy alias forgetAllowedImports() -
setAllowedImports
public void setAllowedImports(java.util.List<java.lang.String> allowedImports) -
setImportsWhitelist
public void setImportsWhitelist(java.util.List<java.lang.String> allowedImports)Legacy alias forsetAllowedImports(List) -
getDisallowedStarImports
public java.util.List<java.lang.String> getDisallowedStarImports() -
getStarImportsBlacklist
public java.util.List<java.lang.String> getStarImportsBlacklist()Legacy alias forgetDisallowedStarImports() -
setDisallowedStarImports
public void setDisallowedStarImports(java.util.List<java.lang.String> disallowedStarImports) -
setStarImportsBlacklist
public void setStarImportsBlacklist(java.util.List<java.lang.String> disallowedStarImports)Legacy alias forsetDisallowedStarImports(List) -
getAllowedStarImports
public java.util.List<java.lang.String> getAllowedStarImports() -
getStarImportsWhitelist
public java.util.List<java.lang.String> getStarImportsWhitelist()Legacy alias forgetAllowedStarImports() -
setAllowedStarImports
public void setAllowedStarImports(java.util.List<java.lang.String> allowedStarImports) -
setStarImportsWhitelist
public void setStarImportsWhitelist(java.util.List<java.lang.String> allowedStarImports)Legacy alias forsetAllowedStarImports(List) -
getDisallowedStaticImports
public java.util.List<java.lang.String> getDisallowedStaticImports() -
getStaticImportsBlacklist
public java.util.List<java.lang.String> getStaticImportsBlacklist()Legacy alias forgetDisallowedStaticImports() -
setDisallowedStaticImports
public void setDisallowedStaticImports(java.util.List<java.lang.String> disallowedStaticImports) -
setStaticImportsBlacklist
public void setStaticImportsBlacklist(java.util.List<java.lang.String> disallowedStaticImports)Legacy alias forsetDisallowedStaticImports(List) -
getAllowedStaticImports
public java.util.List<java.lang.String> getAllowedStaticImports() -
getStaticImportsWhitelist
public java.util.List<java.lang.String> getStaticImportsWhitelist()Legacy alias forgetAllowedStaticImports() -
setAllowedStaticImports
public void setAllowedStaticImports(java.util.List<java.lang.String> allowedStaticImports) -
setStaticImportsWhitelist
public void setStaticImportsWhitelist(java.util.List<java.lang.String> allowedStaticImports)Legacy alias forsetAllowedStaticImports(List) -
getDisallowedStaticStarImports
public java.util.List<java.lang.String> getDisallowedStaticStarImports() -
getStaticStarImportsBlacklist
public java.util.List<java.lang.String> getStaticStarImportsBlacklist()Legacy alias forgetDisallowedStaticStarImports() -
setDisallowedStaticStarImports
public void setDisallowedStaticStarImports(java.util.List<java.lang.String> disallowedStaticStarImports) -
setStaticStarImportsBlacklist
public void setStaticStarImportsBlacklist(java.util.List<java.lang.String> disallowedStaticStarImports)Legacy alias forsetDisallowedStaticStarImports(List) -
getAllowedStaticStarImports
public java.util.List<java.lang.String> getAllowedStaticStarImports() -
getStaticStarImportsWhitelist
public java.util.List<java.lang.String> getStaticStarImportsWhitelist()Legacy alias forgetAllowedStaticStarImports() -
setAllowedStaticStarImports
public void setAllowedStaticStarImports(java.util.List<java.lang.String> allowedStaticStarImports) -
setStaticStarImportsWhitelist
public void setStaticStarImportsWhitelist(java.util.List<java.lang.String> allowedStaticStarImports)Legacy alias forsetAllowedStaticStarImports(List) -
getDisallowedExpressions
-
getExpressionsBlacklist
Legacy alias forgetDisallowedExpressions() -
setDisallowedExpressions
public void setDisallowedExpressions(java.util.List<java.lang.Class<? extends Expression>> disallowedExpressions) -
setExpressionsBlacklist
public void setExpressionsBlacklist(java.util.List<java.lang.Class<? extends Expression>> disallowedExpressions)Legacy alias forsetDisallowedExpressions(List) -
getAllowedExpressions
-
getExpressionsWhitelist
Legacy alias forgetAllowedExpressions() -
setAllowedExpressions
public void setAllowedExpressions(java.util.List<java.lang.Class<? extends Expression>> allowedExpressions) -
setExpressionsWhitelist
public void setExpressionsWhitelist(java.util.List<java.lang.Class<? extends Expression>> allowedExpressions)Legacy alias forsetAllowedExpressions(List) -
getDisallowedStatements
-
getStatementsBlacklist
Legacy alias forgetDisallowedStatements() -
setDisallowedStatements
public void setDisallowedStatements(java.util.List<java.lang.Class<? extends Statement>> disallowedStatements) -
setStatementsBlacklist
public void setStatementsBlacklist(java.util.List<java.lang.Class<? extends Statement>> disallowedStatements)Legacy alias forsetDisallowedStatements(List) -
getAllowedStatements
-
getStatementsWhitelist
Legacy alias forgetAllowedStatements() -
setAllowedStatements
public void setAllowedStatements(java.util.List<java.lang.Class<? extends Statement>> allowedStatements) -
setStatementsWhitelist
public void setStatementsWhitelist(java.util.List<java.lang.Class<? extends Statement>> allowedStatements)Legacy alias forsetAllowedStatements(List) -
isIndirectImportCheckEnabled
public boolean isIndirectImportCheckEnabled() -
setIndirectImportCheckEnabled
public void setIndirectImportCheckEnabled(boolean indirectImportCheckEnabled)Set this option to true if you want your import rules to be checked against every class node. This means that if someone uses a fully qualified class name, then it will also be checked against the import rules, preventing, for example, instantiation of classes without imports thanks to FQCN.- Parameters:
indirectImportCheckEnabled- set to true to enable indirect checks
-
getDisallowedTokens
public java.util.List<java.lang.Integer> getDisallowedTokens() -
getTokensBlacklist
public java.util.List<java.lang.Integer> getTokensBlacklist()Legacy alias forgetDisallowedTokens() -
setDisallowedTokens
public void setDisallowedTokens(java.util.List<java.lang.Integer> disallowedTokens)Sets the list of tokens which are not permitted.- Parameters:
disallowedTokens- the tokens. The values of the tokens must be those ofTypes
-
setTokensBlacklist
public void setTokensBlacklist(java.util.List<java.lang.Integer> disallowedTokens)Alias forsetDisallowedTokens(List). -
getAllowedTokens
public java.util.List<java.lang.Integer> getAllowedTokens() -
getTokensWhitelist
public java.util.List<java.lang.Integer> getTokensWhitelist()Legacy alias forgetAllowedTokens() -
setAllowedTokens
public void setAllowedTokens(java.util.List<java.lang.Integer> allowedTokens)Sets the list of tokens which are permitted.- Parameters:
allowedTokens- the tokens. The values of the tokens must be those ofTypes
-
setTokensWhitelist
public void setTokensWhitelist(java.util.List<java.lang.Integer> allowedTokens)Legacy alias forsetAllowedTokens(List) -
addStatementCheckers
-
addExpressionCheckers
-
getDisallowedConstantTypes
public java.util.List<java.lang.String> getDisallowedConstantTypes() -
getConstantTypesBlackList
public java.util.List<java.lang.String> getConstantTypesBlackList()Legacy alias forgetDisallowedConstantTypes() -
setConstantTypesBlackList
public void setConstantTypesBlackList(java.util.List<java.lang.String> constantTypesBlackList) -
getAllowedConstantTypes
public java.util.List<java.lang.String> getAllowedConstantTypes() -
getConstantTypesWhiteList
public java.util.List<java.lang.String> getConstantTypesWhiteList()Legacy alias forgetAllowedStatements() -
setAllowedConstantTypes
public void setAllowedConstantTypes(java.util.List<java.lang.String> allowedConstantTypes) -
setConstantTypesWhiteList
public void setConstantTypesWhiteList(java.util.List<java.lang.String> allowedConstantTypes)Legacy alias forsetAllowedConstantTypes(List) -
setAllowedConstantTypesClasses
public void setAllowedConstantTypesClasses(java.util.List<java.lang.Class> allowedConstantTypes)An alternative way of setting constant types.- Parameters:
allowedConstantTypes- a list of classes.
-
setConstantTypesClassesWhiteList
public void setConstantTypesClassesWhiteList(java.util.List<java.lang.Class> allowedConstantTypes)Legacy alias forsetAllowedConstantTypesClasses(List) -
setDisallowedConstantTypesClasses
public void setDisallowedConstantTypesClasses(java.util.List<java.lang.Class> disallowedConstantTypes)An alternative way of setting constant types.- Parameters:
disallowedConstantTypes- a list of classes.
-
setConstantTypesClassesBlackList
public void setConstantTypesClassesBlackList(java.util.List<java.lang.Class> disallowedConstantTypes)Legacy alias forsetDisallowedConstantTypesClasses(List) -
getDisallowedReceivers
public java.util.List<java.lang.String> getDisallowedReceivers() -
getReceiversBlackList
public java.util.List<java.lang.String> getReceiversBlackList()Legacy alias forgetDisallowedReceivers() -
setDisallowedReceivers
public void setDisallowedReceivers(java.util.List<java.lang.String> disallowedReceivers)Sets the list of classes which deny method calls. Please note that since Groovy is a dynamic language, and this class performs a static type check, it will be relatively simple to bypass any disallowed list unless the disallowed receivers list contains, at a minimum, Object, Script, GroovyShell, and Eval. Additionally, it is necessary to also have MethodPointerExpression in the disallowed expressions list for the disallowed receivers list to function as a security check.- Parameters:
disallowedReceivers- the list of refused classes, as fully qualified names
-
setReceiversBlackList
public void setReceiversBlackList(java.util.List<java.lang.String> disallowedReceivers)Legacy alias forsetDisallowedReceivers(List) -
setDisallowedReceiversClasses
public void setDisallowedReceiversClasses(java.util.List<java.lang.Class> disallowedReceivers)An alternative way of settingreceiver classes.- Parameters:
disallowedReceivers- a list of classes.
-
setReceiversClassesBlackList
public void setReceiversClassesBlackList(java.util.List<java.lang.Class> disallowedReceivers)Legacy alias forsetDisallowedReceiversClasses(List). -
getAllowedReceivers
public java.util.List<java.lang.String> getAllowedReceivers() -
getReceiversWhiteList
public java.util.List<java.lang.String> getReceiversWhiteList()Legacy alias forgetAllowedReceivers() -
setAllowedReceivers
public void setAllowedReceivers(java.util.List<java.lang.String> allowedReceivers)Sets the list of classes which may accept method calls.- Parameters:
allowedReceivers- the list of accepted classes, as fully qualified names
-
setReceiversWhiteList
public void setReceiversWhiteList(java.util.List<java.lang.String> allowedReceivers)Legacy alias forsetAllowedReceivers(List) -
setAllowedReceiversClasses
public void setAllowedReceiversClasses(java.util.List<java.lang.Class> allowedReceivers)An alternative way of settingreceiver classes.- Parameters:
allowedReceivers- a list of classes.
-
setReceiversClassesWhiteList
public void setReceiversClassesWhiteList(java.util.List<java.lang.Class> allowedReceivers)Legacy alias forsetAllowedReceiversClasses(List) -
call
public void call(SourceUnit source, GeneratorContext context, ClassNode classNode) throws CompilationFailedException- Throws:
CompilationFailedException
-
createGroovyCodeVisitor
-
checkMethodDefinitionAllowed
-
filterMethods
-
assertStarImportIsAllowed
protected void assertStarImportIsAllowed(java.lang.String packageName) -
assertImportIsAllowed
protected void assertImportIsAllowed(java.lang.String className) -
assertStaticImportIsAllowed
protected void assertStaticImportIsAllowed(java.lang.String member, java.lang.String className)
-