openl:package

Full name:

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

Description:

Package an OpenL project in 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 An allowed quantity of dependencies which can be included into the ZIP archive. Usually OpenL rules require a few dependencies like: domain models (Java beans) or some utils (e.g. JSON parsing). So the quantity of required dependencies does not exceed 3 usually. In case incorrect declaring of transitive dependencies, the size of the ZIP package increases dramatically. This parameter allows to prevent 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
<classifier> String 5.19.1 Classifier to add to the artifact generated. If given, the artifact will be attached as a supplemental artifact. If not given this will create the main artifact which is the default behavior. If you try to do that a second time without using a classifier the build will fail.
<classpathFolder> String 5.19.1 A folder to store dependencies inside the OpenL project.
Default value is: lib/.
<deploymentName> String 5.19.1 The name of deployment archive
Default value is: ${project.build.finalName}.
<deploymentPackage> boolean 5.19.1 Enables generation of deployed zip. This zip includes exploded main OpenL project and all depended OpenL projects which are located in separated folders inside archive.
Default value is: false.
<format> String 5.19.1 Comma separated list of packaging formats.
Default value is: zip.
<sourceDirectory> File 5.19.0 Folder that contains all OpenL-related resources (OpenL rules, project descriptor etc.). For example: "${project.basedir}/src/main/openl".
Default value is: ${project.build.sourceDirectory}/../openl.

Parameter Details

<classifier>

Classifier to add to the artifact generated. If given, the artifact will be attached as a supplemental artifact. If not given this will create the main artifact which is the default behavior. If you try to do that a second time without using a classifier the build will fail.
  • Type: java.lang.String
  • Since: 5.19.1
  • Required: No

<classpathFolder>

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

<dependenciesThreshold>

An allowed quantity of dependencies which can be included into the ZIP archive. Usually OpenL rules require a few dependencies like: domain models (Java beans) or some utils (e.g. JSON parsing). So the quantity of required dependencies does not exceed 3 usually. In case incorrect declaring of transitive dependencies, the size of the ZIP package increases dramatically. This parameter allows to prevent such situation by failing packaging.
  • Type: int
  • Since: 5.19.1
  • Required: Yes
  • Default: 3

<deploymentName>

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

<deploymentPackage>

Enables generation of deployed zip. This zip includes exploded main OpenL project and all depended OpenL projects which are located in separated folders inside archive.
  • Type: boolean
  • Since: 5.19.1
  • Required: No
  • Default: false

<format>

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

<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-related resources (OpenL rules, project descriptor etc.). 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