com.cognifide.gradle.aem.pkg.tasks

Class PackageCompose

ZipTask

com.cognifide.gradle.aem.pkg.tasks.PackageCompose

All Implemented Interfaces:

AemTask

public class PackageCompose
extends ZipTask

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PackageCompose.Companion

Nested classes/interfaces inherited from interface com.cognifide.gradle.aem.AemTask

AemTask.DefaultImpls

Field Summary

Fields

Modifier and Type	Field and Description
static PackageCompose.Companion	Companion
static java.lang.String	NAME

Fields inherited from interface com.cognifide.gradle.aem.AemTask

GROUP

Constructor Summary

Constructors

Constructor and Description
PackageCompose()

Method Summary

Modifier and Type	Method and Description
protected void	copy()
void	fileFilter(kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.pkg.PackageFileFilter,kotlin.Unit> configurer)
void	fromBundle(java.lang.String jarTaskPath)
void	fromCompose(java.lang.String composeTaskPath)
void	fromConvention()
void	fromJar(kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.build.DependencyOptions,kotlin.Unit> dependencyOptions, java.lang.String installPath, java.lang.Boolean vaultFilter)
void	fromJar(java.lang.String dependencyNotation, java.lang.String installPath, java.lang.Boolean vaultFilter)
void	fromJar(org.gradle.api.tasks.bundling.Jar bundle, java.lang.String bundlePath, java.lang.Boolean vaultFilter)
void	fromJar(java.io.File jar, java.lang.String bundlePath, java.lang.Boolean vaultFilter)
void	fromJars(java.util.Collection<? extends java.io.File> jars, java.lang.String bundlePath, java.lang.Boolean vaultFilter)
void	fromMeta()
void	fromMeta(java.io.File metaDir)
void	fromProject()
void	fromProject(java.lang.String path, kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.pkg.tasks.compose.ProjectMergingOptions,kotlin.Unit> options)
void	fromProject(java.lang.String path, ProjectMergingOptions options)
void	fromProject(org.gradle.api.Project project, kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.pkg.tasks.compose.ProjectMergingOptions,kotlin.Unit> options)
void	fromProject(org.gradle.api.Project project, ProjectMergingOptions options)
void	fromProjects(java.lang.String pathFilter, kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.pkg.tasks.compose.ProjectMergingOptions,kotlin.Unit> options)
void	fromProjects(java.lang.String pathFilter, ProjectMergingOptions options)
void	fromSubprojects(kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.pkg.tasks.compose.ProjectMergingOptions,kotlin.Unit> options)
void	fromSubprojects(ProjectMergingOptions options)
void	fromZip(kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.build.DependencyOptions,kotlin.Unit> dependencyOptions, java.lang.String storagePath, java.lang.Boolean vaultFilter)
void	fromZip(java.lang.String dependencyNotation, java.lang.String storagePath, java.lang.Boolean vaultFilter)
void	fromZip(java.io.File zip, java.lang.String packagePath, java.lang.Boolean vaultFilter)
void	fromZips(java.util.Collection<? extends java.io.File> zips, java.lang.String packagePath, java.lang.Boolean vaultFilter)
java.lang.String	getBundlePath() Content path for OSGi bundle jars being placed in CRX package.
java.io.File	getContentDir() Absolute path to JCR content to be included in CRX package.
PackageFileFilter	getFileFilter()
kotlin.jvm.functions.Function1<org.gradle.api.file.CopySpec,kotlin.Unit>	getFileFilterDelegate()
java.util.Map<java.lang.String,com.cognifide.gradle.aem.common.pkg.vlt.VltDefinition>	getFileProperties()
boolean	getFromConvention()
boolean	getMetaDefaults() Ensures that for directory 'META-INF/vault' default files will be generated when missing: 'config.xml', 'filter.xml', 'properties.xml' and 'settings.xml'.
java.io.File	getMetaDir()
java.util.List<java.io.File>	getMetaDirs() CRX package Vault files will be composed from given sources. Missing files required by package within installation will be auto-generated if 'vaultCopyMissingFiles' is enabled.
java.lang.String	getPackagePath() Content path for CRX sub-packages being placed in CRX package being built.
VltDefinition	getVaultDefinition() Defines properties being used to generate CRX package metadata files.
java.io.File	getVaultDir()
java.io.File	getVaultFilterFile()
java.io.File	getVaultNodeTypesFile()
void	merging(kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.pkg.tasks.compose.ProjectMergingOptions,kotlin.Unit> options)
void	projectEvaluated()
void	projectsEvaluated()
void	setBundlePath(java.lang.String p) Content path for OSGi bundle jars being placed in CRX package.
void	setContentDir(java.io.File p) Absolute path to JCR content to be included in CRX package.
void	setFileFilterDelegate(kotlin.jvm.functions.Function1<? super org.gradle.api.file.CopySpec,kotlin.Unit> p)
void	setFromConvention(boolean p)
void	setMetaDefaults(boolean p) Ensures that for directory 'META-INF/vault' default files will be generated when missing: 'config.xml', 'filter.xml', 'properties.xml' and 'settings.xml'.
void	setPackagePath(java.lang.String p) Content path for CRX sub-packages being placed in CRX package being built.
void	vaultDefinition(kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.pkg.vlt.VltDefinition,kotlin.Unit> options)

