com.cognifide.gradle.aem.common.instance.service.groovy

Class GroovyConsole

InstanceService

com.cognifide.gradle.aem.common.instance.service.groovy.GroovyConsole

public class GroovyConsole
extends InstanceService

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

Field Detail

EVAL_PATH

@NotNull
public static java.lang.String EVAL_PATH

See Also:

Constant Field Values

Companion

public static com.cognifide.gradle.aem.common.instance.service.groovy.GroovyConsole.Companion Companion

Constructor Detail

GroovyConsole

public GroovyConsole(@NotNull
                     InstanceSync sync)

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

Method Detail

getVerbose

public boolean getVerbose()

Controls throwing exception on script execution error.

setVerbose

public void setVerbose(boolean p)

Controls throwing exception on script execution error.

getScriptRootDir

@NotNull
public java.io.File getScriptRootDir()

Directory to search for scripts to be evaluated.

setScriptRootDir

public void setScriptRootDir(@NotNull
                             java.io.File p)

Directory to search for scripts to be evaluated.

evalCode

@NotNull
public GroovyConsoleResult evalCode(@NotNull
                                             java.lang.String code,
                                             @NotNull
                                             java.util.Map<java.lang.String,? extends java.lang.Object> data)

Evaluate Groovy code snippet on AEM instance.

evalScript

@NotNull
public GroovyConsoleResult evalScript(@NotNull
                                               java.io.File file,
                                               @NotNull
                                               java.util.Map<java.lang.String,? extends java.lang.Object> data)

Evaluate any Groovy script on AEM instance.

evalScript

@NotNull
public GroovyConsoleResult evalScript(@NotNull
                                               java.lang.String fileName,
                                               @NotNull
                                               java.util.Map<java.lang.String,? extends java.lang.Object> data)

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

evalScripts

@NotNull
public kotlin.sequences.Sequence<com.cognifide.gradle.aem.common.instance.service.groovy.GroovyConsoleResult> evalScripts(@NotNull
                                                                                                                                   java.lang.String fileNamePattern,
                                                                                                                                   @NotNull
                                                                                                                                   java.util.Map<java.lang.String,? extends java.lang.Object> data)

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

evalScripts

@NotNull
public kotlin.sequences.Sequence<com.cognifide.gradle.aem.common.instance.service.groovy.GroovyConsoleResult> evalScripts(@NotNull
                                                                                                                                   java.lang.Iterable<? extends java.io.File> scripts,
                                                                                                                                   @NotNull
                                                                                                                                   java.util.Map<java.lang.String,? extends java.lang.Object> data)

Evaluate any Groovy scripts on AEM instance in specified order.