openl:package

Full name:

org.openl.rules:openl-maven-plugin:5.25.0:package

Description:

Packages an OpenL Tablets project in a ZIP archive.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • Since version: 5.19.1.
  • Binds by default to the lifecycle phase: package.

Required Parameters

Name Type Since Description
<dependenciesThreshold> int 5.19.1 Allowed quantity of dependencies which can be included into the ZIP archive. Usually OpenL Tablets rules require a few dependencies, such as domain models, that is, Java beans, or some utils, for example, JSON parsing. Typically, the quantity of required dependencies does not exceed 3. If transitive dependencies are declared incorrectly, the size of the ZIP package increases dramatically. This parameter allows preventing such situation by failing packaging.
Default value is: 3.
<outputDirectory> File 5.19.1 Directory containing the generated artifact.
Default value is: ${project.build.directory}.
<workspaceFolder> File 5.19.1 Directory containing the generated artifact.
Default value is: ${project.build.directory}/openl-workspace.

Optional Parameters

Name Type Since Description
<addDefaultManifest> boolean 5.23.4 Parameter that adds default manifest entries into MANIFEST.MF file.
Default value is: true.
<classifier> String 5.19.1 Classifier that identifies the generated artifact as a supplemental one. By default, if a classifier is not provided, the system creates the artifact as the main one. Maven does not support using multiple main artifacts. Upon the second attempt to create the main artifact without using a classifier, the build fails.
<classpathFolder> String 5.19.1 Folder to store dependencies inside the OpenL Tablets project.
Default value is: lib/.
<deploymentName> String 5.19.1 Deployment archive name.
Default value is: ${project.build.finalName}.
<deploymentPackage> boolean 5.19.1 Parameter that enables deployed zip generation. This zip includes an exploded main OpenL Tablets project and all dependent OpenL Tablets projects located in separated folders inside the archive.
Default value is: false.
<excludes> String[] 5.23.6 Sets the list of exclude patterns to use. All '/' and '\' characters are replaced by File.separatorChar, so the separator used need not match File.separatorChar. When a pattern ends with a '/' or '\', "**" is appended. If it is not defined, then no files will be excluded. Note: 'pom.xml' file and 'target' directory are excluded always independently on this parameter.
<format> String 5.19.1 Comma separated list of packaging formats. Supported values: zip, jar.
Default value is: zip.
<includes> String[] 5.23.6 Sets the list of include patterns to use. All '/' and '\' characters are replaced by File.separatorChar, so the separator used need not match File.separatorChar. When a pattern ends with a '/' or '\', "**" is appended. If it is not defined, then all files will be included.
<manifestEntries> Map 5.23.4 Set of key/values to be included to MANIFEST.MF. This parameter overrides default values added by addDefaultManifest parameter.
<sourceDirectory> File 5.19.0 Folder that contains all OpenL Tablets-related resources such as rules and project descriptor, for example, ${project.basedir}/src/main/openl.
Default value is: ${project.build.sourceDirectory}/../openl.

Parameter Details

<addDefaultManifest>

Parameter that adds default manifest entries into MANIFEST.MF file.
  • Type: boolean
  • Since: 5.23.4
  • Required: No
  • Default: true

<classifier>

Classifier that identifies the generated artifact as a supplemental one. By default, if a classifier is not provided, the system creates the artifact as the main one. Maven does not support using multiple main artifacts. Upon the second attempt to create the main artifact without using a classifier, the build fails.
  • Type: java.lang.String
  • Since: 5.19.1
  • Required: No

<classpathFolder>

Folder to store dependencies inside the OpenL Tablets project.
  • Type: java.lang.String
  • Since: 5.19.1
  • Required: No
  • Default: lib/

<dependenciesThreshold>

Allowed quantity of dependencies which can be included into the ZIP archive. Usually OpenL Tablets rules require a few dependencies, such as domain models, that is, Java beans, or some utils, for example, JSON parsing. Typically, the quantity of required dependencies does not exceed 3. If transitive dependencies are declared incorrectly, the size of the ZIP package increases dramatically. This parameter allows preventing such situation by failing packaging.
  • Type: int
  • Since: 5.19.1
  • Required: Yes
  • Default: 3

<deploymentName>

Deployment archive name.
  • Type: java.lang.String
  • Since: 5.19.1
  • Required: No
  • Default: ${project.build.finalName}

<deploymentPackage>

Parameter that enables deployed zip generation. This zip includes an exploded main OpenL Tablets project and all dependent OpenL Tablets projects located in separated folders inside the archive.
  • Type: boolean
  • Since: 5.19.1
  • Required: No
  • Default: false

<excludes>

Sets the list of exclude patterns to use. All '/' and '\' characters are replaced by File.separatorChar, so the separator used need not match File.separatorChar. When a pattern ends with a '/' or '\', "**" is appended. If it is not defined, then no files will be excluded. Note: 'pom.xml' file and 'target' directory are excluded always independently on this parameter.
  • Type: java.lang.String[]
  • Since: 5.23.6
  • Required: No

<format>

Comma separated list of packaging formats. Supported values: zip, jar.
  • Type: java.lang.String
  • Since: 5.19.1
  • Required: No
  • Default: zip

<includes>

Sets the list of include patterns to use. All '/' and '\' characters are replaced by File.separatorChar, so the separator used need not match File.separatorChar. When a pattern ends with a '/' or '\', "**" is appended. If it is not defined, then all files will be included.
  • Type: java.lang.String[]
  • Since: 5.23.6
  • Required: No

<manifestEntries>

Set of key/values to be included to MANIFEST.MF. This parameter overrides default values added by addDefaultManifest parameter.
  • Type: java.util.Map
  • Since: 5.23.4
  • Required: No

<outputDirectory>

Directory containing the generated artifact.
  • Type: java.io.File
  • Since: 5.19.1
  • Required: Yes
  • Default: ${project.build.directory}

<sourceDirectory>

Folder that contains all OpenL Tablets-related resources such as rules and project descriptor, for example, ${project.basedir}/src/main/openl.
  • Type: java.io.File
  • Since: 5.19.0
  • Required: No
  • Default: ${project.build.sourceDirectory}/../openl

<workspaceFolder>

Directory containing the generated artifact.
  • Type: java.io.File
  • Since: 5.19.1
  • Required: Yes
  • Default: ${project.build.directory}/openl-workspace