lugins.wildfly-jar-maven-plugin.9.0.0.Beta1.source-code.shutdown-mojo.adoc Maven / Gradle / Ivy
### shutdown
#### wildfly-jar:shutdown
*Full name:*
org.wildfly.plugins:wildfly-jar-maven-plugin:9.0.0.Beta1:shutdown
#### Description
Shutdown the bootable JAR. In order to be able to shutdown a
running server, the 'management' Galleon layer must have been
included. If that is not the case, the server would have to be
killed.
#### Attributes
* Requires a Maven project to be executed.
.Optional Parameters
[%autowidth.stretch]
|====
|Name|Type|Since|Description
|`<>`|`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`.
|`<>`|`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`|`-`|Specifies the id of the server if the username and password is to
be retrieved from the settings.xml file +
*User property is*: `wildfly.id`. +
|`<>`|`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 shutdown goal to be
skipped, otherwise * `false`. +
*Default value is*: `false`. +
*User property is*: `wildfly.bootable.shutdown.skip`. +
|`<>`|`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
[[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`
[[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* +
Specifies the id of the server if the username and password is to
be retrieved from the settings.xml file
* *Type*: `java.lang.String`
* *Required*: `No`
* *User Property*: `wildfly.id`
[[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 shutdown goal to be
skipped, otherwise * `false`.
* *Type*: `boolean`
* *Required*: `No`
* *User Property*: `wildfly.bootable.shutdown.skip`
* *Default*: `false`
[[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`