Required Parameters

Name	Type	Description
compilerProvider	String	Compiler Provider Type Default value is generic.

Optional Parameters

Name	Type	Description
projectHelper	MavenProjectHelper	project-helper instance, used to make addition of resources simpler
artifactResolver	ArtifactResolver	Used to look up Artifacts in the local or remote repository.
artifactFactory	ArtifactFactory	Used to look up Artifacts in the local or remote repository.
localRepository	ArtifactRepository	The local repository
pluginArtifacts	Artifact>	The plugin dependency artifacts
maven2AntManager	Maven2AntManager	The manager to link maven project with an Ant project.
nameProvider	ProjectNameProvider	No description.
envFactoryName	String	Specifies a fully qualified class name implementing the org.codehaus.mojo.natives.EnvFactory interface. The class creates a set environment variables to be used with the command line.
versionNameNoSnapshot	boolean	Flag to tell if the "-SNAPSHOT" in library name should be removed. True by default Default value is true.
skipTest	boolean	Set this to 'true' to bypass unit tests entirely. Its use is NOT RECOMMENDED, but quite convenient on occasion.
sharedOptions	String	A flag to use the shared options during compilation and link. If left null, the automatic behavior is based on the packaging type. It means all library modules (.a, .so, .dll) will return true. If set to true the plugin will always inlcude the shared options.
includePackagingTypes	String>	List of packaging types you want the plugin to work on. If a module (project POM) has a packaging that is not listed here, the plugin will do nothing (skip all phases). This is very useful for RPM pack, static analysis and other tools.
excludePackagingTypes	String>	List of packaging types you DON'T want the plugin to work on. If a module (project POM) has a packaging that is listed here, the plugin will do nothing (skip all phases). This is very useful for RPM pack, static analysis and other tools.
groupDefinitions	GroupDefinition>	Definition of group to name mapping.
linkerProvider	String	Default value is ${compilerProvider}
linkerExecutable	String	default to compilerType if not provided
linkerSharedOptions	String>	Compiler options to produce shared libraries. Activated when shared flag is on.
linkerStartOptions	String>	List of options that will placed at the beginning of the link command. It should be declared the following way: -option1 ...
linkerMiddleOptions	String>	List of options that will placed just before the list of libraries of the link command. It should be declared the following way: -option1 ...
linkerEndOptions	String>	List of options that will placed after the list of libraries of the link command. It should be declared the following way: -option1 ...
linkingOrderLibs	String>	Option to reorder dependency list, each item has the format of ${groupId}:${artifactId}
linkerSecondaryOutputExtensions	String	Comma separated extension type to be installed/deployed. Use this option to deploy library file produced by dll build on windows
linkSystemProperties	String>	Additional environments values used before execution of the link Command.
useLinksForLibs	boolean	Flag set to true to use symbolic links in target/lib that will link to libraries in the maven local repository
testLinkerExecutable	String	Use this field to override provider specific linker executable for test
testLinkerOptions	String>	Special lists of options for linker test
testFailureIgnore	boolean	Set this to true to ignore a failure during testing. Its use is NOT RECOMMENDED, but quite convenient on occasion.
reportsDirectory	String	Base directory where all reports are written to.
testExecuteSystemProperties	String>	Additional environments values set before execution of the test executable
printSummary	boolean	Option to print summary of test suites or just print the test cases that has errors. Default value is true.
reportFormat	String	Selects the formatting for the test report to be generated. Can be set as brief, plain, or xml. Default value is brief.
useFile	boolean	Option to generate a file test report or just output the test report to the console. Default value is true.
forkMode	String	Option to specify the forking mode. Can be none, once or pertest. Default value is none.
argLine	String	Arbitrary options to set on the command line.
workingDirectory	File	Command line working directory.
childDelegation	boolean	When false it makes tests run using the standard classloader delegation instead of the default Maven isolated classloader. Only used when forking (forkMode is not "none"). Setting it to false helps with some problems caused by conflicts between xml parsers in the classpath and the Java 5 provider parser. Default value is true.

Parameter Details

projectHelper project-helper instance, used to make addition of resources simpler

• Type: org.apache.maven.project.MavenProjectHelper
• Required: No

---

artifactResolver Used to look up Artifacts in the local or remote repository.

• Type: org.apache.maven.artifact.resolver.ArtifactResolver
• Required: No

---

artifactFactory Used to look up Artifacts in the local or remote repository.

• Type: org.apache.maven.artifact.factory.ArtifactFactory
• Required: No

---

localRepository The local repository

• Type: org.apache.maven.artifact.repository.ArtifactRepository
• Required: No
• Expression: ${localRepository}

---

pluginArtifacts The plugin dependency artifacts

• Type: java.util.List<org.apache.maven.artifact.Artifact>
• Required: No
• Expression: ${plugin.artifacts}

---

maven2AntManager The manager to link maven project with an Ant project.

• Type: org.jfrog.jade.plugins.common.ant.Maven2AntManager
• Required: No

---

nameProvider No Description.

• Type: org.jfrog.jade.plugins.common.naming.ProjectNameProvider
• Required: No

---

