wildfly:run

Full name:

org.wildfly.plugins:wildfly-maven-plugin:4.2.1.Final:run

Description:

Starts a standalone instance of WildFly and deploys the application to the server. This goal will block until cancelled or a shutdown is invoked from a management client.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • Invokes the execution of the lifecycle phase package prior to executing itself.

Optional Parameters

Name Type Since Description
<addUser> AddUser - The users to add to the server.
User property is: wildfly.add-user.
Alias is: add-user.
<authenticationConfig> 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.
<commands> List - The CLI commands to execute before the deployment is deployed.
User property is: wildfly.commands.
<debug> boolean - Starts the server with debugging enabled.
Default value is: false.
User property is: wildfly.debug.
<debugHost> String - Sets the hostname to listen on for debugging. An * means all hosts.
Default value is: *.
User property is: wildfly.debug.host.
<debugPort> int - Sets the port the debugger should listen on.
Default value is: 8787.
User property is: wildfly.debug.port.
<debugSuspend> boolean - Indicates whether the server should suspend itself until a debugger is attached.
Default value is: false.
User property is: wildfly.debug.suspend.
<env> Map - Specifies the environment variables to be passed to the process being started. 
<env>
    <HOME>/home/wildfly/</HOME>
</env>

<featurePackLocation> String - The feature pack location. See the documentation for details on how to format a feature pack location.

Note that if you define the version in the feature pack location, e.g. #26.1.1.Final, the version configuration parameter should be left blank.


User property is: wildfly.feature-pack.location.
Alias is: feature-pack-location.
<filename> String - The file name of the application to be deployed.

The filename property does have a default of ${project.build.finalName}.${project.packaging}. The default value is not injected as it normally would be due to packaging types like ejb that result in a file with a .jar extension rather than an .ejb extension.


User property is: wildfly.deployment.filename.
<hostname> String - Specifies the host name of the server where the deployment plan should be executed.
Default value is: localhost.
User property is: wildfly.hostname.
<id> 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.
<javaHome> String - The JAVA_HOME to use for launching the server.
User property is: java.home.
Alias is: java-home.
<javaOpts> String[] - The JVM options to use.
User property is: wildfly.javaOpts.
Alias is: java-opts.
<jbossHome> String - The WildFly Application Server's home directory. If not used, WildFly will be downloaded.
User property is: jboss-as.home.
Alias is: jboss-home.
<moduleOptions> String[] - Options passed to JBoss Modules. This is useful for things like Java Agents where you need to start the server with an agent.
User property is: wildfly.moduleOptions.
Alias is: module-options.
<modulesPath> ModulesPath - The modules path or paths to use. A single path can be used or multiple paths by enclosing them in a paths element.
User property is: wildfly.modulesPath.
Alias is: modules-path.
<name> String - Specifies the name used for the deployment.
User property is: wildfly.deployment.name.
<password> 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.
<port> int - Specifies the port number the server is listening on.
Default value is: 9990.
User property is: wildfly.port.
<propertiesFile> String - The path to the system properties file to load.
User property is: wildfly.propertiesFile.
Alias is: properties-file.
<protocol> String - The protocol used to connect to the server for management.
User property is: wildfly.protocol.
<provisioningDir> String 3.0 The directory name inside the buildDir where to provision the default server. By default the server is provisioned into the 'server' directory.
Default value is: server.
User property is: wildfly.provisioning.dir.
Alias is: provisioning-dir.
<runtimeName> String - The runtime name for the deployment.

In some cases users may wish to have two deployments with the same runtime-name (e.g. two versions of example.war) both available in the management configuration, in which case the deployments would need to have distinct name values but would have the same runtime-name.


User property is: wildfly.deployment.runtime.name.
Alias is: runtime-name.
<scripts> List - The CLI script files to execute before the deployment is deployed.
User property is: wildfly.scripts.
<serverArgs> String[] - The arguments to be passed to the server.
User property is: wildfly.serverArgs.
Alias is: server-args.
<serverConfig> String - The path to the server configuration to use.
User property is: wildfly.serverConfig.
Alias is: server-config.
<skip> boolean - Set to true if you want to skip this goal, otherwise false.
Default value is: false.
User property is: wildfly.skip.
<startupTimeout> long - The timeout value to use when starting the server.
Default value is: 60.
User property is: wildfly.startupTimeout.
Alias is: startup-timeout.
<timeout> int - The timeout, in seconds, to wait for a management connection.
Default value is: 60.
User property is: wildfly.timeout.
<username> 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.
<version> String - The version of the WildFly default server to install in case no jboss-home has been set and no server has previously been provisioned.

The latest stable version is resolved if left blank.


User property is: wildfly.version.

Parameter Details

<addUser>

The users to add to the server.
  • Type: org.wildfly.plugin.server.AddUser
  • Required: No
  • User Property: wildfly.add-user
  • Alias: add-user

<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

<commands>

The CLI commands to execute before the deployment is deployed.
  • Type: java.util.List
  • Required: No
  • User Property: wildfly.commands

