jboss-as:add-resource

Full name:

org.jboss.as.plugins:jboss-as-maven-plugin:7.1.0.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.

Attributes:

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

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.
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.
hostname String - Specifies the host name of the server where the deployment plan should be executed.
Default value is: localhost.
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,
port int - Specifies the port number the server is listening on.
Default value is: 9999.
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.
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,

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

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
  • Expression: ${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
  • Expression: ${deploy.hostname}
  • Default: localhost

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
  • Expression: ${deploy.password}

port:

Specifies the port number the server is listening on.
  • Type: int
  • Required: No
  • Expression: ${deploy.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

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
  • Expression: ${deploy.username}