Appendix A. Reference

bootable-jar

boolean

Set the value to true to create an executable Java Archive (jar) in addition to the provisioned server.

bootable-jar-install-artifact-classifier

String

When <bootable-jar> is set to true, the bootable JAR artifact is attached to the project with the classifier 'bootable'. Use this parameter to configure the classifier.

bootable-jar-name

String

Set the name to be used for the jar file when the bootable-jar parameter is set to true. By default, the generated file is named ${artifactid}-bootable.jar.

channels

List

A list of channel YAML file references. A channel file contains the versions of the JBoss EAP server artifacts. There are two ways to identify a channel YAML file.

<channels>
  <channel>
    <manifest>
      <groupId>org.jboss.eap.channels</groupId>
      <artifactId>eap-8.1</artifactId>
    </manifest>
  </channel>
</channels>

<channels>
  <channel>
    <manifest>
      <url>file:///foo/my-manifest.yaml</url>
    </manifest>
  </channel>
</channels>

excluded-layers

List

A list of Galleon layers to exclude. You can use it when feature-pack-location or feature-packs are set. Use the system property wildfly.provisioning.layers.excluded to provide a comma-separated list of layers to exclude.

extra-server-content-dirs

List

A list of directories from which content is copied to the provisioned server. You can use either the absolute path to the directory or the relative path. The relative path must be relative to the project base directory.

feature-packs

List

A list of feature-pack configurations to install, which you can combine with layers. Use the system property wildfly.provisioning.feature-packs to provide a comma-separated list of feature-packs.

filename

String

The file name of the application to deploy. The default value is ${project.build.finalName}.${project.packaging}. In an exception case, ejb packaging results in .jar extension. For example, the value of $[project.packaging] during war packaging is war and the value of $[project.packaging] during ejb packaging is ejb, which is not a valid jar extension. These cases require the .jar extension.

galleon-options

Map

When provisioning the server, you can set specific Galleon options. If you are building a large number of servers in the same Maven session, you must set jboss-fork-embedded option to true to fork Galleon provisioning and CLI scripts execution. For example:

<galleon-options>
  <jboss-fork-embedded>true</jboss-fork-embedded>
</galleon-options>

layers

List

A list of Galleon layers to provision. You can use it when feature-pack-location or feature-packs are set. Use the system property wildfly.provisioning.layers to provide a comma-separated list of layers.

layers-configuration-file-name

String

A name of the configuration file generated from layers. The default value is standalone.xml. You cannot set this parameter if layers are not configured.

log-provisioning-time

boolean

Specifies whether to log the provisioning time at the end of the provisioning. The default value is false.

name

String

A name used for the deployment.

offline-provisioning

boolean

Specifies whether to use offline mode when the plug-in resolves an artifact. In offline mode, the plug-in uses the local Maven repository for artifact resolution. The default value is false.

overwrite-provisioned-server

boolean

If you want to delete the existing server referenced from the provisioningDir and provision a new one, set it to true. If not, set it to false. The default value is false.

packaging-scripts

List

A list of CLI scripts and commands to execute. If a script file is not absolute, it must be relative to the project base directory. Configure the CLI executions in the following way:

<packaging-scripts>
  <packaging-script>
    <scripts>
      <script>../scripts/script1.cli</script>
    </scripts>
    <commands>
      <command>/system-property=foo:add(value=bar)</command>
    </commands>
    <properties-files>
      <property-file>my-properties.properties</property-file>
    </properties-files>
    <java-opts>
      <java-opt>-Xmx256m</java-opt>
    </java-opts>
    <!-- Expressions resolved during server execution -->
    <resolve-expressions>false</resolve-expressions>
  </packaging-script>
</packaging-scripts>

provisioning-dir

String

Path to the directory in which to provision the server. It can be an absolute path or a path relative to the buildDir. By default, the server is provisioned into the target/server directory. The default value is server.

provisioning-file

File

The path to the provisioning.xml file to use. You cannot use it when feature-packs configuration item and layers configuration item are set. If the provisioning file path is not absolute, it must be relative to the project base directory. The default value is ${project.basedir}/galleon/provisioning.xml.

record-provisioning-state

boolean

Specifies whether to record the provisioning state in .galleon directory. The default value is false.

runtime-name

String

The runtime-name of the deployment. The default value is the deployment file name, such as myapp.war. You can set this argument to ROOT.war to get the deployment registered in the HTTP root context.

server-config

String

The name of the server configuration to use during deployment. The deployment is deployed inside the configuration referenced from layers-configuration-file-name if layers-configuration-file-name is set. The default value is standalone.xml.

