com.cognifide.gradle.aem

Class AemExtension

com.cognifide.gradle.aem.AemExtension

public class AemExtension

Core of library, facade for implementing tasks.

Field Detail

NAME

@NotNull
public static java.lang.String NAME

See Also:

Constant Field Values

Companion

public static com.cognifide.gradle.aem.AemExtension.Companion Companion

Constructor Detail

AemExtension

public AemExtension(@NotNull
                    org.gradle.api.Project project)

Core of library, facade for implementing tasks.

Method Detail

getCommon

@NotNull
public com.cognifide.gradle.common.CommonExtension getCommon()

getLogger

public org.gradle.api.logging.Logger getLogger()

getProp

@NotNull
public com.cognifide.gradle.common.build.PropertyParser getProp()

getObj

@NotNull
public com.cognifide.gradle.common.build.ObjectFactory getObj()

getCommonOptions

@NotNull
public CommonOptions getCommonOptions()

getAssetManager

@NotNull
public AssetManager getAssetManager()

getWebBrowser

@NotNull
public WebBrowser getWebBrowser()

common

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

Defines common settings like environment name, line endings when generating files etc

getPackageOptions

@NotNull
public PackageOptions getPackageOptions()

package

public void package(@NotNull
                    kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.pkg.PackageOptions,kotlin.Unit> options)

Defines common settings for built packages and deployment related behavior.

pkg

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

Defines common settings for built packages and deployment related behavior.

package

@NotNull
public PackageFile package(@NotNull
                                    java.io.File file)

Read CRX package properties of specified ZIP file.

pkg

@NotNull
public PackageFile pkg(@NotNull
                                java.io.File file)

Read CRX package properties of specified ZIP file.

instance

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

Defines instances to work with.

getInstanceManager

@NotNull
public InstanceManager getInstanceManager()

localInstance

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

Define common settings valid only for instances created at local file system.

getLocalInstanceManager

@NotNull
public LocalInstanceManager getLocalInstanceManager()

getBundlesBuilt

@NotNull
public java.util.List<org.gradle.api.tasks.bundling.Jar> getBundlesBuilt()

Collection of all java packages from all projects applying bundle plugin.

Use with caution as of this property is eagerly configuring all tasks building bundles.

getPackagesBuilt

@NotNull
public java.util.List<com.cognifide.gradle.aem.pkg.tasks.PackageCompose> getPackagesBuilt()

Collection of Vault definitions from all packages from all projects applying package plugin.

Use with caution as of this property is eagerly configuring all tasks building packages.

getJavaPackage

@Nullable
public java.lang.String getJavaPackage()

Java package of built bundle (if project is applying bundle plugin).

getJavaPackages

@NotNull
public java.util.List<java.lang.String> getJavaPackages()

Collection of all java packages from all projects applying bundle plugin.

getInstances

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

All instances matching default filtering.

instances

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

Work in parallel with instances matching default filtering.

instances

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

Work in parallel with instances which name is matching specified wildcard filter.

instance

@NotNull
public Instance instance(@NotNull
                                  java.lang.String urlOrName)

Shorthand method for getting defined instance or creating temporary instance by URL.

instances

@NotNull
public java.util.List<com.cognifide.gradle.aem.common.instance.Instance> instances(@NotNull
                                                                                            java.lang.Iterable<java.lang.String> urlsOrNames)

Shorthand method for getting defined instances or creating temporary instances by URLs.

getAnyInstance

@NotNull
public Instance getAnyInstance()

Get instance from command line parameter named 'instance' which holds instance name or URL. If it is not specified, then first instance matching default filtering fill be returned.

Purpose of this method is to easily get any instance to work with (no matter how it will be defined).

getAvailableInstance

@Nullable
public Instance getAvailableInstance()

Get available instance of any type (most often first defined).

findInstance

@Nullable
public Instance findInstance(@Nullable
                                       java.lang.String desiredName,
                                       @NotNull
                                       java.lang.String defaultName)

Find instance which name is matching wildcard filter specified via command line parameter 'instance.name'. By default, this method respects current environment which is used to work only with instances running locally.

namedInstance

@NotNull
public Instance namedInstance(@Nullable
                                       java.lang.String desiredName,
                                       @NotNull
                                       java.lang.String defaultName)

Get instance which name is matching wildcard filter specified via command line parameter 'instance.name'. By default, this method respects current environment which is used to work only with instances running locally.

If instance not found, throws exception.

filterInstances

@NotNull
public java.util.List<com.cognifide.gradle.aem.common.instance.Instance> filterInstances(@NotNull
                                                                                                  java.lang.String nameMatcher)

Find all instances which names are matching wildcard filter specified via command line parameter 'instance.name'.

getAuthorInstances

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

Get all author instances running on current environment.

getAuthorInstance

@NotNull
public Instance getAuthorInstance()

authorInstances

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

Work in parallel with all author instances running on current environment.

getPublishInstances

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

Get all publish instances running on current environment.

getPublishInstance

@NotNull
public Instance getPublishInstance()

publishInstances

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

Work in parallel with all publish instances running on current environment.

getLocalInstances

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

Get all local instances.

localInstances

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

Work in parallel with all local instances.

