helper:share-server-secret

Full name:

org.nuiton:helper-maven-plugin:2.3.2:share-server-secret

Description:

Obtain a server authentication and share it in the maven project properties. To select data to export from the server with the given serverId, fill the properties : 
  usernameOut
  passwordOut
  privateKeyOut
  passphraseOut

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 1.1.0.
  • Binds by default to the lifecycle phase: initialize.

Required Parameters

Name Type Since Description
serverId String 1.1.0 Server id to use for authentication (must be defined in your setting and use the maven >= 2.1.0 password encryption mecanism).
User property is: helper.serverId.

Optional Parameters

Name Type Since Description
passphraseOut String 1.1.0 The name of the property where to export the passphrase of the server. Note: If not set - then no export of the passphrase of the server. Note: If the passphrase is crypted (since maven 2.1.0) then decrypt it.
passwordOut String 1.1.0 The name of the property where to export the password of the server. Note: If not set - then no export of the password of the server. Note: If the password is crypted (since maven 2.1.0) then decrypt it.
privateKeyOut String 1.1.0 The name of the property where to export the private key of the server. Note: If not set - then no export of the private key of the server.
runOnce boolean 1.1.0 A flag to execute only once the mojo. Note: By default, value is true since it is not necessary to inject twice secrets in session.
Default value is: true.
User property is: helper.runOnce.
runOnlyOnRoot boolean 2.1 A flag to restrict only to run on root module.
Default value is: false.
User property is: helper.runOnlyOnRoot.
skipNullValues boolean 1.6 A flag to skip null values.
Default value is: false.
User property is: helper.skipNullValues.
skipShareServerSecret boolean 2.1 A flag to skip the goal.
Default value is: false.
User property is: helper.skipShareServerSecret.
usernameOut String 1.1.0 The name of the property where to export the username of the server. Note: If not set - then no export of the username of the server.
verbose boolean 1.1.0 A flag to activate verbose mode.
Default value is: ${maven.verbose}.
User property is: helper.verbose.

Parameter Details

passphraseOut:

The name of the property where to export the passphrase of the server. Note: If not set - then no export of the passphrase of the server. Note: If the passphrase is crypted (since maven 2.1.0) then decrypt it.
  • Type: java.lang.String
  • Since: 1.1.0
  • Required: No

passwordOut:

The name of the property where to export the password of the server. Note: If not set - then no export of the password of the server. Note: If the password is crypted (since maven 2.1.0) then decrypt it.
  • Type: java.lang.String
  • Since: 1.1.0
  • Required: No

privateKeyOut:

The name of the property where to export the private key of the server. Note: If not set - then no export of the private key of the server.
  • Type: java.lang.String
  • Since: 1.1.0
  • Required: No

runOnce:

A flag to execute only once the mojo. Note: By default, value is true since it is not necessary to inject twice secrets in session.
  • Type: boolean
  • Since: 1.1.0
  • Required: No
  • User Property: helper.runOnce
  • Default: true

runOnlyOnRoot:

A flag to restrict only to run on root module.
  • Type: boolean
  • Since: 2.1
  • Required: No
  • User Property: helper.runOnlyOnRoot
  • Default: false

serverId:

Server id to use for authentication (must be defined in your setting and use the maven >= 2.1.0 password encryption mecanism).
  • Type: java.lang.String
  • Since: 1.1.0
  • Required: Yes
  • User Property: helper.serverId

skipNullValues:

A flag to skip null values.
  • Type: boolean
  • Since: 1.6
  • Required: No
  • User Property: helper.skipNullValues
  • Default: false

skipShareServerSecret:

A flag to skip the goal.
  • Type: boolean
  • Since: 2.1
  • Required: No
  • User Property: helper.skipShareServerSecret
  • Default: false

usernameOut:

The name of the property where to export the username of the server. Note: If not set - then no export of the username of the server.
  • Type: java.lang.String
  • Since: 1.1.0
  • Required: No

verbose:

A flag to activate verbose mode.
  • Type: boolean
  • Since: 1.1.0
  • Required: No
  • User Property: helper.verbose
  • Default: ${maven.verbose}