envFactoryName Specifies a fully qualified class name implementing the org.codehaus.mojo.natives.EnvFactory interface. The class creates a set environment variables to be used with the command line.

• Type: java.lang.String
• Required: No

---

versionNameNoSnapshot Flag to tell if the "-SNAPSHOT" in library name should be removed. True by default

• Type: boolean
• Required: No
• Default: true

---

compilerProvider Compiler Provider Type

• Type: java.lang.String
• Required: Yes
• Default: generic

---

skipTest Set this to 'true' to bypass unit tests entirely. Its use is NOT RECOMMENDED, but quite convenient on occasion.

• Type: boolean
• Required: No
• Expression: ${maven.test.skip}

---

sharedOptions A flag to use the shared options during compilation and link. If left null, the automatic behavior is based on the packaging type. It means all library modules (.a, .so, .dll) will return true. If set to true the plugin will always inlcude the shared options.

• Type: java.lang.String
• Required: No

---

includePackagingTypes List of packaging types you want the plugin to work on. If a module (project POM) has a packaging that is not listed here, the plugin will do nothing (skip all phases). This is very useful for RPM pack, static analysis and other tools.

• Type: java.util.List<java.lang.String>
• Required: No

---

excludePackagingTypes List of packaging types you DON'T want the plugin to work on. If a module (project POM) has a packaging that is listed here, the plugin will do nothing (skip all phases). This is very useful for RPM pack, static analysis and other tools.

• Type: java.util.List<java.lang.String>
• Required: No

---

groupDefinitions Definition of group to name mapping.

• Type: java.util.Set<org.jfrog.jade.plugins.common.naming.GroupDefinition>
• Required: No

---

linkerProvider Default value is ${compilerProvider}

• Type: java.lang.String
• Required: No

---

linkerExecutable default to compilerType if not provided

• Type: java.lang.String
• Required: No

---

linkerSharedOptions Compiler options to produce shared libraries. Activated when shared flag is on.

• Type: java.util.List<java.lang.String>
• Required: No

---

linkerStartOptions List of options that will placed at the beginning of the link command. It should be declared the following way: -option1 ...

• Type: java.util.List<java.lang.String>
• Required: No

---

linkerMiddleOptions List of options that will placed just before the list of libraries of the link command. It should be declared the following way: -option1 ...

• Type: java.util.List<java.lang.String>
• Required: No

---

linkerEndOptions List of options that will placed after the list of libraries of the link command. It should be declared the following way: -option1 ...

• Type: java.util.List<java.lang.String>
• Required: No

---

linkingOrderLibs Option to reorder dependency list, each item has the format of ${groupId}:${artifactId}

• Type: java.util.List<java.lang.String>
• Required: No

---

linkerSecondaryOutputExtensions Comma separated extension type to be installed/deployed. Use this option to deploy library file produced by dll build on windows

• Type: java.lang.String
• Required: No

---

linkSystemProperties Additional environments values used before execution of the link Command.

• Type: java.util.Map<java.lang.String,java.lang.String>
• Required: No

---

useLinksForLibs Flag set to true to use symbolic links in target/lib that will link to libraries in the maven local repository

• Type: boolean
• Required: No

---

testLinkerExecutable Use this field to override provider specific linker executable for test

• Type: java.lang.String
• Required: No

---

testLinkerOptions Special lists of options for linker test

• Type: java.util.List<java.lang.String>
• Required: No

---

testFailureIgnore Set this to true to ignore a failure during testing. Its use is NOT RECOMMENDED, but quite convenient on occasion.

• Type: boolean
• Required: No
• Expression: ${maven.test.failure.ignore}

---

reportsDirectory Base directory where all reports are written to.

• Type: java.lang.String
• Required: No
• Expression: ${project.build.directory}/cppunit-reports

---

testExecuteSystemProperties Additional environments values set before execution of the test executable

• Type: java.util.Map<java.lang.String,java.lang.String>
• Required: No

---

printSummary Option to print summary of test suites or just print the test cases that has errors.

• Type: boolean
• Required: No
• Expression: ${surefire.printSummary}
• Default: true

---

reportFormat Selects the formatting for the test report to be generated. Can be set as brief, plain, or xml.

• Type: java.lang.String
• Required: No
• Expression: ${surefire.reportFormat}
• Default: brief

---

useFile Option to generate a file test report or just output the test report to the console.

• Type: boolean
• Required: No
• Expression: ${surefire.useFile}
• Default: true

---

forkMode Option to specify the forking mode. Can be none, once or pertest.

• Type: java.lang.String
• Required: No
• Expression: ${forkMode}
• Default: none

---

argLine Arbitrary options to set on the command line.

• Type: java.lang.String
• Required: No
• Expression: ${argLine}

---

workingDirectory Command line working directory.

• Type: java.io.File
• Required: No

---

childDelegation When false it makes tests run using the standard classloader delegation instead of the default Maven isolated classloader. Only used when forking (forkMode is not "none").

Setting it to false helps with some problems caused by conflicts between xml parsers in the classpath and the Java 5 provider parser.

• Type: boolean
• Required: No
• Expression: ${childDelegation}
• Default: true