getRemoteInstances

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

Get all remote instances.

remoteInstances

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

Work in parallel with all remote instances.

getPackage

@NotNull
public java.io.File getPackage()

Get CRX package defined to be built (could not yet exist).

getPkg

@NotNull
public java.io.File getPkg()

getPackages

@NotNull
public java.util.List<java.io.File> getPackages()

Get all CRX packages defined to be built.

getBundle

@NotNull
public java.io.File getBundle()

Get OSGi bundle defined to be built (could not yet exist).

getBundles

@NotNull
public java.util.List<java.io.File> getBundles()

Get all OSGi bundles defined to be built.

bundleEmbed

public void bundleEmbed(@NotNull
                        java.lang.Object dependencyNotation,
                        @NotNull
                        java.lang.Iterable<java.lang.String> pkgs,
                        boolean export)

Shorthand for embedding code inside OSGi bundle being composed when configuration on demand is enabled. When this feature is not enabled, it is preferred to use BundleJar.embedPackage.

See Also:

BundleJar.embedPackage

bundleEmbed

public void bundleEmbed(@NotNull
                        java.lang.Object dependencyNotation,
                        @NotNull
                        java.lang.String[] pkgs,
                        boolean export)

Shorthand for embedding code inside OSGi bundle being composed when configuration on demand is enabled. When this feature is not enabled, it is preferred to use BundleJar.embedPackage.

See Also:

BundleJar.embedPackage

sync

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

In parallel, work with services of all instances matching default filtering.

syncInstances

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

In parallel, work with services of all instances matching default filtering.

sync

public <T> T sync(@NotNull
                  Instance instance,
                  @NotNull
                  kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.InstanceSync,? extends T> action)

Work with instance services of specified instance.

syncInstance

public <T> T syncInstance(@NotNull
                          Instance instance,
                          @NotNull
                          kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.InstanceSync,? extends T> action)

Work with instance services of specified instance.

sync

public void sync(@NotNull
                 java.lang.Iterable<? extends com.cognifide.gradle.aem.common.instance.Instance> instances,
                 @NotNull
                 kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.InstanceSync,kotlin.Unit> action)

In parallel, work with services of all specified instances.

syncInstances

public void syncInstances(@NotNull
                          java.lang.Iterable<? extends com.cognifide.gradle.aem.common.instance.Instance> instances,
                          @NotNull
                          kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.InstanceSync,kotlin.Unit> action)

In parallel, work with services of all specified instances.

syncPackages

public void syncPackages(@NotNull
                         kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.instance.InstanceSync,? super java.io.File,kotlin.Unit> action)

In parallel, work with built packages and services of instances matching default filtering.

syncBundles

public void syncBundles(@NotNull
                        kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.instance.InstanceSync,? super java.io.File,kotlin.Unit> action)

In parallel, work with built OSGi bundles and services of instances matching default filtering.

syncFiles

public void syncFiles(@NotNull
                      java.lang.Iterable<? extends com.cognifide.gradle.aem.common.instance.Instance> instances,
                      @NotNull
                      java.lang.Iterable<? extends java.io.File> packages,
                      @NotNull
                      kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.instance.InstanceSync,? super java.io.File,kotlin.Unit> action)

In parallel, work with built packages and services of specified instances.

composePackage

@NotNull
public java.io.File composePackage(@NotNull
                                            kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.pkg.PackageDefinition,kotlin.Unit> definition)

Build minimal CRX package in-place / only via code. All details like Vault properties, archive destination directory, file name are customizable.

validatePackage

public void validatePackage(@NotNull
                            java.io.File[] packages,
                            @NotNull
                            kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.pkg.PackageValidator,kotlin.Unit> options)

Validate any CRX packages.

validatePackage

public void validatePackage(@NotNull
                            java.lang.Iterable<? extends java.io.File> packages,
                            @NotNull
                            kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.pkg.PackageValidator,kotlin.Unit> options)

Validate any CRX packages.

getFilter

@NotNull
public FilterFile getFilter()

Vault filter determined by convention and properties.

filter

@NotNull
public FilterFile filter(@NotNull
                                  java.io.File file)

Get Vault filter object for specified file.

filter

@NotNull
public FilterFile filter(@NotNull
                                  java.lang.String path)

Get Vault filter object for specified path.

vlt

@NotNull
public VaultSummary vlt(@NotNull
                                 java.lang.String command)

Execute any Vault command.

vlt

public <T> T vlt(@NotNull
                 kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.pkg.vault.VaultClient,? extends T> options)

Execute any Vault command with customized options like content directory.

rcp

public <T> T rcp(@NotNull
                 kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.rcp.RcpClient,? extends T> options)

Execute any Vault JCR content remote copying with customized options like content directory.

groovyEval

public <T> T groovyEval(@NotNull
                        kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.service.groovy.GroovyEvaluator,? extends T> options)

Execute Groovy script(s) using specified options.

groovyEval

@NotNull
public GroovyEvalSummary groovyEval(@NotNull
                                             java.lang.String scriptPattern)

Execute Groovy script(s) matching file pattern on AEM instances.

getProject

@NotNull
public org.gradle.api.Project getProject()