com.cognifide.gradle.aem.common.instance

Class InstanceManager

com.cognifide.gradle.aem.common.instance.InstanceManager

public class InstanceManager

Constructor Detail

InstanceManager

public InstanceManager(@NotNull
                       AemExtension aem)

Method Detail

getLocal

@NotNull
public LocalInstanceManager getLocal()

getProjectDir

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

Using remote AEM instances is acceptable in any project, so that lookup for project applying local instance plugin is required Needed to determine common directory storing instance related resources (tailer incident filter, Groovy scripts etc).

getConfigDir

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

Directory storing instance wide configuration files.

getBuildDir

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

Directory storing outputs of instance tasks.

getSatisfier

@NotNull
public Satisfier getSatisfier()

satisfier

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

getProvisioner

@NotNull
public Provisioner getProvisioner()

provisioner

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

getTailer

@NotNull
public Tailer getTailer()

tailer

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

getStatusReporter

@NotNull
public StatusReporter getStatusReporter()

statusReporter

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

resolveFiles

public void resolveFiles()

getDefined

public org.gradle.api.provider.ListProperty<com.cognifide.gradle.aem.common.instance.Instance> getDefined()

List of AEM instances e.g on which packages could be deployed. Instance stored in map ensures name uniqueness and allows to be referenced in expanded properties.

getAll

public org.gradle.api.provider.Provider<java.util.Map> getAll()

Map of AEM instances with names as a keys.

sync

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

Customize default options for instance services.

local

public void local(@NotNull
                  java.lang.String httpUrl)

Define local instance (created on local file system).

local

public void local(@NotNull
                  java.lang.String httpUrl,
                  @NotNull
                  java.lang.String name)

Define local instance (created on local file system).

local

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

Define local instance (created on local file system).

remote

public void remote(@NotNull
                   java.lang.String httpUrl)

Define remote instance (available on any host).

remote

public void remote(@NotNull
                   java.lang.String httpUrl,
                   @NotNull
                   java.lang.String name)

Define remote instance (available on any host).

remote

public void remote(@NotNull
                   java.lang.String httpUrl,
                   @NotNull
                   kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.Instance,kotlin.Unit> options)

Define remote instance (available on any host).

named

@NotNull
public Instance named(@NotNull
                               java.lang.String name)

parse

@NotNull
public Instance parse(@NotNull
                               java.lang.String url)

Get defined instance by name or create temporary definition if URL provided.

awaitUp

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

awaitUp

public void awaitUp(@NotNull
                    java.util.Collection<? extends com.cognifide.gradle.aem.common.instance.Instance> instances,
                    @NotNull
                    kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.action.AwaitUpAction,kotlin.Unit> options)

awaitDown

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

awaitDown

public void awaitDown(@NotNull
                      java.util.Collection<? extends com.cognifide.gradle.aem.common.instance.Instance> instances,
                      @NotNull
                      kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.action.AwaitDownAction,kotlin.Unit> options)

awaitReloaded

public void awaitReloaded(@NotNull
                          Instance instance,
                          @NotNull
                          kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.action.ReloadAction,kotlin.Unit> reloadOptions,
                          @NotNull
                          kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.action.AwaitUpAction,kotlin.Unit> awaitUpOptions)

awaitReloaded

public void awaitReloaded(@NotNull
                          java.util.Collection<? extends com.cognifide.gradle.aem.common.instance.Instance> instances,
                          @NotNull
                          kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.action.ReloadAction,kotlin.Unit> reloadOptions,
                          @NotNull
                          kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.action.AwaitUpAction,kotlin.Unit> awaitUpOptions)

reload

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

reload

public void reload(@NotNull
                   java.util.Collection<? extends com.cognifide.gradle.aem.common.instance.Instance> instances,
                   @NotNull
                   kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.action.ReloadAction,kotlin.Unit> options)

check

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

check

public void check(@NotNull
                  java.util.Collection<? extends com.cognifide.gradle.aem.common.instance.Instance> instances,
                  @NotNull
                  kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.action.CheckAction,kotlin.Unit> options)

examine

public void examine(@NotNull
                    Instance instance)

examine

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

Checks as much as it can be despite type of instance before performing any other operations.

Assumes that instances are already running.

examinePrerequisites

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

Checks if local instances defined are meeting prerequisites before performing any other operations.

Assumes that instances could not be running yet.

examineAvailable

public void examineAvailable(@NotNull
                             java.util.Collection<? extends com.cognifide.gradle.aem.common.instance.Instance> instances)

Checks if instances are available before performing any other operations.

getAem

@NotNull
public AemExtension getAem()