<debug>

Starts the server with debugging enabled.
  • Type: boolean
  • Required: No
  • User Property: wildfly.debug
  • Default: false

<debugHost>

Sets the hostname to listen on for debugging. An * means all hosts.
  • Type: java.lang.String
  • Required: No
  • User Property: wildfly.debug.host
  • Default: *

<debugPort>

Sets the port the debugger should listen on.
  • Type: int
  • Required: No
  • User Property: wildfly.debug.port
  • Default: 8787

<debugSuspend>

Indicates whether the server should suspend itself until a debugger is attached.
  • Type: boolean
  • Required: No
  • User Property: wildfly.debug.suspend
  • Default: false

<env>

Specifies the environment variables to be passed to the process being started. 
<env>
    <HOME>/home/wildfly/</HOME>
</env>
  • Type: java.util.Map
  • Required: No

<featurePackLocation>

The feature pack location. See the documentation for details on how to format a feature pack location.

Note that if you define the version in the feature pack location, e.g. #26.1.1.Final, the version configuration parameter should be left blank.

  • Type: java.lang.String
  • Required: No
  • User Property: wildfly.feature-pack.location
  • Alias: feature-pack-location

<filename>

The file name of the application to be deployed.

The filename property does have a default of ${project.build.finalName}.${project.packaging}. The default value is not injected as it normally would be due to packaging types like ejb that result in a file with a .jar extension rather than an .ejb extension.

  • Type: java.lang.String
  • Required: No
  • User Property: wildfly.deployment.filename

<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>

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

<javaHome>

The JAVA_HOME to use for launching the server.
  • Type: java.lang.String
  • Required: No
  • User Property: java.home
  • Alias: java-home

<javaOpts>

The JVM options to use.
  • Type: java.lang.String[]
  • Required: No
  • User Property: wildfly.javaOpts
  • Alias: java-opts

<jbossHome>

The WildFly Application Server's home directory. If not used, WildFly will be downloaded.
  • Type: java.lang.String
  • Required: No
  • User Property: jboss-as.home
  • Alias: jboss-home

<moduleOptions>

Options passed to JBoss Modules. This is useful for things like Java Agents where you need to start the server with an agent.
  • Type: java.lang.String[]
  • Required: No
  • User Property: wildfly.moduleOptions
  • Alias: module-options

<modulesPath>

The modules path or paths to use. A single path can be used or multiple paths by enclosing them in a paths element.
  • Type: org.wildfly.plugin.server.ModulesPath
  • Required: No
  • User Property: wildfly.modulesPath
  • Alias: modules-path

<name>

Specifies the name used for the deployment.
  • Type: java.lang.String
  • Required: No
  • User Property: wildfly.deployment.name

<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>

Specifies the port number the server is listening on.
  • Type: int
  • Required: No
  • User Property: wildfly.port
  • Default: 9990

<propertiesFile>

The path to the system properties file to load.
  • Type: java.lang.String
  • Required: No
  • User Property: wildfly.propertiesFile
  • Alias: properties-file

<protocol>

The protocol used to connect to the server for management.
  • Type: java.lang.String
  • Required: No
  • User Property: wildfly.protocol

<provisioningDir>

The directory name inside the buildDir where to provision the default server. By default the server is provisioned into the 'server' directory.
  • Type: java.lang.String
  • Since: 3.0
  • Required: No
  • User Property: wildfly.provisioning.dir
  • Default: server
  • Alias: provisioning-dir

<runtimeName>

The runtime name for the deployment.

In some cases users may wish to have two deployments with the same runtime-name (e.g. two versions of example.war) both available in the management configuration, in which case the deployments would need to have distinct name values but would have the same runtime-name.

  • Type: java.lang.String
  • Required: No
  • User Property: wildfly.deployment.runtime.name
  • Alias: runtime-name

<scripts>

The CLI script files to execute before the deployment is deployed.
  • Type: java.util.List
  • Required: No
  • User Property: wildfly.scripts

<serverArgs>

The arguments to be passed to the server.
  • Type: java.lang.String[]
  • Required: No
  • User Property: wildfly.serverArgs
  • Alias: server-args

<serverConfig>

The path to the server configuration to use.
  • Type: java.lang.String
  • Required: No
  • User Property: wildfly.serverConfig
  • Alias: server-config

<skip>

Set to true if you want to skip this goal, otherwise false.
  • Type: boolean
  • Required: No
  • User Property: wildfly.skip
  • Default: false

<startupTimeout>

The timeout value to use when starting the server.
  • Type: long
  • Required: No
  • User Property: wildfly.startupTimeout
  • Default: 60
  • Alias: startup-timeout

<timeout>

The timeout, in seconds, to wait for a management connection.
  • Type: int
  • Required: No
  • User Property: wildfly.timeout
  • Default: 60

<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

<version>

The version of the WildFly default server to install in case no jboss-home has been set and no server has previously been provisioned.

The latest stable version is resolved if left blank.

  • Type: java.lang.String
  • Required: No
  • User Property: wildfly.version