lugins.wildfly-jar-maven-plugin.10.0.0.Final.source-code.start-mojo.adoc Maven / Gradle / Ivy
### start
#### wildfly-jar:start
*Full name:*
org.wildfly.plugins:wildfly-jar-maven-plugin:10.0.0.Final:start
#### Description
Start the bootable JAR. The plugin execution keeps the process
running.
#### Attributes
* Requires a Maven project to be executed.
* Requires dependency resolution of artifacts in scope: `runtime`.
.Optional Parameters
[%autowidth.stretch]
|====
|Name|Type|Since|Description
|`<>`|`List`|`-`|Bootable JAR server arguments. +
*User property is*: `wildfly.bootable.arguments`. +
|`<>`|`URL`|`-`|A URL which points to the authentication configuration
(`wildfly-config.xml`) the client uses to authenticate
with the server. +
*User property is*: `wildfly.authConfig`. +
*Alias is*: `authentication-config`.
|`<>`|`boolean`|`-`|Set to `false` if you don't want the plugin to check for
server status before to return. In case the started server has no
management interface enabled this parameter should be set to true. +
*Default value is*: `true`. +
*User property is*: `wildfly.bootable.start.check.start`. +
*Alias is*: `check-server-start`.
|`<>`|`String`|`-`|Specifies the host name of the server where the deployment plan
should be executed. +
*Default value is*: `localhost`. +
*User property is*: `wildfly.hostname`. +
|`<>`|`String`|`-`|The Bootable JAR Process id. +
*Default value is*: `60`. +
*User property is*: `wildfly.bootable.start.id`. +
*Alias is*: `id`.
|`<>`|`String`|`-`|In case a custom JAR file name was specified during build, set this
option to this JAR file name. That is required for the plugin to
retrieve the JAR file to start. +
*User property is*: `wildfly.bootable.start.jar.file.name`. +
*Alias is*: `jar-file-name`.
|`<>`|`List`|`-`|Additional JVM options. +
*User property is*: `wildfly.bootable.jvmArguments`. +
|`<>`|`String`|`-`|Specifies the password to use if prompted to authenticate by the
server. If no password is specified and the server requests
authentication the user will be prompted to supply the password, +
*User property is*: `wildfly.password`. +
|`<>`|`int`|`-`|Specifies the port number the server is listening on. +
*Default value is*: `9990`. +
*User property is*: `wildfly.port`. +
|`<>`|`String`|`-`|The protocol used to connect to the server for management. +
*User property is*: `wildfly.protocol`. +
|`<>`|`boolean`|`-`|Set to `true` if you want the start goal to be skipped,
otherwise `false`. +
*Default value is*: `false`. +
*User property is*: `wildfly.bootable.start.skip`. +
|`<>`|`long`|`-`|The timeout value to use when checking for the server to be
running. +
*Default value is*: `60`. +
*User property is*: `wildfly.bootable.start.timeout`. +
*Alias is*: `startup-timeout`.
|`<>`|`String`|`-`|Indicates how `stdout` and `stderr` should be
handled for the server process. A value of `inherit`
means that the standard output streams are inherited from the
current process. Any other value is assumed to be a path. In this
case both `stdout` and `stderr` will be
redirected to a file. +
*Default value is*: `${project.build.directory}/wildfly-jar-start-stdout.log`. +
*User property is*: `wildfly.bootable.stdout`. +
|`<>`|`int`|`-`|The timeout, in seconds, to wait for a management connection. +
*Default value is*: `60`. +
*User property is*: `wildfly.timeout`. +
|`<>`|`String`|`-`|Specifies the username to use if prompted to authenticate by the
server. If no username is specified and the server requests
authentication the user will be prompted to supply the username, +
*User property is*: `wildfly.username`. +
|====
#### Parameter Details
[[arguments]] *arguments* +
Bootable JAR server arguments.
* *Type*: `java.util.List`
* *Required*: `No`
* *User Property*: `wildfly.bootable.arguments`
[[authenticationConfig]] *authenticationConfig* +
A URL which points to the authentication configuration
(`wildfly-config.xml`) the client uses to authenticate
with the server.
* *Type*: `java.net.URL`
* *Required*: `No`
* *User Property*: `wildfly.authConfig`
* *Alias*: `authentication-config`
[[checkStarted]] *checkStarted* +
Set to `false` if you don't want the plugin to check for
server status before to return. In case the started server has no
management interface enabled this parameter should be set to true.
* *Type*: `boolean`
* *Required*: `No`
* *User Property*: `wildfly.bootable.start.check.start`
* *Default*: `true`
* *Alias*: `check-server-start`
[[hostname]] *hostname* +
Specifies the host name of the server where the deployment plan
should be executed.
* *Type*: `java.lang.String`
* *Required*: `No`
* *User Property*: `wildfly.hostname`
* *Default*: `localhost`
[[id]] *id* +
The Bootable JAR Process id.
* *Type*: `java.lang.String`
* *Required*: `No`
* *User Property*: `wildfly.bootable.start.id`
* *Default*: `60`
* *Alias*: `id`
[[jarFileName]] *jarFileName* +
In case a custom JAR file name was specified during build, set this
option to this JAR file name. That is required for the plugin to
retrieve the JAR file to start.
* *Type*: `java.lang.String`
* *Required*: `No`
* *User Property*: `wildfly.bootable.start.jar.file.name`
* *Alias*: `jar-file-name`
[[jvmArguments]] *jvmArguments* +
Additional JVM options.
* *Type*: `java.util.List`
* *Required*: `No`
* *User Property*: `wildfly.bootable.jvmArguments`
[[password]] *password* +
Specifies the password to use if prompted to authenticate by the
server. If no password is specified and the server requests
authentication the user will be prompted to supply the password,
* *Type*: `java.lang.String`
* *Required*: `No`
* *User Property*: `wildfly.password`
[[port]] *port* +
Specifies the port number the server is listening on.
* *Type*: `int`
* *Required*: `No`
* *User Property*: `wildfly.port`
* *Default*: `9990`
[[protocol]] *protocol* +
The protocol used to connect to the server for management.
* *Type*: `java.lang.String`
* *Required*: `No`
* *User Property*: `wildfly.protocol`
[[skip]] *skip* +
Set to `true` if you want the start goal to be skipped,
otherwise `false`.
* *Type*: `boolean`
* *Required*: `No`
* *User Property*: `wildfly.bootable.start.skip`
* *Default*: `false`
[[startupTimeout]] *startupTimeout* +
The timeout value to use when checking for the server to be
running.
* *Type*: `long`
* *Required*: `No`
* *User Property*: `wildfly.bootable.start.timeout`
* *Default*: `60`
* *Alias*: `startup-timeout`
[[stdout]] *stdout* +
Indicates how `stdout` and `stderr` should be
handled for the server process. A value of `inherit`
means that the standard output streams are inherited from the
current process. Any other value is assumed to be a path. In this
case both `stdout` and `stderr` will be
redirected to a file.
* *Type*: `java.lang.String`
* *Required*: `No`
* *User Property*: `wildfly.bootable.stdout`
* *Default*: `${project.build.directory}/wildfly-jar-start-stdout.log`
[[timeout]] *timeout* +
The timeout, in seconds, to wait for a management connection.
* *Type*: `int`
* *Required*: `No`
* *User Property*: `wildfly.timeout`
* *Default*: `60`
[[username]] *username* +
Specifies the username to use if prompted to authenticate by the
server. If no username is specified and the server requests
authentication the user will be prompted to supply the username,
* *Type*: `java.lang.String`
* *Required*: `No`
* *User Property*: `wildfly.username`