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

PackageDefinition

class PackageDefinition : VltDefinition

Package definition 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 definition that could be used to compose CRX package in place.

PackageDefinition(aem: AemExtension)

Properties

archiveAppendix

var archiveAppendix: String?

archiveBaseName

var archiveBaseName: String

archiveClassifier

var archiveClassifier: String?

archiveExtension

var archiveExtension: String

archiveFileName

ZIP file name

var archiveFileName: String

archivePath

ZIP file path

var archivePath: File

archiveVersion

var archiveVersion: String

destinationDirectory

var destinationDirectory: File

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(definition: PackageDefinition.() -> Unit): 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