Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The plugin configuration is flexible and can be customized for the cases when a simple configuration like the one suggested above is not sufficient to your needs.

Required Parameters

Name

Type

Description

-D Parameter

 orgToken

String

Unique identifier of the organization to update, also known as 'API Token'.

org.whitesource.orgToken

Since version 3.1.6

Optional Parameters

Name

Type

Description

-D Parameter

Code Block
timeFormat

String

Set logging datetime format.

Default value is [HH:mm:ss] 

org.whitesource.timeFormat

Since version 17.11.3

checkPolicies

Boolean

Set to true to check policies before update.
Default value is: false.e

org.whitesource.checkPolicies

Since version 3.1.6

forceCheckAllDependencies

Boolean

Optional. Set to true to force check all policies for all dependencies, used only if checkPolicies is set to true.
Default value is: false - policies will be checked only for new dependencies introduced to the WhiteSource projects.

org.whitesource.forceCheckAllDependencies

Since version 3.1.7

forceUpdate

Boolean

Optional. Updates organization inventory regardless of policy violations. 
Default value is: false - in case of policy violations, the plugin won't update the inventory.

org.whitesource.forceUpdate

Since version 3.2.8

product

String

Product name or token.
Default value is: top most project name or artifactId.

org.whitesource.product

Since version 3.2.8

productVersion

String

Product version. Use this to override the version in each module.

org.whitesource.productVersion

Since version 3.2.8

projectToken

String

Unique identifier of the White Source project to update. If omitted, default naming convention will apply.


moduleTokens

Map

Map of module artifactId to White Source project token. See example


includes

String[]

Only modules with an artifactId matching one of these patterns will be processed by the plugin.

Should be used like this:

Code Block
<includes>
   <include>module-a</include>
   <include>module-b</include>
</includes>


excludes

String[]

Modules with an artifactId matching any of these patterns will not be processed by the plugin.

Should be used like this:

Code Block
<excludes>
   <exclude>module-a</exclude>
   <exclude>module-b</exclude>
</excludes>


ignore

Boolean

Set to true to ignore this maven project. Overrides any include patterns.
Default value is: false.


ignorePomModules

Boolean

Set to true to ignore this maven modules of type pom.
Default value is: true.

org.whitesource.ignorePomModules

Since version 3.2.8

ignoredScopes

String[]

By default the maven plugin ignores direct dependencies with scope 'test' and 'provided'.
Override to enable certain scopes (see example below). 

org.whitesource.ignoredScopes

Since version 3.3.1

failOnError

Boolean

Indicates whether the build will continue even if there are errors.
Default value is: false.

org.whitesource.failOnError

Since version 3.2.8

skip

Boolean

Set to true to skip the maven execution.
Default value is: false.


reportAsJson

Boolean

Set to true to create the check policies report as a text file in JSON format instead of the regular HTML format report.
Default value is: false.


aggregateModules

Boolean

Set to true to combine all pom modules into a single WhiteSource project with an aggregated dependency flat list (no hierarchy).
Default value is: false.

org.whitesource.aggregateModules

Since version 3.2.8

preserveModuleInfo

Boolean

Optional. Works only if the 'aggregateModules' parameter is set to 'true'. It creates a hierarchy tree for modules that appear in the root POM.
Default value is: false.

org.whitesource.preserveModuleInfo

Since version 18.5.2

aggregateProjectName

String

Optional. The project name that will appear in WhiteSource. If omitted and no project token defined, defaults to pom artifactId.
Will only apply if aggregateModules is set to true. 

org.whitesource.aggregateProjectName

Since version 3.2.8

aggregateProjectToken

String

Optional. Unique identifier of the White Source project to update, overrides aggregateProjectName. If omitted, default naming convention will apply.
Will only apply if aggregateModules is set to true. 

org.whitesource.aggregateProjectToken

Since version 3.2.8

requesterEmail

String

Optional. The provided email will be matched with an existing WhiteSource account. Requests for new libraries will be created with the matched account as the requester.

org.whitesource.requesterEmail

Since version 3.2.8

autoDetectProxySettings

Boolean

Indicates whether to try to detect proxy configuration in the underlying machine (e.g. in OS proxy settings, in JVM system properties etc.)
Default value is: false.

org.whitesource.autoDetectProxySettings

Since version 3.2.8

connectionTimeoutMinutes

int

Connection timeout in minutes.
Default value is: 60

wss.connectionTimeoutMinutes

Since version 3.2.7

ignoreDependencyResolutionErrors

Boolean

Indicates whether to ignore an error while resolving dependencies for a module, this module will not be included in the scan and will not appear as a project within WhiteSource.
Default value is: false.

org.whitesource.ignoreDependencyResolutionErrors

Since version 3.3.0

failOnConnectionError

Boolean

Fails the build when unable to connect to WhiteSource service
Default value is: true.

org.whitesource.failOnConnectionError

Since version 3.3.1

connectionRetries

int

Connection retries when unable to connect to WhiteSource service.
Default value is: 1.

org.whitesource.connectionRetries

Since version 3.3.1

orgTokenFile

String

Optional. Path to file that contains the org token. Use this to override the orgToken parameter in the pom.xml file.

org.whitesource.orgTokenFile

Since version 18.2.2

userKey

String

Unique identifier of user, can be generate from the profile page in your whitesource account.

Required if WhiteSource administrator has enabled "Enforce user level access" option.

org.whitesource.userKey

Since version 18.4.2

userKeyFile

String

Optional. Path to file that contains the userKey . Use this to override the userKey parameter in the pom.xml file.

org.whitesource.userKeyFile

Since version 18.4.2

updateEmptyProject

Boolean

Optional. Whether or not to upload/update an empty project
Default value is: true

org.whitesource.updateEmptyProject

Since version 19.5.1

...