com.cognifide.gradle.aem.bundle.tasks

Class BundleCompose

com.cognifide.gradle.aem.bundle.tasks.BundleCompose

All Implemented Interfaces:

AemTask

public class BundleCompose
implements AemTask

Field Detail

NAME

@NotNull
public static java.lang.String NAME

See Also:

Constant Field Values

Companion

public static com.cognifide.gradle.aem.bundle.tasks.BundleCompose.Companion Companion

Constructor Detail

BundleCompose

public BundleCompose()

Method Detail

getAem

@NotNull
public AemExtension getAem()

getJavaConvention

public org.gradle.api.plugins.JavaPluginConvention getJavaConvention()

getBundleConvention

@NotNull
public aQute.bnd.gradle.BundleTaskConvention getBundleConvention()

getComposedFile

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

Shorthand for built OSGi bundle file.

getComposedDir

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

Shorthand for directory of built OSGi bundle file.

bndTool

public void bndTool(@NotNull
                    kotlin.jvm.functions.Function1<? super aQute.bnd.gradle.BundleTaskConvention,kotlin.Unit> options)

Allows to configure BND tool specific options.

getInstallPath

@NotNull
public java.lang.String getInstallPath()

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

setInstallPath

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

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

getInstallRunMode

@Nullable
public java.lang.String getInstallRunMode()

Suffix added to install path effectively allowing to install bundles only on specific instances.

setInstallRunMode

public void setInstallRunMode(@Nullable
                              java.lang.String p)

Suffix added to install path effectively allowing to install bundles only on specific instances.

getVaultFilter

public boolean getVaultFilter()

Determines if Vault workspace filter entry pointing directly to JAR file should be added automatically for built OSGi bundle.

setVaultFilter

public void setVaultFilter(boolean p)

Determines if Vault workspace filter entry pointing directly to JAR file should be added automatically for built OSGi bundle.

getAttributesConvention

public boolean getAttributesConvention()

Enable or disable support for auto-generating OSGi specific JAR manifest attributes like 'Bundle-SymbolicName', 'Export-Package' or AEM specific like 'Sling-Model-Packages' using 'javaPackage' property.

setAttributesConvention

public void setAttributesConvention(boolean p)

Enable or disable support for auto-generating OSGi specific JAR manifest attributes like 'Bundle-SymbolicName', 'Export-Package' or AEM specific like 'Sling-Model-Packages' using 'javaPackage' property.

getJavaPackage

@Nullable
public java.lang.String getJavaPackage()

Determines package in which OSGi bundle being built contains its classes. Basing on that value, there will be:

• generated OSGi specific manifest instructions like 'Bundle-SymbolicName', 'Export-Package'.

• generated AEM specific manifest instructions like 'Sling-Model-Packages'.

• performed additional component stability checks within 'packageDeploy' or separately using 'instanceAwait'.

Default convention: '${project.group}.${project.name}'.

Use empty string to disable automatic determining of that package and going further OSGi components checks.

setJavaPackage

public void setJavaPackage(@Nullable
                           java.lang.String p)

Determines package in which OSGi bundle being built contains its classes. Basing on that value, there will be:

• generated OSGi specific manifest instructions like 'Bundle-SymbolicName', 'Export-Package'.

• generated AEM specific manifest instructions like 'Sling-Model-Packages'.

• performed additional component stability checks within 'packageDeploy' or separately using 'instanceAwait'.

Default convention: '${project.group}.${project.name}'.

Use empty string to disable automatic determining of that package and going further OSGi components checks.

getJavaPackageOptions

@NotNull
public java.lang.String getJavaPackageOptions()

Determines how conflicts will be resolved when coincidental classes will be detected. Useful to combine Java sources with Kotlin, Scala etc.

setJavaPackageOptions

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

Determines how conflicts will be resolved when coincidental classes will be detected. Useful to combine Java sources with Kotlin, Scala etc.

getImportPackages

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

setImportPackages

