Field Detail

• public static final groovy.lang.Closure ADLER32

  Hash calculator using the Adler32 checksum algorithm.

• public static final int DAY

• public static final groovy.lang.Closure MAJOR

  Version strategy that requires a minimum version and extends to (not including) the next major version.

• public static final int MILLISECOND

• public static final groovy.lang.Closure MINIMUM

  Version strategy that uses the given version as minimum version.

• public static final groovy.lang.Closure MINOR

  Version strategy that requires a minimum version and extends to (not including) the next minor version.

• public static final int MINUTE

• public static final int MONTH

• public static final groovy.lang.Closure NONE

  Version strategy that uses no version constraint for imports.

• public static final int SECOND

• public static final int YEAR

Property Detail

• boolean addBndPlatformManifestHeaders

  States if bnd-platform specific manifest headers should be added. Currently those headers serve the following purposes:

  • Reconstruct the original maven artifact group, name and version

• final java.util.Map<java.lang.String, BundleArtifact> artifacts

  Maps artifact IDs to BundleArtifacts

• boolean auxVersionedSymbolicNames

  States if the symbolic names for bundles created via the platformaux configuration should be adapted to include the version number. This is useful when dealing with systems that have problems when there actually are bundles with the same name but different versions. An example is Eclipse RCP plugin-based products - they can include only one version of a bundle with the same name.

• java.lang.String categoryId

  The ID of the feature's category in the update site.

• java.lang.String categoryName

  The name of the feature's category in the update site.

• final Configurations configurations

  Stores bnd configurations.

• java.lang.String defaultQualifier

  The default version qualifier to use for wrapped bundles. If a qualifier is already present the default will be appended, separated by a dash. Please note that this does not apply to file based dependencies automatically (otherwise it might mess with existing source bundle associations). Set addQualifier to true in the corresponding bnd configuration to enable it for a file based dependency.

• java.lang.Object defaultQualifierMap

  Default qualifier map configuration.

• boolean determineImportVersions

  States if the package import versions for automatically wrapped bundles should be determined automatically. This also will by default make package imports optional that are not found in dependencies.

• java.io.File downloadsDir

  The directory to store the downloaded Eclipse installation on local, this works if eclipseHome is not specified. Default to project.buildDir/eclipse-downloads.

• java.io.File eclipseHome

  The directory of a local Eclipse installation. If none is specified the ECLIPSE_HOME system property is checked, if it is not given as well it is tried to download Eclipse based on the URLs defined in eclipseMirror

• java.lang.Object eclipseMirror

  4.8 MB *.tar.gz file, which contains the minimal setup of eclipse plug-ins, which are necessary to build an eclipse p2 update site.

• boolean extractPomInformation

  States if additional configuration information from POM is desired.

• java.lang.String featureId

  The ID for the platform feature.

• java.lang.String featureName

  The name for the platform feature.

• java.lang.String featureProvider

  Feature provider name.

• java.lang.String featureVersion

  The platform feature version, defaults to the project version if possible, otherwise to 1.0.0.

• final java.util.Map<java.lang.String, Feature> features

  Maps feature IDs to Features

• boolean fetchSources

  States if source for external dependencies should be fetched and corresponding source bundles created.

• boolean generatePlatformFeature

  States if a general feature should be created. By default it's turned on and called Generated platform feature. In case custom features are generated you might not want to have an additional "generated platform feature" besides your own features.

• groovy.lang.Closure hashCalculator

  Prefix for qualifiers generated by the default qualifier map.

• java.lang.Object hashQualifierMap

  Map that is used to have reproducable increasing version numbers for bundles and features when using hash qualifiers. The hash qualifiers are mapped to a date and time based qualifier to ensure that changes to bundles and features that have the same version number are not only reflected in the qualifier but also produce versions that are interpreted as newer than the previous versions in the OSGi sense. The map needs to be persisted, thus it may be specified as

  • as String or File specifying the file location the map is persisted to / from (Json file)
  • a class implementing the VersionQualifierMap interface

• final java.util.Set<java.lang.String> importIgnorePackages

  Packages to ignore when analyzing packages of dependencies to determine package import version numbers.

• groovy.lang.Closure importVersionStrategy

  Defines the global import version strategy. The strategy is a closure taking an OSGi version number and returning a version assignment for bnd as String.

• final org.gradle.api.Project project

• boolean removeSignaturesFromWrappedBundles

  States if signatures should be removed from wrapped bundles.

• java.io.File updateSiteDir

  The directory to place the update site in. Will default to 'updatesite' in the build folder.

• java.io.File updateSiteZipFile

  The target file for the 'updateSiteZip' task.

• boolean useBndHashQualifiers

  States if bundle version qualifiers should be tagged with hashes calculated from the bnd configuration. Overrides the default qualifier for bundles where a bnd configuration is present. Please note that this does not apply to file based dependencies (otherwise it might mess with existing source bundle associations).

• boolean useFeatureHashQualifiers

  States if for features a qualifier should be added based on the included plugins and features. This serves to prevent caching issues when there are minor changes to a feature.

Constructor Detail

• PlatformPluginExtension(org.gradle.api.Project project)

Method Detail

• java.lang.Object bnd(java.lang.Object dependencyNotation, groovy.lang.Closure bndClosure)

  Call bnd to configure artifact, but don't add as dependency.

  Parameters:

  dependencyNotation - a dependency notation as supported by Gradle

  bndClosure - a closure that specifying the custom bnd configuration

  Returns:

• java.lang.Object bnd(groovy.lang.Closure bndClosure)

  Call bnd to extend/overwrite the default bnd configuration for all bundles. Note that the default configuration does not apply to Jars that already were bundles.

• java.lang.Object bundle(java.lang.Object dependencyNotation, groovy.lang.Closure configClosure = null)

  Call bundle to add a dependency.

  Parameters:

  dependencyNotation - a dependency notation as supported by Gradle

  configClosure - a closure that performs dependency configuration

  Returns:

• java.lang.Object feature(java.lang.Object featureNotation, groovy.lang.Closure featureClosure)

  Call feature to create a feature configuration.

  Parameters:

  featureNotation - feature notation is either a feature ID (String) or a map containing with at least the id key set to the desired feature ID. Optional additional keys are name (the human readable feature name), version (the feature version, default is the main feature version) and provider (the feature provider name)

  featureClosure - the closure configuring the feature content

• void imports(java.lang.Object dependencyNotation, groovy.lang.Closure importsClosure)

  Call to configure the behaviour for other bundles importing a given dependency.

  Parameters:

  dependencyNotation - the dependency notation

  importsClosure - the imports configuration closure

  Returns:

• java.lang.Object merge(java.util.Map<java.lang.String, java.lang.Object> properties = [failOnDuplicate: true, groovy.lang.Closure mergeClosure)

  Call merge to create bundle that is merged from different dependencies.

  Parameters:

  mergeClosure - the merge closure, specifying a match and bnd configuration

  Returns:

• java.lang.Object override(groovy.lang.Closure bndClosure)

  Call to override the behavior for all created bundles, even existing bundles. Use with care.