com.cognifide.gradle.aem.common.pkg

Class PackageDefinition

VaultDefinition

com.cognifide.gradle.aem.common.pkg.PackageDefinition

public class PackageDefinition
extends VaultDefinition

Package builder that could be used to compose CRX package in place.

This is programmatic approach to create ZIP file. API reflects Gradle's AbstractArchiveTask. Useful for writing complex custom tasks that cannot inherit from Gradle's ZIP task.

Constructor Detail

PackageDefinition

public PackageDefinition(@NotNull
                         AemExtension aem)

Package builder that could be used to compose CRX package in place.

This is programmatic approach to create ZIP file. API reflects Gradle's AbstractArchiveTask. Useful for writing complex custom tasks that cannot inherit from Gradle's ZIP task.

Method Detail

getDestinationDirectory

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

getArchiveBaseName

public org.gradle.api.provider.Property<java.lang.String> getArchiveBaseName()

getArchiveAppendix

public org.gradle.api.provider.Property<java.lang.String> getArchiveAppendix()

getArchiveExtension

public org.gradle.api.provider.Property<java.lang.String> getArchiveExtension()

getArchiveClassifier

public org.gradle.api.provider.Property<java.lang.String> getArchiveClassifier()

getArchiveVersion

public org.gradle.api.provider.Property<java.lang.String> getArchiveVersion()

getArchivePath

public org.gradle.api.file.RegularFileProperty getArchivePath()

ZIP file path

getArchiveFileName

public org.gradle.api.provider.Property<java.lang.String> getArchiveFileName()

ZIP file name

getPkgDir

@NotNull
public java.io.File getPkgDir()

Temporary directory being zipped to produce CRX package.

getMetaDir

@NotNull
public java.io.File getMetaDir()

getJcrDir

@NotNull
public java.io.File getJcrDir()

content

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

Hook for adding files to package being composed.

copyJcrFile

public void copyJcrFile(@NotNull
                        java.io.File file,
                        @NotNull
                        java.lang.String path)

copyMetaFiles

public void copyMetaFiles(boolean skipExisting)

expandMetaFiles

public void expandMetaFiles(@NotNull
                            java.util.List<java.lang.String> filePatterns)

getExpandProperties

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

expandFiles

public void expandFiles(@NotNull
                        java.io.File dir,
                        @NotNull
                        java.util.List<java.lang.String> filePatterns)

compose

@NotNull
public java.io.File compose()

Compose a CRX package basing on configured definition.