com.cognifide.gradle.aem.bundle

Class BundleJar

com.cognifide.gradle.aem.bundle.BundleJar

public class BundleJar

The main purpose of this extension point is to provide a place for specifying custom OSGi bundle related properties, because it is not possible to add properties to existing tasks like 'jar' directly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BundleJar.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static BundleJar.Companion	Companion

Constructor Summary

Constructors

Constructor and Description
BundleJar(AemExtension aem, org.gradle.api.tasks.bundling.Jar jar) The main purpose of this extension point is to provide a place for specifying custom OSGi bundle related properties, because it is not possible to add properties to existing tasks like 'jar' directly.

Method Summary

Modifier and Type	Method and Description
org.gradle.api.java.archives.Manifest	attribute(java.lang.String name, java.lang.String value)
java.lang.String	attribute(java.lang.String name)
void	embedPackage(java.lang.String pkg, boolean export, kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.build.DependencyOptions,kotlin.Unit> dependencyOptions)
void	embedPackage(java.lang.String pkg, boolean export, java.lang.String dependencyNotation)
void	embedPackages(java.lang.String[] pkgs, boolean export, kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.build.DependencyOptions,kotlin.Unit> dependencyOptions)
void	embedPackages(java.lang.Iterable<java.lang.String> pkgs, boolean export, kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.build.DependencyOptions,kotlin.Unit> dependencyOptions)
void	embedPackages(java.lang.String[] pkgs, boolean export, java.lang.String dependencyNotation)
void	embedPackages(java.lang.Iterable<java.lang.String> pkgs, boolean export, java.lang.String dependencyNotation)
void	excludePackage(java.lang.String pkg)
void	excludePackages(java.lang.Iterable<java.lang.String> pkgs)
void	excludePackages(java.lang.String... pkgs)
void	exportPackage(java.lang.String pkg)
void	exportPackages(java.lang.Iterable<java.lang.String> pkgs)
void	exportPackages(java.lang.String... pkgs)
java.lang.String	getActivator()
java.util.Map<java.lang.String,java.lang.Object>	getAttributes()
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.
boolean	getBndEnabled() Allows to disable BND tool.
java.util.Map<java.lang.String,java.lang.Object>	getBndInstructions() Bundle instructions consumed by BND tool (still file has precedence).
java.lang.String	getBndPath() Bundle instructions file location consumed by BND tool.
java.lang.String	getCategory()
java.lang.String	getContributors()
java.lang.String	getCopyright()
java.lang.String	getDevelopers()
java.lang.String	getDisplayName()
java.lang.String	getDocUrl()
java.util.List<java.lang.String>	getExportPackages()
java.lang.String	getFragmentHost()
java.util.List<java.lang.String>	getImportPackages()
java.lang.String	getInstallPath() Content path for OSGi bundle jars being placed in CRX package.
java.lang.String	getInstallRunMode() Suffix added to install path effectively allowing to install bundles only on specific instances.
org.gradle.api.tasks.bundling.Jar	getJar()
java.lang.String	getJavaPackage() Determines package in which OSGi bundle being built contains its classes. Basing on that value, there will be:
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.
java.lang.String	getLicense()
java.lang.String	getName()
java.util.List<java.lang.String>	getPrivatePackages()
java.lang.String	getSlingModelPackages()
java.lang.String	getSymbolicName()
boolean	getVaultFilter() Determines if Vault workspace filter entry pointing directly to JAR file should be added automatically for built OSGi bundle.
java.lang.String	getVendor()
boolean	hasAttribute(java.lang.String name)
void	importPackage(java.lang.String pkg)
void	importPackages(java.lang.Iterable<java.lang.String> pkgs)
void	importPackages(java.lang.String... pkgs)
void	privatePackage(java.lang.String pkg)
void	privatePackages(java.lang.Iterable<java.lang.String> pkgs)
void	privatePackages(java.lang.String... pkgs)
void	setActivator(java.lang.String value)
void	setAttributes(java.util.Map<java.lang.String,java.lang.Object> value)
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.
void	setBndEnabled(boolean p) Allows to disable BND tool.
void	setBndInstructions(java.util.Map<java.lang.String,? extends java.lang.Object> p) Bundle instructions consumed by BND tool (still file has precedence).
void	setBndPath(java.lang.String p) Bundle instructions file location consumed by BND tool.
void	setCategory(java.lang.String value)
void	setContributors(java.lang.String value)
void	setCopyright(java.lang.String value)
void	setDevelopers(java.lang.String value)
void	setDisplayName(java.lang.String value)
void	setDocUrl(java.lang.String value)
void	setExportPackages(java.util.List<java.lang.String> p)
void	setFragmentHost(java.lang.String value)
void	setImportPackages(java.util.List<java.lang.String> p)
void	setInstallPath(java.lang.String p) Content path for OSGi bundle jars being placed in CRX package.
void	setInstallRunMode(java.lang.String p) Suffix added to install path effectively allowing to install bundles only on specific instances.
void	setJavaPackage(java.lang.String p) Determines package in which OSGi bundle being built contains its classes. Basing on that value, there will be:
void	setJavaPackageOptions(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.
void	setLicense(java.lang.String value)
void	setName(java.lang.String p)
void	setPrivatePackages(java.util.List<java.lang.String> p)
void	setSlingModelPackages(java.lang.String value)
void	setSymbolicName(java.lang.String value)
void	setVaultFilter(boolean p) Determines if Vault workspace filter entry pointing directly to JAR file should be added automatically for built OSGi bundle.
void	setVendor(java.lang.String value)
java.util.List<java.lang.String>	wildcardPackages(java.lang.Iterable<java.lang.String> pkgs)
java.util.List<java.lang.String>	wildcardPackages(java.lang.String... pkgs)

Field Detail

Companion

public static BundleJar.Companion Companion

Constructor Detail

BundleJar

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

The main purpose of this extension point is to provide a place for specifying custom OSGi bundle related properties, because it is not possible to add properties to existing tasks like 'jar' directly.

Method Detail

getName

public java.lang.String getName()

setName

public void setName(java.lang.String p)

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.

getBndEnabled

public boolean getBndEnabled()

Allows to disable BND tool.

setBndEnabled

public void setBndEnabled(boolean p)

Allows to disable BND tool.

getBndPath

@NotNull
public java.lang.String getBndPath()

Bundle instructions file location consumed by BND tool.

If file exists, instructions will be taken from it instead of directly specified in dedicated property.

setBndPath

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

Bundle instructions file location consumed by BND tool.

If file exists, instructions will be taken from it instead of directly specified in dedicated property.

getBndInstructions

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

Bundle instructions consumed by BND tool (still file has precedence).

By default, plugin is increasing an importance of some warning so that it will fail a build instead just logging it.

setBndInstructions

public void setBndInstructions(@NotNull
                               java.util.Map<java.lang.String,? extends java.lang.Object> p)

Bundle instructions consumed by BND tool (still file has precedence).

By default, plugin is increasing an importance of some warning so that it will fail a build instead just logging it.

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)

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.String pkg)

exportPackages

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

exportPackages

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

privatePackage

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

privatePackages

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

privatePackages

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

excludePackage

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

excludePackages

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

excludePackages

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

importPackage

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

importPackages

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

importPackages

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

embedPackage

public void embedPackage(@NotNull
                         java.lang.String pkg,
                         boolean export,
                         @NotNull
                         kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.build.DependencyOptions,kotlin.Unit> dependencyOptions)

embedPackages

public void embedPackages(@NotNull
                          java.lang.String[] pkgs,
                          boolean export,
                          @NotNull
                          kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.build.DependencyOptions,kotlin.Unit> dependencyOptions)

embedPackages

public void embedPackages(@NotNull
                          java.lang.Iterable<java.lang.String> pkgs,
                          boolean export,
                          @NotNull
                          kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.build.DependencyOptions,kotlin.Unit> dependencyOptions)

embedPackage

public void embedPackage(@NotNull
                         java.lang.String pkg,
                         boolean export,
                         @NotNull
                         java.lang.String dependencyNotation)

embedPackages

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

embedPackages

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

wildcardPackages

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

wildcardPackages

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

getJar

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