
public final class GroovyConsole
 extends InstanceService

Allows to execute Groovy code / scripts on AEM instance having Groovy Console CRX package installed.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final Property<Boolean>`	`verbose`
`private final DirectoryProperty`	`scriptDir`
`private final Boolean`	`available`
`private final AemExtension`	`aem`
`private final Instance`	`instance`
`private final Project`	`project`
`private final CommonExtension`	`common`
`private final Logger`	`logger`
`private final InstanceSync`	`sync`

Constructor Summary

Constructors
Constructor	Description
`GroovyConsole(InstanceSync sync)`

Method Summary

Modifier and Type	Method	Description
`final Unit`	`requireAvailable()`	Ensure by throwing exception that console is available on instance.
`final GroovyEvalResult`	`evalCode(String code, Map<String, Any> data)`	Evaluate Groovy code snippet on AEM instance.
`final GroovyEvalResult`	`evalScript(File file, Map<String, Any> data)`	Evaluate any Groovy script on AEM instance.
`final GroovyEvalResult`	`evalScript(String fileName, Map<String, Any> data)`	Evaluate Groovy script found by its file name on AEM instance.
`final List<File>`	`findScripts(String pathPattern)`	Find scripts matching file pattern in pre-configured directory.
`final Unit`	`evalScripts(String pathPattern, Map<String, Any> data, Function1<GroovyEvalResult, Unit> resultConsumer)`	Evaluate all Groovy scripts found by file name pattern on AEM instance in path-based alphabetical order.
`final Unit`	`evalScripts(Iterable<File> scripts, Map<String, Any> data, Function1<GroovyEvalResult, Unit> resultConsumer)`	Evaluate any Groovy scripts on AEM instance in specified order.
`final Property<Boolean>`	`getVerbose()`	Controls throwing exception on script execution error.
`final DirectoryProperty`	`getScriptDir()`	Directory to search for scripts to be evaluated.
`final Boolean`	`getAvailable()`
`final AemExtension`	`getAem()`
`final Instance`	`getInstance()`
`final Project`	`getProject()`
`final CommonExtension`	`getCommon()`
`final Logger`	`getLogger()`
`final InstanceSync`	`getSync()`

Methods inherited from class com.cognifide.gradle.aem.common.instance.InstanceService
equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- GroovyConsole
```
GroovyConsole(InstanceSync sync)
```

Method Detail

requireAvailable
```
 final Unit requireAvailable()
```
Ensure by throwing exception that console is available on instance.

evalCode

 final GroovyEvalResult evalCode(String code, Map<String, Any> data)

Evaluate Groovy code snippet on AEM instance.

evalScript

 final GroovyEvalResult evalScript(File file, Map<String, Any> data)

Evaluate any Groovy script on AEM instance.

evalScript

 final GroovyEvalResult evalScript(String fileName, Map<String, Any> data)

Evaluate Groovy script found by its file name on AEM instance.

findScripts
```
 final List<File> findScripts(String pathPattern)
```
Find scripts matching file pattern in pre-configured directory.

evalScripts

 final Unit evalScripts(String pathPattern, Map<String, Any> data, Function1<GroovyEvalResult, Unit> resultConsumer)

Evaluate all Groovy scripts found by file name pattern on AEM instance in path-based alphabetical order.

evalScripts

 final Unit evalScripts(Iterable<File> scripts, Map<String, Any> data, Function1<GroovyEvalResult, Unit> resultConsumer)

Evaluate any Groovy scripts on AEM instance in specified order.

getVerbose
```
 final Property<Boolean> getVerbose()
```
Controls throwing exception on script execution error.

getScriptDir
```
 final DirectoryProperty getScriptDir()
```
Directory to search for scripts to be evaluated.

getAvailable
```
 final Boolean getAvailable()
```

getAem
```
 final AemExtension getAem()
```

getInstance
```
 final Instance getInstance()
```

getProject
```
 final Project getProject()
```

getCommon
```
 final CommonExtension getCommon()
```

getLogger
```
 final Logger getLogger()
```

getSync
```
 final InstanceSync getSync()
```

Class GroovyConsole

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.cognifide.gradle.aem.common.instance.InstanceService

Methods inherited from class java.lang.Object

Constructor Detail

GroovyConsole

Method Detail

requireAvailable

evalCode

evalScript

evalScript

findScripts

evalScripts

evalScripts

getVerbose

getScriptDir

getAvailable

getAem

getInstance

getProject

getCommon

getLogger

getSync