skip

boolean

If you want the goal to be skipped, set it to true. If not, set it to false. The default value is false.

skipDeployment

boolean

Set the value to true if you do not want to deploy the application to the provisioned server.

The default value is false.

stdout

String

Indicates how stdout and stderr are handled for the created CLI processes. stderr is redirected to stdout if the value is defined unless the value is none. By default the stdout and stderr streams are inherited from the current process. You can change the setting to one from the following options:

channels

List

A list of channel YAML file references. A channel file contains the versions of the JBoss EAP server artifacts. There are two ways to identify a channel YAML file.

<channels>
  <channel>
    <manifest>
      <groupId>org.jboss.eap.channels</groupId>
      <artifactId>eap-8.1</artifactId>
    </manifest>
  </channel>
</channels>

<channels>
  <channel>
    <manifest>
      <url>file:///foo/my-manifest.yaml</url>
    </manifest>
  </channel>
</channels>

excluded-layers

List

A list of Galleon layers to exclude. You can use it when feature-pack-location or feature-packs are set. Use the system property wildfly.provisioning.layers.excluded to provide a comma-separated list of layers to exclude.

feature-packs

List

A list of feature-pack configurations to install, which you can combine with layers. Use the system property wildfly.provisioning.feature-packs to provide a comma-separated list of feature-packs.

galleon-options

Map

When provisioning the server, you can set specific Galleon options. If you are building a large number of servers in the same Maven session, you must set jboss-fork-embedded option to true to fork Galleon provisioning and CLI scripts execution. For example:

<galleon-options>
  <jboss-fork-embedded>true</jboss-fork-embedded>
</galleon-options>

layers

List

A list of Galleon layers to provision. You can use it when feature-pack-location or feature-packs are set. Use the system property wildfly.provisioning.layers to provide a comma-separated list of layers.

layers-configuration-file-name

String

A name of the configuration file generated from layers. The default value is standalone.xml. You cannot set this parameter if layers are not configured.

log-provisioning-time

boolean

Specifies whether to log the provisioning time at the end of the provisioning. The default value is false.

offline-provisioning

boolean

Specifies whether to use offline mode when the plug-in resolves an artifact. In offline mode, the plug-in uses the local Maven repository for artifact resolution. The default value is false.

overwrite-provisioned-server

boolean

If you want to delete the existing server referenced from the provisioningDir and provision a new one, set it to true. If not, set it to false. The default value is false.

provisioning-dir

String

Path to the directory in which to provision the server. It can be an absolute path or a path relative to the buildDir. By default, the server is provisioned into the target/server directory. The default value is server.

provisioning-file

File

The path to the provisioning.xml file to use. You cannot use it when feature-packs configuration item and layers configuration item are set. If the provisioning file path is not absolute, it must be relative to the project base directory. The default value is ${project.basedir}/galleon/provisioning.xml.

record-provisioning-state

boolean

Specifies whether to record the provisioning state in .galleon directory. The default value is false.

skip

boolean

If you want the goal to be skipped, set it to true. If not, set it to false. The default value is false.

--help

Displays the help message for the specified command and exit.

--cli-script=<path>

Specifies the path to a JBoss CLI script that executes when starting the bootable JAR. If the path specified is relative, the path is resolved against the working directory of the Java VM instance used to launch the bootable JAR.

--deployment=<path>

Argument specific to the hollow bootable JAR. Specifies the path to the WAR, JAR, EAR file or exploded directory that contains the application you want to deploy on a server.

--display-galleon-config

Print the content of the generated Galleon configuration file.

--install-dir=<path>

By default, the JVM settings are used to create a TEMP directory after the bootable JAR is started. You can use the --install-dir argument to specify a directory to install the server.

-secmgr

Runs the server with a security manager installed.

-b<interface>=<value>

Set system property jboss.bind.address.<interface> to the given value. For example, bmanagement=IP_ADDRESS.

-b=<value>

Set system property jboss.bind.address, which is used in configuring the bind address for the public interface. This defaults to 127.0.0.1 if no value is specified.

-D<name>[=<value>]

Specifies system properties that are set by the server at server runtime. The bootable JAR JVM does not set these system properties.

--properties=<url>

Loads system properties from a specified URL.

-S<name>[=value]

Set a security property.

-u=<value>

Set system property jboss.default.multicast.address, which is used in configuring the multicast address in the socket-binding elements in the configuration files. This defaults to 230.0.0.4 if no value is specified.

--version

Display the application server version and exit.