aem-plugin / com.cognifide.gradle.aem.common.pkg / PackageDefinition

PackageDefinition

class PackageDefinition : 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.

Constructors

<init>

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

PackageDefinition(aem: AemExtension)

Properties

archiveAppendix	`val archiveAppendix: Property<String!>!`
archiveBaseName	`val archiveBaseName: Property<String!>!`
archiveClassifier	`val archiveClassifier: Property<String!>!`
archiveExtension	`val archiveExtension: Property<String!>!`
archiveFileName	ZIP file name `val archiveFileName: Property<String!>!`
archivePath	ZIP file path `val archivePath: RegularFileProperty!`
archiveVersion	`val archiveVersion: Property<String!>!`
destinationDirectory	`val destinationDirectory: DirectoryProperty!`
expandProperties	`val expandProperties: MapProperty<String!, Any!>!`
jcrDir	`val jcrDir: File`
metaDir	`val metaDir: File`
pkgDir	Temporary directory being zipped to produce CRX package. `val pkgDir: File`

Functions

compose	Compose a CRX package basing on configured definition. `fun compose(): File`
content	Hook for adding files to package being composed. `fun content(options: PackageDefinition.() -> Unit): Unit`
copyJcrFile	`fun copyJcrFile(file: File, path: String): Unit`
copyMetaFiles	`fun copyMetaFiles(skipExisting: Boolean = true): Unit`
expandFiles	`fun expandFiles(dir: File, filePatterns: List<String> = PackageFileFilter.EXPAND_FILES_DEFAULT): Unit`
expandMetaFiles	`fun expandMetaFiles(filePatterns: List<String> = PackageFileFilter.EXPAND_FILES_DEFAULT): Unit`
process	Hook for customizing how package will be processed before zipping. `fun process(options: PackageDefinition.() -> Unit): Unit`