wildfly:start

Full name:

org.wildfly.plugins:wildfly-maven-plugin:1.2.1.Final:start

Description:

Starts a standalone instance of WildFly Application Server. The purpose of this goal is to start a WildFly Application Server for testing during the maven lifecycle.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.

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.
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.
classifier String - The classifier of the artifact to download. Ignored if artifact classifier portion is used.
User property is: wildfly.classifier.
domainConfig String - The name of the domain configuration to use. This is only used for domain servers.
User property is: wildfly.domainConfig.
Alias is: domain-config.
env Map - Specifies the environment variables to be passed to the process being started.
<env>
    <HOME>/home/wildfly/</HOME>
</env>

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.
hostConfig String - The name of the host configuration to use. This is only used for domain servers.
User property is: wildfly.hostConfig.
Alias is: host-config.
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.
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.
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. This is only used for standalone servers.
User property is: wildfly.serverConfig.
Alias is: server-config.
serverType ServerType - The type of server to start.

STANDALONE for a standalone server and DOMAIN for a domain server.


Default value is: STANDALONE.
User property is: wildfly.server.type.
Alias is: server-type.
skip boolean - Set to true if you want to skip server start, 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.
stdout String - Indicates how stdout and stderr should be handled for the spawned server process. Note that stderr will be redirected to stdout if the value is defined unless the value is none.
By default stdout and stderr are inherited from the current process. You can change the setting to one of the follow:
  • none indicates the stdout and stderr stream should not be consumed. This should generally only be used if the shutdown goal is used in the same maven process.
  • System.out or System.err to redirect to the current processes (use this option if you see odd behavior from maven with the default value)
  • Any other value is assumed to be the path to a file and the stdout and stderr will be written there
Note that if this goal is not later followed by a shutdown goal in the same maven process you should use a file to redirect the stdout and stderr to. Both output streams will be redirected to the same file.

User property is: wildfly.stdout.
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

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

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

domainConfig:

The name of the domain configuration to use. This is only used for domain servers.
  • Type: java.lang.String
  • Required: No
  • User Property: wildfly.domainConfig
  • Alias: domain-config

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

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

hostConfig:

The name of the host configuration to use. This is only used for domain servers.
  • Type: java.lang.String
  • Required: No
  • User Property: wildfly.hostConfig
  • Alias: host-config

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

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

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. This is only used for standalone servers.
  • Type: java.lang.String
  • Required: No
  • User Property: wildfly.serverConfig
  • Alias: server-config

serverType:

The type of server to start.

STANDALONE for a standalone server and DOMAIN for a domain server.

  • Type: org.wildfly.plugin.server.ServerType
  • Required: No
  • User Property: wildfly.server.type
  • Default: STANDALONE
  • Alias: server-type

skip:

Set to true if you want to skip server start, 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

stdout:

Indicates how stdout and stderr should be handled for the spawned server process. Note that stderr will be redirected to stdout if the value is defined unless the value is none.
By default stdout and stderr are inherited from the current process. You can change the setting to one of the follow:
  • none indicates the stdout and stderr stream should not be consumed. This should generally only be used if the shutdown goal is used in the same maven process.
  • System.out or System.err to redirect to the current processes (use this option if you see odd behavior from maven with the default value)
  • Any other value is assumed to be the path to a file and the stdout and stderr will be written there
Note that if this goal is not later followed by a shutdown goal in the same maven process you should use a file to redirect the stdout and stderr to. Both output streams will be redirected to the same file.
  • Type: java.lang.String
  • Required: No
  • User Property: wildfly.stdout

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