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

SYMBOLIC_NAME

@NotNull
public static java.lang.String SYMBOLIC_NAME

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 org.gradle.api.provider.Property<java.lang.Boolean> getVerbose()

Controls throwing exception on script execution error.

getScriptDir

public org.gradle.api.file.DirectoryProperty getScriptDir()

Directory to search for scripts to be evaluated.

getAvailable

public boolean getAvailable()

Check if console is installed on instance.

requireAvailable

public void requireAvailable()

Ensure by throwing exception that console is available on instance.

evalCode

@NotNull
public GroovyEvalResult 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 GroovyEvalResult 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 GroovyEvalResult 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.

findScripts

@NotNull
public java.util.List<java.io.File> findScripts(@NotNull
                                                         java.lang.String pathPattern)

Find scripts matching file pattern in pre-configured directory.

evalScripts

public void evalScripts(@NotNull
                        java.lang.String pathPattern,
                        @NotNull
                        java.util.Map<java.lang.String,? extends java.lang.Object> data,
                        @NotNull
                        kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.service.groovy.GroovyEvalResult,kotlin.Unit> resultConsumer)

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

evalScripts

public void evalScripts(@NotNull
                        java.lang.Iterable<? extends java.io.File> scripts,
                        @NotNull
                        java.util.Map<java.lang.String,? extends java.lang.Object> data,
                        @NotNull
                        kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.service.groovy.GroovyEvalResult,kotlin.Unit> resultConsumer)

Evaluate any Groovy scripts on AEM instance in specified order.