wildfly:run

Full name:

org.wildfly.plugins:wildfly-maven-plugin:1.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.
afterDeployment Commands - Deprecated. use the execute-commands goal
Alias is: after-deployment.
artifact String - A string of the form groupId:artifactId:version[:packaging][:classifier]. Any missing portion of the artifact will be replaced with the it's appropriate default property value
User property is: wildfly.artifact.
artifactId String - The artifactId of the artifact to download. Ignored if artifact artifactId portion is used.
Default value is: wildfly-dist.
User property is: wildfly.artifactId.
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.
beforeDeployment Commands - Deprecated. use the execute-commands goal
Alias is: before-deployment.
checkPackaging boolean - By default certain package types are ignored when processing, e.g. maven-project and pom. Set this value to false if this check should be bypassed.
Default value is: true.
User property is: wildfly.checkPackaging.
Alias is: check-packaging.
classifier String - The classifier of the artifact to download. Ignored if artifact classifier portion is used.
User property is: wildfly.classifier.
env Map - Specifies the environment variables to be passed to the process being started.
<env>
    <HOME>/home/wildfly/</HOME>
</env>

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.
groupId String - The groupId of the artifact to download. Ignored if artifact groupId portion is used.
Default value is: org.wildfly.
User property is: wildfly.groupId.
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.
jvmArgs String - Deprecated. use javaOpts
User property is: wildfly.jvmArgs.
Alias is: jvm-args.
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.
packaging String - The packaging of the artifact to download. Ignored if artifact packing portion is used.
Default value is: zip.
User property is: wildfly.packaging.
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.
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.
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 the deployment to be skipped, 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.
targetDir File - The target directory the application to be deployed is located.
Default value is: ${project.build.directory}/.
User property is: wildfly.deployment.targetDir.
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 artifact to download. Ignored if artifact version portion is used. The default 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

afterDeployment:

Deprecated. use the execute-commands goal
Executions to run after the deployment
  • Type: org.wildfly.plugin.cli.Commands
  • Required: No
  • Alias: after-deployment

artifact:

A string of the form groupId:artifactId:version[:packaging][:classifier]. Any missing portion of the artifact will be replaced with the it's appropriate default property value
  • Type: java.lang.String
  • Required: No
  • User Property: wildfly.artifact

artifactId:

The artifactId of the artifact to download. Ignored if artifact artifactId portion is used.
  • Type: java.lang.String
  • Required: No
  • User Property: wildfly.artifactId
  • Default: wildfly-dist

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

beforeDeployment:

Deprecated. use the execute-commands goal
Commands to run before the deployment
  • Type: org.wildfly.plugin.cli.Commands
  • Required: No
  • Alias: before-deployment

checkPackaging:

By default certain package types are ignored when processing, e.g. maven-project and pom. Set this value to false if this check should be bypassed.
  • Type: boolean
  • Required: No
  • User Property: wildfly.checkPackaging
  • Default: true
  • Alias: check-packaging

classifier:

The classifier of the artifact to download. Ignored if artifact classifier portion is used.
  • Type: java.lang.String
  • Required: No
  • User Property: wildfly.classifier

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

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

groupId:

The groupId of the artifact to download. Ignored if artifact groupId portion is used.
  • Type: java.lang.String
  • Required: No
  • User Property: wildfly.groupId
  • Default: org.wildfly

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

jvmArgs:

Deprecated. use javaOpts
A space delimited list of JVM arguments.
  • Type: java.lang.String
  • Required: No
  • User Property: wildfly.jvmArgs
  • Alias: jvm-args

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

packaging:

The packaging of the artifact to download. Ignored if artifact packing portion is used.
  • Type: java.lang.String
  • Required: No
  • User Property: wildfly.packaging
  • Default: zip

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

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

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 the deployment to be skipped, 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

targetDir:

The target directory the application to be deployed is located.
  • Type: java.io.File
  • Required: No
  • User Property: wildfly.deployment.targetDir
  • Default: ${project.build.directory}/

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 artifact to download. Ignored if artifact version portion is used. The default version is resolved if left blank.
  • Type: java.lang.String
  • Required: No
  • User Property: wildfly.version