Methods inherited from class com.cognifide.gradle.aem.common.tasks.ZipTask

copy, getAem, getCopyProgress, setCopyProgress

Methods inherited from interface com.cognifide.gradle.aem.AemTask

getAem, projectEvaluated, projectsEvaluated, taskGraphReady

Field Detail

NAME

@NotNull
public static java.lang.String NAME

See Also:

Constant Field Values

Companion

public static PackageCompose.Companion Companion

Constructor Detail

PackageCompose

public PackageCompose()

Method Detail

getContentDir

@NotNull
public java.io.File getContentDir()

Absolute path to JCR content to be included in CRX package.

Must be absolute or relative to current working directory.

setContentDir

public void setContentDir(@NotNull
                          java.io.File p)

Absolute path to JCR content to be included in CRX package.

Must be absolute or relative to current working directory.

getBundlePath

@NotNull
public java.lang.String getBundlePath()

Content path for OSGi bundle jars being placed in CRX package.

setBundlePath

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

Content path for OSGi bundle jars being placed in CRX package.

getPackagePath

@NotNull
public java.lang.String getPackagePath()

Content path for CRX sub-packages being placed in CRX package being built.

setPackagePath

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

Content path for CRX sub-packages being placed in CRX package being built.

getMetaDefaults

public boolean getMetaDefaults()

Ensures that for directory 'META-INF/vault' default files will be generated when missing: 'config.xml', 'filter.xml', 'properties.xml' and 'settings.xml'.

setMetaDefaults

public void setMetaDefaults(boolean p)

Ensures that for directory 'META-INF/vault' default files will be generated when missing: 'config.xml', 'filter.xml', 'properties.xml' and 'settings.xml'.

getMetaDir

@NotNull
public java.io.File getMetaDir()

getMetaDirs

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

CRX package Vault files will be composed from given sources. Missing files required by package within installation will be auto-generated if 'vaultCopyMissingFiles' is enabled.

getVaultDefinition

@NotNull
public VltDefinition getVaultDefinition()

Defines properties being used to generate CRX package metadata files.

vaultDefinition

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

getVaultDir

@Internal
 @NotNull
public java.io.File getVaultDir()

getVaultFilterFile

@Internal
 @NotNull
public java.io.File getVaultFilterFile()

getVaultNodeTypesFile

@Internal
 @NotNull
public java.io.File getVaultNodeTypesFile()

getFileFilter

@NotNull
public PackageFileFilter getFileFilter()

fileFilter

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

getFileFilterDelegate

@NotNull
public kotlin.jvm.functions.Function1<org.gradle.api.file.CopySpec,kotlin.Unit> getFileFilterDelegate()

setFileFilterDelegate

public void setFileFilterDelegate(@NotNull
                                  kotlin.jvm.functions.Function1<? super org.gradle.api.file.CopySpec,kotlin.Unit> p)

getFileProperties

@Internal
 @NotNull
