nar-maven-plugin - nar:nar-download

nar:nar-download

Full name:

com.github.maven-nar:nar-maven-plugin:3.4.1-SNAPSHOT:nar-download

Description:

List all the dependencies which are needed by the project (for compilation, tests, and execution) and downloads the NAR files in local maven repository if needed. This includes the noarch and aol type NAR files. Technical note : the requiresDependencyResolution = ResolutionScope.TEST in the Mojo Annotation is important to get all the dependencies including test dependencies.

Attributes:

Requires a Maven project to be executed.
Requires dependency resolution of artifacts in scope: test.
Binds by default to the lifecycle phase: initialize.

Required Parameters

Name	Type	Since	Description
layout	`String`	`-`	Layout to be used for building and unpacking artifacts Default value is: `com.github.maven_nar.NarLayout21`. User property is: `nar.layout`.

Optional Parameters

Name	Type	Since	Description
aol	`String`	`-`	Architecture-OS-Linker name. Defaults to: arch-os-linker.
architecture	`String`	`-`	The Architecture for the nar, Some choices are: "x86", "i386", "amd64", "ppc", "sparc", ... Defaults to a derived value from ${os.arch} User property is: `nar.arch`.
classifiers	`List`	`-`	List of classifiers which you want download/unpack/assemble Example ppc-MacOSX-g++, x86-Windows-msvc, i386-Linux-g++. Not setting means all.
excludeArtifactIds	`String`	`2.0`	Comma separated list of Artifact names to exclude. User property is: `excludeArtifactIds`.
excludeGroupIds	`String`	`2.0`	Comma separated list of GroupId Names to exclude. User property is: `excludeGroupIds`.
ignore	`boolean`	`-`	Ignore errors and failures. Default value is: `false`. User property is: `nar.ignore`.
includeArtifactIds	`String`	`2.0`	Comma separated list of Artifact names to include. User property is: `includeArtifactIds`.
includeGroupIds	`String`	`2.0`	Comma separated list of GroupIds to include. User property is: `includeGroupIds`.
javah	`Javah`	`-`	Javah info
libraries	`List`	`-`	List of libraries to create
libsName	`String`	`-`	Name of the libraries included
linker	`Linker`	`-`	Linker
msvc	`Msvc`	`-`	(no description)
os	`String`	`-`	The Operating System for the nar. Some choices are: "Windows", "Linux", "MacOSX", "SunOS", ... Defaults to a derived value from ${os.name} FIXME table missing User property is: `nar.os`.
output	`String`	`-`	Name of the output - for jni default-value="${project.artifactId}-${project.version}" - for libs default-value="${project.artifactId}-${project.version}" - for exe default-value="${project.artifactId}" -- for tests default-value="${test.name}"
skip	`boolean`	`-`	Skip running of NAR plugins (any) altogether. Default value is: `false`. User property is: `nar.skip`.
skipTests	`boolean`	`-`	Skip the tests. Listens to Maven's general 'maven.skip.test'. User property is: `maven.test.skip`.
targetDirectory	`File`	`-`	Target directory for Nar file construction. Defaults to "${project.build.directory}/nar" for "nar-compile" goal
testTargetDirectory	`File`	`-`	Target directory for Nar test construction. Defaults to "${project.build.directory}/test-nar" for "nar-testCompile" goal
testUnpackDirectory	`File`	`-`	Target directory for Nar test unpacking. Defaults to "${testTargetDirectory}"
tests	`List`	`-`	List of tests to create
unpackDirectory	`File`	`-`	Target directory for Nar file unpacking. Defaults to "${targetDirectory}"

Parameter Details

aol:

Architecture-OS-Linker name. Defaults to: arch-os-linker.

Type: java.lang.String
Required: No

architecture:

The Architecture for the nar, Some choices are: "x86", "i386", "amd64", "ppc", "sparc", ... Defaults to a derived value from ${os.arch}

Type: java.lang.String
Required: No
User Property: nar.arch

classifiers:

List of classifiers which you want download/unpack/assemble Example ppc-MacOSX-g++, x86-Windows-msvc, i386-Linux-g++. Not setting means all.

Type: java.util.List
Required: No

excludeArtifactIds:

Comma separated list of Artifact names to exclude.

Type: java.lang.String
Since: 2.0
Required: No
User Property: excludeArtifactIds

excludeGroupIds:

Comma separated list of GroupId Names to exclude.

Type: java.lang.String
Since: 2.0
Required: No
User Property: excludeGroupIds

ignore:

Ignore errors and failures.

Type: boolean
Required: No
User Property: nar.ignore
Default: false

includeArtifactIds:

Comma separated list of Artifact names to include.

Type: java.lang.String
Since: 2.0
Required: No
User Property: includeArtifactIds

includeGroupIds:

Comma separated list of GroupIds to include.

Type: java.lang.String
Since: 2.0
Required: No
User Property: includeGroupIds

javah:

Javah info

Type: com.github.maven_nar.Javah
Required: No

layout:

Layout to be used for building and unpacking artifacts

Type: java.lang.String
Required: Yes
User Property: nar.layout
Default: com.github.maven_nar.NarLayout21

libraries:

List of libraries to create

Type: java.util.List
Required: No

libsName:

Name of the libraries included

Type: java.lang.String
Required: No

linker:

Linker

Type: com.github.maven_nar.Linker
Required: No

msvc:

(no description)

Type: com.github.maven_nar.Msvc
Required: No

os:

The Operating System for the nar. Some choices are: "Windows", "Linux", "MacOSX", "SunOS", ... Defaults to a derived value from ${os.name} FIXME table missing

Type: java.lang.String
Required: No
User Property: nar.os

output:

Name of the output - for jni default-value="${project.artifactId}-${project.version}" - for libs default-value="${project.artifactId}-${project.version}" - for exe default-value="${project.artifactId}" -- for tests default-value="${test.name}"

Type: java.lang.String
Required: No

skip:

Skip running of NAR plugins (any) altogether.