wildfly-extension:deploy

Full name:

org.wildfly.plugins:wildfly-extension-maven-plugin:0.7.0:deploy

Description:

Goal which deploys JBoss module to JBoss AS7/WildFly server

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency collection of artifacts in scope: compile.
  • Binds by default to the lifecycle phase: install.

Required Parameters

Name Type Since Description
jbossHome File - Location of AS7/WildFly server to deploy to
Default value is: ${jboss.home}.

Optional Parameters

Name Type Since Description
artifact String 0.7 An alternative to moduleZip parameter. This parameter has higher priority than moduleZip. A string of the form groupId:artifactId:version[:packaging][:classifier]. Default for packaging is zip and for classifier it's module
edit Insert[] - List of data to be inserted to serverConfig. This is pretty powerful stuff to put/replace any XML content anywhere in serverConfig
failNoMatch boolean - Fails the build if any of select expression within edit does not match any node (thus it wouldn't update serverConfig)
moduleZip File - Location of JBoss input module.zip This file should have JBoss module directory structure so it can be laid down to modulesHome directory.
modulesHome String - Location of modules home (either relative to jbossHome or absolute). Set this value unless your structure inside moduleZip does not include path to modules. For Wildfly, this path is "modules/system/layers/base", for older AS7 versions it's just "modules".
Default value is: modules/system/layers/base.
serverConfig String - Location of server configuration file (standalone.xml) write to (can be either relative to jbossHome or absolute)
Default value is: standalone/configuration/standalone.xml.
serverConfigBackup String - Location where plugin will backup original server configuration file (standalone.xml) - can be either relative to jbossHome or absolute
Default value is: standalone/configuration/standalone.xml.old.
skipDeploy boolean - Whether to skip the execution of this mojo.
Default value is: false.
socketBinding File - Location of socket-binding content to be inserted into standalone.xml
socketBindingGroups String[] - List of socket-binding-groups to set socketBinding in (only applies when socketBinding exists) Default : ["standard-sockets"]
subsystem File - Location of subsystem content to be inserted into standalone.xml

Parameter Details

artifact:

An alternative to moduleZip parameter. This parameter has higher priority than moduleZip. A string of the form groupId:artifactId:version[:packaging][:classifier]. Default for packaging is zip and for classifier it's module
  • Type: java.lang.String
  • Since: 0.7
  • Required: No

edit:

List of data to be inserted to serverConfig. This is pretty powerful stuff to put/replace any XML content anywhere in serverConfig
  • Type: org.wildfly.plugins.Insert[]
  • Required: No

failNoMatch:

Fails the build if any of select expression within edit does not match any node (thus it wouldn't update serverConfig)
  • Type: boolean
  • Required: No

jbossHome:

Location of AS7/WildFly server to deploy to
  • Type: java.io.File
  • Required: Yes
  • Default: ${jboss.home}

moduleZip:

Location of JBoss input module.zip This file should have JBoss module directory structure so it can be laid down to modulesHome directory.
  • Type: java.io.File
  • Required: No

modulesHome:

Location of modules home (either relative to jbossHome or absolute). Set this value unless your structure inside moduleZip does not include path to modules. For Wildfly, this path is "modules/system/layers/base", for older AS7 versions it's just "modules".
  • Type: java.lang.String
  • Required: No
  • Default: modules/system/layers/base

serverConfig:

Location of server configuration file (standalone.xml) write to (can be either relative to jbossHome or absolute)
  • Type: java.lang.String
  • Required: No
  • Default: standalone/configuration/standalone.xml

serverConfigBackup:

Location where plugin will backup original server configuration file (standalone.xml) - can be either relative to jbossHome or absolute
  • Type: java.lang.String
  • Required: No
  • Default: standalone/configuration/standalone.xml.old

skipDeploy:

Whether to skip the execution of this mojo.
  • Type: boolean
  • Required: No
  • Default: false

socketBinding:

Location of socket-binding content to be inserted into standalone.xml
  • Type: java.io.File
  • Required: No

socketBindingGroups:

List of socket-binding-groups to set socketBinding in (only applies when socketBinding exists) Default : ["standard-sockets"]
  • Type: java.lang.String[]
  • Required: No

subsystem:

Location of subsystem content to be inserted into standalone.xml
  • Type: java.io.File
  • Required: No