com.cognifide.gradle.aem.instance.satisfy

Class PackageGroup

FileGroup

com.cognifide.gradle.aem.instance.satisfy.PackageGroup

public class PackageGroup
extends FileGroup

Allows to customize behavior of satisfy task for concrete group of packages.

Constructor Summary

Constructors

Constructor and Description
PackageGroup(PackageResolver resolver, java.lang.String name) Allows to customize behavior of satisfy task for concrete group of packages.

Method Summary

Modifier and Type	Method and Description
void	completer(kotlin.jvm.functions.Function0<kotlin.Unit> callback) Hook after deploying all packages to all instances called only when at least one package was deployed on any instance.
protected FileResolution	createResolution(java.lang.String id, kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.file.resolver.FileResolution,? extends java.io.File> resolver)
void	finalizer(kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.InstanceSync,kotlin.Unit> callback) Hook for cleaning instance after deploying packages
java.lang.Boolean	getDistributed() Enables deployment via CRX package activation from author to publishers when e.g they are not accessible.
boolean	getGreedy() Forces to upload and install package again regardless its state on instances (already uploaded / installed).
java.lang.Boolean	getInstallRecursive() Determines if when on package install, sub-packages included in CRX package content should be also installed.
Retry	getInstallRetry() Repeat install when failed (brute-forcing).
java.lang.String	getInstanceName() Instance name filter for excluding group from deployment.
PackageResolver	getResolver()
java.lang.Boolean	getUploadForce() Force upload CRX package regardless if it was previously uploaded.
Retry	getUploadRetry() Repeat upload when failed (brute-forcing).
java.util.Map<java.lang.String,java.lang.Boolean>	getWorkflowToggle() Allows to temporarily enable or disable workflows during CRX package deployment.
void	initializer(kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.InstanceSync,kotlin.Unit> callback) Hook for preparing instance before deploying packages
void	setDistributed(java.lang.Boolean p) Enables deployment via CRX package activation from author to publishers when e.g they are not accessible.
void	setGreedy(boolean p) Forces to upload and install package again regardless its state on instances (already uploaded / installed).
void	setInstallRecursive(java.lang.Boolean p) Determines if when on package install, sub-packages included in CRX package content should be also installed.
void	setInstallRetry(Retry p) Repeat install when failed (brute-forcing).
void	setInstanceName(java.lang.String p) Instance name filter for excluding group from deployment.
void	setUploadForce(java.lang.Boolean p) Force upload CRX package regardless if it was previously uploaded.
void	setUploadRetry(Retry p) Repeat upload when failed (brute-forcing).
void	setWorkflowToggle(java.util.Map<java.lang.String,java.lang.Boolean> p) Allows to temporarily enable or disable workflows during CRX package deployment.
void	workflowToggle(java.lang.String id, boolean flag) Allows to temporarily enable or disable workflow during CRX package deployment.

Methods inherited from class com.cognifide.gradle.aem.common.file.resolver.FileGroup

createResolution, getAem, getDirs, getDownloadDir, getFiles, getName, getResolutions, resolve

Constructor Detail

PackageGroup

public PackageGroup(@NotNull
                    PackageResolver resolver,
                    @NotNull
                    java.lang.String name)

Allows to customize behavior of satisfy task for concrete group of packages.

Method Detail

getGreedy

public boolean getGreedy()

Forces to upload and install package again regardless its state on instances (already uploaded / installed).

setGreedy

public void setGreedy(boolean p)

Forces to upload and install package again regardless its state on instances (already uploaded / installed).

getInstanceName

@NotNull
public java.lang.String getInstanceName()

Instance name filter for excluding group from deployment.

setInstanceName

public void setInstanceName(@NotNull
                            java.lang.String p)

Instance name filter for excluding group from deployment.

getDistributed

@Nullable
public java.lang.Boolean getDistributed()

Enables deployment via CRX package activation from author to publishers when e.g they are not accessible.

setDistributed

public void setDistributed(@Nullable
                           java.lang.Boolean p)

Enables deployment via CRX package activation from author to publishers when e.g they are not accessible.

getUploadForce

@Nullable
public java.lang.Boolean getUploadForce()

Force upload CRX package regardless if it was previously uploaded.

setUploadForce

public void setUploadForce(@Nullable
                           java.lang.Boolean p)

Force upload CRX package regardless if it was previously uploaded.

getUploadRetry

@Nullable
public Retry getUploadRetry()

Repeat upload when failed (brute-forcing).

setUploadRetry

public void setUploadRetry(@Nullable
                           Retry p)

Repeat upload when failed (brute-forcing).

getInstallRetry

@Nullable
public Retry getInstallRetry()

Repeat install when failed (brute-forcing).

setInstallRetry

public void setInstallRetry(@Nullable
                            Retry p)

Repeat install when failed (brute-forcing).

getInstallRecursive

@Nullable
public java.lang.Boolean getInstallRecursive()

Determines if when on package install, sub-packages included in CRX package content should be also installed.

setInstallRecursive

public void setInstallRecursive(@Nullable
                                java.lang.Boolean p)

Determines if when on package install, sub-packages included in CRX package content should be also installed.

getWorkflowToggle

@NotNull
public java.util.Map<java.lang.String,java.lang.Boolean> getWorkflowToggle()

Allows to temporarily enable or disable workflows during CRX package deployment.

setWorkflowToggle

public void setWorkflowToggle(@NotNull
                              java.util.Map<java.lang.String,java.lang.Boolean> p)

Allows to temporarily enable or disable workflows during CRX package deployment.

workflowToggle

public void workflowToggle(@NotNull
                           java.lang.String id,
                           boolean flag)

Allows to temporarily enable or disable workflow during CRX package deployment.

initializer

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

Hook for preparing instance before deploying packages

finalizer

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

Hook for cleaning instance after deploying packages

completer

public void completer(@NotNull
                      kotlin.jvm.functions.Function0<kotlin.Unit> callback)

Hook after deploying all packages to all instances called only when at least one package was deployed on any instance.

createResolution

@NotNull
protected FileResolution createResolution(@NotNull
                                                    java.lang.String id,
                                                    @NotNull
                                                    kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.file.resolver.FileResolution,? extends java.io.File> resolver)

getResolver

@NotNull
public PackageResolver getResolver()