public void setImportPackages(@NotNull
                              java.util.List<java.lang.String> p)

getExportPackages

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

setExportPackages

public void setExportPackages(@NotNull
                              java.util.List<java.lang.String> p)

getPrivatePackages

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

setPrivatePackages

public void setPrivatePackages(@NotNull
                               java.util.List<java.lang.String> p)

projectEvaluated

public void projectEvaluated()

getAttributes

@Input
 @NotNull
public java.util.Map<java.lang.String,java.lang.Object> getAttributes()

setAttributes

public void setAttributes(@NotNull
                          java.util.Map<java.lang.String,java.lang.Object> value)

attribute

public org.gradle.api.java.archives.Manifest attribute(@NotNull
                                                       java.lang.String name,
                                                       @Nullable
                                                       java.lang.String value)

attribute

@Nullable
public java.lang.String attribute(@NotNull
                                            java.lang.String name)

hasAttribute

public boolean hasAttribute(@NotNull
                            java.lang.String name)

getDisplayName

@Internal
 @Nullable
public java.lang.String getDisplayName()

setDisplayName

public void setDisplayName(@Nullable
                           java.lang.String value)

getSymbolicName

@Internal
 @Nullable
public java.lang.String getSymbolicName()

setSymbolicName

public void setSymbolicName(@Nullable
                            java.lang.String value)

getActivator

@Internal
 @Nullable
public java.lang.String getActivator()

setActivator

public void setActivator(@Nullable
                         java.lang.String value)

getCategory

@Internal
 @Nullable
public java.lang.String getCategory()

setCategory

public void setCategory(@Nullable
                        java.lang.String value)

getVendor

@Internal
 @Nullable
public java.lang.String getVendor()

setVendor

public void setVendor(@Nullable
                      java.lang.String value)

getLicense

@Internal
 @Nullable
public java.lang.String getLicense()

setLicense

public void setLicense(@Nullable
                       java.lang.String value)

getCopyright

@Internal
 @Nullable
public java.lang.String getCopyright()

setCopyright

public void setCopyright(@Nullable
                         java.lang.String value)

getDocUrl

@Internal
 @Nullable
public java.lang.String getDocUrl()

setDocUrl

public void setDocUrl(@Nullable
                      java.lang.String value)

getDevelopers

@Internal
 @Nullable
public java.lang.String getDevelopers()

setDevelopers

public void setDevelopers(@Nullable
                          java.lang.String value)

getContributors

@Internal
 @Nullable
public java.lang.String getContributors()

setContributors

public void setContributors(@Nullable
                            java.lang.String value)

getFragmentHost

@Internal
 @Nullable
public java.lang.String getFragmentHost()

setFragmentHost

public void setFragmentHost(@Nullable
                            java.lang.String value)

getSlingModelPackages

@Internal
 @Nullable
public java.lang.String getSlingModelPackages()

setSlingModelPackages

public void setSlingModelPackages(@Nullable
                                  java.lang.String value)

exportPackage

public void exportPackage(@NotNull
                          java.lang.Iterable<java.lang.String> pkgs)

exportPackage

public void exportPackage(@NotNull
                          java.lang.String... pkgs)

privatePackage

public void privatePackage(@NotNull
                           java.lang.Iterable<java.lang.String> pkgs)

privatePackage

public void privatePackage(@NotNull
                           java.lang.String... pkgs)

excludePackage

public void excludePackage(@NotNull
                           java.lang.Iterable<java.lang.String> pkgs)

excludePackage

public void excludePackage(@NotNull
                           java.lang.String... pkgs)

importPackage

public void importPackage(@NotNull
                          java.lang.Iterable<java.lang.String> pkgs)

importPackage

public void importPackage(@NotNull
                          java.lang.String... pkgs)

wildcardPackage

@NotNull
public java.util.List<java.lang.String> wildcardPackage(@NotNull
                                                                 java.lang.Iterable<java.lang.String> pkgs)

wildcardPackage

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

copy

protected void copy()