com.cognifide.gradle.aem.bundle.tasks

Class BundleJar

com.cognifide.gradle.aem.bundle.tasks.BundleJar

public class BundleJar

Constructor Detail

BundleJar

public BundleJar(@NotNull
                 org.gradle.api.tasks.bundling.Jar jar)

Method Detail

getBndConvention

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

bndTool

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

Allows to configure BND tool specific options.

bnd

public void bnd(@NotNull
                java.lang.CharSequence... lines)

Add instructions to the BND property from a list of multi-line strings.

getInstallPath

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

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

getInstallRunMode

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

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

getVaultFilter

public org.gradle.api.provider.Property<java.lang.Boolean> getVaultFilter()

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

getAttributesConvention

public org.gradle.api.provider.Property<java.lang.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.

getJavaPackage

public org.gradle.api.provider.Property<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.

getJavaPackageOptions

public org.gradle.api.provider.Property<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.

getImportPackages

public org.gradle.api.provider.ListProperty<java.lang.String> getImportPackages()

getImportPackageSuffix

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

getExportPackages

public org.gradle.api.provider.ListProperty<java.lang.String> getExportPackages()

getPrivatePackages

public org.gradle.api.provider.ListProperty<java.lang.String> getPrivatePackages()

applyDefaults

public void applyDefaults()

applyEvaluated

public void applyEvaluated()

runBndTool

public void runBndTool()

Customize JAR being built to be valid OSGi bundle.

getActivatorClasses

public org.gradle.api.provider.ListProperty<java.lang.String> getActivatorClasses()

getActivatorSourceSets

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

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)

importPackage

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

importPackage

public void importPackage(@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)

optionalPackage

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

optionalPackage

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

embedPackage

public void embedPackage(@NotNull
                         java.lang.Object dependencyNotation,
                         @NotNull
                         java.lang.String[] pkgs,
                         boolean export)

embedPackage

public void embedPackage(@NotNull
                         java.lang.Object dependencyNotation,
                         @NotNull
                         java.lang.Iterable<java.lang.String> pkgs,
                         boolean export)

Copy packages from external dependency (JAR) to currently built OSGi bundle.

This utility method does not work when Gradle feature "configuration on demand" is enabled as of dependencies should be configured before task is configured nor executed.

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)