public java.util.Map<java.lang.String,com.cognifide.gradle.aem.common.pkg.vlt.VltDefinition> getFileProperties()

getFromConvention

public boolean getFromConvention()

setFromConvention

public void setFromConvention(boolean p)

merging

public void merging(@NotNull
                    kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.pkg.tasks.compose.ProjectMergingOptions,kotlin.Unit> options)

projectEvaluated

public void projectEvaluated()

projectsEvaluated

public void projectsEvaluated()

copy

protected void copy()

fromConvention

public void fromConvention()

fromProject

public void fromProject()

fromProject

public void fromProject(@NotNull
                        java.lang.String path,
                        @NotNull
                        kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.pkg.tasks.compose.ProjectMergingOptions,kotlin.Unit> options)

fromProject

public void fromProject(@NotNull
                        java.lang.String path,
                        @NotNull
                        ProjectMergingOptions options)

fromProjects

public void fromProjects(@NotNull
                         java.lang.String pathFilter,
                         @NotNull
                         kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.pkg.tasks.compose.ProjectMergingOptions,kotlin.Unit> options)

fromProjects

public void fromProjects(@NotNull
                         java.lang.String pathFilter,
                         @NotNull
                         ProjectMergingOptions options)

fromSubprojects

public void fromSubprojects(@NotNull
                            kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.pkg.tasks.compose.ProjectMergingOptions,kotlin.Unit> options)

fromSubprojects

public void fromSubprojects(@NotNull
                            ProjectMergingOptions options)

fromMeta

public void fromMeta()

fromMeta

public void fromMeta(@NotNull
                     java.io.File metaDir)

fromProject

public void fromProject(@NotNull
                        org.gradle.api.Project project,
                        @NotNull
                        kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.pkg.tasks.compose.ProjectMergingOptions,kotlin.Unit> options)

fromProject

public void fromProject(@NotNull
                        org.gradle.api.Project project,
                        @NotNull
                        ProjectMergingOptions options)

fromCompose

public void fromCompose(@NotNull
                        java.lang.String composeTaskPath)

fromBundle

public void fromBundle(@NotNull
                       java.lang.String jarTaskPath)

fromJar

public void fromJar(@NotNull
                    kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.build.DependencyOptions,kotlin.Unit> dependencyOptions,
                    @Nullable
                    java.lang.String installPath,
                    @Nullable
                    java.lang.Boolean vaultFilter)

fromJar

public void fromJar(@NotNull
                    java.lang.String dependencyNotation,
                    @Nullable
                    java.lang.String installPath,
                    @Nullable
                    java.lang.Boolean vaultFilter)

fromJar

public void fromJar(@NotNull
                    org.gradle.api.tasks.bundling.Jar bundle,
                    @Nullable
                    java.lang.String bundlePath,
                    @Nullable
                    java.lang.Boolean vaultFilter)

fromJar

public void fromJar(@NotNull
                    java.io.File jar,
                    @Nullable
                    java.lang.String bundlePath,
                    @Nullable
                    java.lang.Boolean vaultFilter)

fromJars

public void fromJars(@NotNull
                     java.util.Collection<? extends java.io.File> jars,
                     @Nullable
                     java.lang.String bundlePath,
                     @Nullable
                     java.lang.Boolean vaultFilter)

fromZip

public void fromZip(@NotNull
                    kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.build.DependencyOptions,kotlin.Unit> dependencyOptions,
                    @Nullable
                    java.lang.String storagePath,
                    @Nullable
                    java.lang.Boolean vaultFilter)

fromZip

public void fromZip(@NotNull
                    java.lang.String dependencyNotation,
                    @Nullable
                    java.lang.String storagePath,
                    @Nullable
                    java.lang.Boolean vaultFilter)

fromZip

public void fromZip(@NotNull
                    java.io.File zip,
                    @Nullable
                    java.lang.String packagePath,
                    @Nullable
                    java.lang.Boolean vaultFilter)

fromZips

public void fromZips(@NotNull
                     java.util.Collection<? extends java.io.File> zips,
                     @Nullable
                     java.lang.String packagePath,
                     @Nullable
                     java.lang.Boolean vaultFilter)