All Downloads are FREE. Search and download functionalities are using the official Maven repository.

lugins.wildfly-bootable-jar-maven-plugin.1.0.0.Alpha2.source-code.package-mojo.adoc Maven / Gradle / Ivy

The newest version!
### package


#### wildfly-bootable-jar:package
*Full name:*
org.wildfly.plugins:wildfly-bootable-jar-maven-plugin:1.0.0.Alpha2:package


#### Description
Build a bootable jar containing application and provisioned server


#### Attributes


* Requires a Maven project to be executed.
* Requires dependency resolution of artifacts in scope: `compile+runtime`.
* Binds by default to the http://maven.apache.org/ref/current/maven-core/lifecycles.html[lifecycle phase]: `package`.

.Optional Parameters
[%autowidth.stretch]
|====
|Name|Type|Since|Description
|`<>`|`List`|`-`|Path to JBoss CLI scripts to execute once the server is provisioned
and application installed in server. +
*Alias is*: `cli-script-files`.
|`<>`|`String`|`-`|The WildFly galleon feature-pack location to use if no
provisioning.xml file found. +
*Default value is*: `wildfly@maven(org.jboss.universe:community-universe)`. +
*User property is*: `wildfly.bootable.fpl`. +
*Alias is*: `default-feature-pack-location`.
|`<>`|`boolean`|`-`|App in dev, copied to deployments dir, expected to be run with a
dev-server. +
*User property is*: `wildfly.bootable.dev.app`. +
*Alias is*: `dev-app`.
|`<>`|`boolean`|`-`|Hollow server + activate scan of deployments dir +
*User property is*: `wildfly.bootable.dev.server`. +
*Alias is*: `dev-server`.
|`<>`|`List`|`-`|A list of galleon layers to exclude. +
*Alias is*: `exclude-layers`.
|`<>`|`boolean`|`-`|Hollow jar. Create a bootable jar that doesn't contain application. +
*User property is*: `wildfly.bootable.hollow`. +
*Alias is*: `hollow-jar`.
|`<>`|`List`|`-`|A list of galleon layers to provision. +
*Alias is*: `layers`.
|`<>`|`boolean`|`-`|Whether to log provisioning time at the end +
*Default value is*: `false`. +
*Alias is*: `log-time`.
|`<>`|`boolean`|`-`|Whether to use offline mode when the plugin resolves an artifact.
In offline mode the plugin will only use the local Maven repository
for an artifact resolution. +
*Default value is*: `false`. +
*Alias is*: `offline`.
|`<>`|`String`|`-`|By default the generated jar is
${project.build.finalName}-wildfly-bootable.jar +
*User property is*: `wildfly.bootable.package.output.file.name`. +
*Alias is*: `output-file-name`.
|`<>`|`Map`|`-`|Arbitrary Galleon options used when provisioning the server. +
*Alias is*: `plugin-options`.
|`<>`|`String`|`-`|(no description) +
*Default value is*: `${project.build.directory}`. +

|`<>`|`String`|`-`|Path to a JBoss CLI script properties file. +
*Alias is*: `cli-properties-file`.
|`<>`|`boolean`|`-`|Whether to record provisioned state in .galleon directory. +
*Default value is*: `false`. +
*Alias is*: `record-state`.
|`<>`|`boolean`|`-`|To make the war registered under root resource path ('/'). +
*Default value is*: `true`. +
*User property is*: `wildfly.bootable.root.url`. +
*Alias is*: `root-url-path`.
|`<>`|`boolean`|`-`|Set to `true` if you want the deployment to be skipped,
otherwise `false`. +
*Default value is*: `false`. +
*User property is*: `wildfly.bootable.package.skip`. +


|====


#### Parameter Details

[[cliScriptFiles]] *cliScriptFiles* +
Path to JBoss CLI scripts to execute once the server is provisioned
and application installed in server.

* *Type*: `java.util.List`
* *Required*: `No`
* *Alias*: `cli-script-files`



[[defaultFpl]] *defaultFpl* +
The WildFly galleon feature-pack location to use if no
provisioning.xml file found.

* *Type*: `java.lang.String`
* *Required*: `No`
* *User Property*: `wildfly.bootable.fpl`
* *Default*: `wildfly@maven(org.jboss.universe:community-universe)`
* *Alias*: `default-feature-pack-location`



[[devApp]] *devApp* +
App in dev, copied to deployments dir, expected to be run with a
dev-server.

* *Type*: `boolean`
* *Required*: `No`
* *User Property*: `wildfly.bootable.dev.app`
* *Alias*: `dev-app`



[[devServer]] *devServer* +
Hollow server + activate scan of deployments dir

* *Type*: `boolean`
* *Required*: `No`
* *User Property*: `wildfly.bootable.dev.server`
* *Alias*: `dev-server`



[[excludeLayers]] *excludeLayers* +
A list of galleon layers to exclude.

* *Type*: `java.util.List`
* *Required*: `No`
* *Alias*: `exclude-layers`



[[hollowJar]] *hollowJar* +
Hollow jar. Create a bootable jar that doesn't contain application.

* *Type*: `boolean`
* *Required*: `No`
* *User Property*: `wildfly.bootable.hollow`
* *Alias*: `hollow-jar`



[[layers]] *layers* +
A list of galleon layers to provision.

* *Type*: `java.util.List`
* *Required*: `No`
* *Alias*: `layers`



[[logTime]] *logTime* +
Whether to log provisioning time at the end

* *Type*: `boolean`
* *Required*: `No`
* *Default*: `false`
* *Alias*: `log-time`



[[offline]] *offline* +
Whether to use offline mode when the plugin resolves an artifact.
In offline mode the plugin will only use the local Maven repository
for an artifact resolution.

* *Type*: `boolean`
* *Required*: `No`
* *Default*: `false`
* *Alias*: `offline`



[[outputFileName]] *outputFileName* +
By default the generated jar is
${project.build.finalName}-wildfly-bootable.jar

* *Type*: `java.lang.String`
* *Required*: `No`
* *User Property*: `wildfly.bootable.package.output.file.name`
* *Alias*: `output-file-name`



[[pluginOptions]] *pluginOptions* +
Arbitrary Galleon options used when provisioning the server.

* *Type*: `java.util.Map`
* *Required*: `No`
* *Alias*: `plugin-options`



[[projectBuildDir]] *projectBuildDir* +
(no description)

* *Type*: `java.lang.String`
* *Required*: `No`
* *Default*: `${project.build.directory}`



[[propertiesFile]] *propertiesFile* +
Path to a JBoss CLI script properties file.

* *Type*: `java.lang.String`
* *Required*: `No`
* *Alias*: `cli-properties-file`



[[recordState]] *recordState* +
Whether to record provisioned state in .galleon directory.

* *Type*: `boolean`
* *Required*: `No`
* *Default*: `false`
* *Alias*: `record-state`



[[rootUrlPath]] *rootUrlPath* +
To make the war registered under root resource path ('/').

* *Type*: `boolean`
* *Required*: `No`
* *User Property*: `wildfly.bootable.root.url`
* *Default*: `true`
* *Alias*: `root-url-path`



[[skip]] *skip* +
Set to `true` if you want the deployment to be skipped,
otherwise `false`.

* *Type*: `boolean`
* *Required*: `No`
* *User Property*: `wildfly.bootable.package.skip`
* *Default*: `false`







© 2015 - 2025 Weber Informatics LLC | Privacy Policy