jboss-as:add-resource

Full name:

org.jboss.as.plugins:jboss-as-maven-plugin:7.9.Final:add-resource

Description:

Adds a resource If force is set to false and the resource has already been deployed to the server, an error will occur and the operation will fail. Note: this currently only works with adding resources to subsystems when your server is running in domain mode.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.

Optional Parameters

Name Type Since Description
address String - The operation address, as a comma separated string. If the resource or resources also define and address, this address will be used as the parent address. Meaning the resource addresses will be prepended with this address.
domain Domain - Specifies the configuration for a domain server.
force boolean - Specifies whether force mode should be used or not.

If force mode is disabled, the add-resource goal will cause a build failure if the resource is already present on the server.
Default value is: true.
User property is: add-resource.force.
hostname String - Specifies the host name of the server where the deployment plan should be executed.
Default value is: localhost.
User property is: jboss-as.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: jboss-as.id.
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: jboss-as.password.
port int - Specifies the port number the server is listening on.
Default value is: 9999.
User property is: jboss-as.port.
properties Map - Deprecated. prefer the resources or resource configuration.
resource Resource - The resource to add. A resource could consist of;
  • An address, which may be appended to this address if defined <address/>.
  • A mapping of properties to be set on the resource <properties/>.
  • A flag to indicate whether or not the resource should be enabled <enableResource/>

resources Resource[] - A collection of resources to add.
skip boolean - Indicates whether or not the goal should be skipped.
Default value is: false.
User property is: jboss-as.skip.
timeout int - Specifies the timeout to be used when hitting the host. Default is 5000ms.
User property is: jboss-as.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: jboss-as.username.

Parameter Details

address:

The operation address, as a comma separated string. If the resource or resources also define and address, this address will be used as the parent address. Meaning the resource addresses will be prepended with this address.
  • Type: java.lang.String
  • Required: No

domain:

Specifies the configuration for a domain server.
  • Type: org.jboss.as.plugin.deployment.domain.Domain
  • Required: No

force:

Specifies whether force mode should be used or not.

If force mode is disabled, the add-resource goal will cause a build failure if the resource is already present on the server.
  • Type: boolean
  • Required: No
  • User Property: add-resource.force
  • Default: true

hostname:

Specifies the host name of the server where the deployment plan should be executed.
  • Type: java.lang.String
  • Required: No
  • User Property: jboss-as.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: jboss-as.id

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: jboss-as.password

port:

Specifies the port number the server is listening on.
  • Type: int
  • Required: No
  • User Property: jboss-as.port
  • Default: 9999

properties:

Deprecated. prefer the resources or resource configuration.
The operation properties.
  • Type: java.util.Map
  • Required: No

resource:

The resource to add. A resource could consist of;
  • An address, which may be appended to this address if defined <address/>.
  • A mapping of properties to be set on the resource <properties/>.
  • A flag to indicate whether or not the resource should be enabled <enableResource/>
  • Type: org.jboss.as.plugin.deployment.resource.Resource
  • Required: No

resources:

A collection of resources to add.
  • Type: org.jboss.as.plugin.deployment.resource.Resource[]
  • Required: No

skip:

Indicates whether or not the goal should be skipped.
  • Type: boolean
  • Required: No
  • User Property: jboss-as.skip
  • Default: false

timeout:

Specifies the timeout to be used when hitting the host. Default is 5000ms.
  • Type: int
  • Required: No
  • User Property: jboss-as.timeout

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: jboss-as.username