com.cognifide.gradle.aem.common.instance

Class LocalInstanceManager

com.cognifide.gradle.aem.common.instance.LocalInstanceManager

public class LocalInstanceManager

Constructor Detail

LocalInstanceManager

public LocalInstanceManager(@NotNull
                            AemExtension aem)

Method Detail

getBase

@NotNull
public InstanceManager getBase()

getProjectDir

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

Using local AEM instances is acceptable in any project so that lookup for project applying local instance plugin is required Needed to determine e.g directory in which AEM quickstart will be stored and override files.

getRootDir

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

Path in which local AEM instances will be stored.

getConfigDir

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

Path for storing local AEM instances related resources.

getOverrideDir

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

Path from which e.g extra files for local AEM instances will be copied. Useful for overriding default startup scripts ('start.bat' or 'start.sh') or providing some files inside 'crx-quickstart'.

getSource

public org.gradle.api.provider.Property<com.cognifide.gradle.aem.common.instance.local.Source> getSource()

Determines how instances will be created (from backup or quickstart built from the scratch).

source

public void source(@NotNull
                   java.lang.String name)

getOpenMode

public org.gradle.api.provider.Property<com.cognifide.gradle.aem.common.instance.local.OpenMode> getOpenMode()

Automatically open a web browser when instances are up.

getOpenTimeout

public org.gradle.api.provider.Property<java.lang.Long> getOpenTimeout()

Maximum time to wait for browser open command response.

openMode

public void openMode(@NotNull
                     java.lang.String name)

resolveFiles

public void resolveFiles()

getStatusTimeout

public org.gradle.api.provider.Property<java.lang.Long> getStatusTimeout()

Maximum time to wait for status script response.

getSourceFiles

public org.gradle.api.file.ConfigurableFileCollection getSourceFiles()

Collection of files potentially needed to create instance

getExpandFiles

public org.gradle.api.provider.ListProperty<java.lang.String> getExpandFiles()

Wildcard file name filter expression that is used to filter in which instance files properties can be injected.

getExpandProperties

public org.gradle.api.provider.MapProperty<java.lang.String,java.lang.Object> getExpandProperties()

Custom properties that can be injected into instance files.

getQuickstart

@NotNull
public QuickstartResolver getQuickstart()

quickstart

public void quickstart(@NotNull
                       kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.local.QuickstartResolver,kotlin.Unit> options)

Configure AEM source files when creating instances from the scratch.

getBackup

@NotNull
public BackupManager getBackup()

Configure AEM backup sources.

backup

public void backup(@NotNull
                   kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.local.BackupManager,kotlin.Unit> options)

getBackupZip

@Nullable
public java.io.File getBackupZip()

getInstall

@NotNull
public InstallResolver getInstall()

install

public void install(@NotNull
                    kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.local.InstallResolver,kotlin.Unit> options)

Configure CRX packages, bundles to be pre-installed on instance(s).

init

public void init(@NotNull
                 kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.LocalInstance,kotlin.Unit> options)

Configure action to be performed only once when instance is up first time.

create

@NotNull
public java.util.List<com.cognifide.gradle.aem.common.instance.LocalInstance> create(@NotNull
                                                                                              LocalInstance instance)

create

@NotNull
public java.util.List<com.cognifide.gradle.aem.common.instance.LocalInstance> create(@NotNull
                                                                                              java.util.Collection<com.cognifide.gradle.aem.common.instance.LocalInstance> instances)

createBySource

public void createBySource(@NotNull
                           java.util.Collection<com.cognifide.gradle.aem.common.instance.LocalInstance> instances)

createFromBackup

public void createFromBackup(@NotNull
                             java.util.Collection<com.cognifide.gradle.aem.common.instance.LocalInstance> instances,
                             @NotNull
                             java.io.File backupZip)

createFromScratch

public void createFromScratch(@NotNull
                              java.util.Collection<com.cognifide.gradle.aem.common.instance.LocalInstance> instances)

destroy

public boolean destroy(@NotNull
                       LocalInstance instance)

destroy

@NotNull
public java.util.List<com.cognifide.gradle.aem.common.instance.LocalInstance> destroy(@NotNull
                                                                                               java.util.Collection<com.cognifide.gradle.aem.common.instance.LocalInstance> instances)

up

public boolean up(@NotNull
                  LocalInstance instance,
                  @NotNull
                  kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.action.AwaitUpAction,kotlin.Unit> awaitUpOptions)

up

@NotNull
public java.util.List<com.cognifide.gradle.aem.common.instance.LocalInstance> up(@NotNull
                                                                                          java.util.Collection<com.cognifide.gradle.aem.common.instance.LocalInstance> instances,
                                                                                          @NotNull
                                                                                          kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.action.AwaitUpAction,kotlin.Unit> awaitUpOptions)

down

public boolean down(@NotNull
                    LocalInstance instance,
                    @NotNull
                    kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.action.AwaitDownAction,kotlin.Unit> awaitDownOptions)

down

@NotNull
public java.util.List<com.cognifide.gradle.aem.common.instance.LocalInstance> down(@NotNull
                                                                                            java.util.Collection<com.cognifide.gradle.aem.common.instance.LocalInstance> instances,
                                                                                            @NotNull
                                                                                            kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.action.AwaitDownAction,kotlin.Unit> awaitDownOptions)

open

@NotNull
public java.util.List<com.cognifide.gradle.aem.common.instance.LocalInstance> open(@NotNull
                                                                                            LocalInstance instance)

open

@NotNull
public java.util.List<com.cognifide.gradle.aem.common.instance.LocalInstance> open(@NotNull
                                                                                            java.util.Collection<com.cognifide.gradle.aem.common.instance.LocalInstance> instances)

examine

public void examine(@NotNull
                    java.util.Collection<com.cognifide.gradle.aem.common.instance.LocalInstance> instances)

examinePrerequisites

public void examinePrerequisites(@NotNull
                                 java.util.Collection<com.cognifide.gradle.aem.common.instance.LocalInstance> instances)

examinePaths

public void examinePaths()

examineJavaAvailable

public void examineJavaAvailable()

Pre-conditionally check if 'java' is available in shell scripts.

Gradle is intelligently looking by its own for installed Java, but AEM control scripts are just requiring 'java' command available in 'PATH' environment variable.

getJavaCompatibility

public org.gradle.api.provider.MapProperty<java.lang.String,java.lang.String> getJavaCompatibility()

Defines compatibility related to AEM versions and Java versions.

AEM version is definable as range inclusive at a start, exclusive at an end. Java Version is definable as list of supported versions pipe delimited.

examineJavaCompatibility

public void examineJavaCompatibility(@NotNull
                                     java.util.Collection<com.cognifide.gradle.aem.common.instance.LocalInstance> instances)

examineRunningOther

public void examineRunningOther(@NotNull
                                java.util.Collection<com.cognifide.gradle.aem.common.instance.LocalInstance> instances)