JBoss Application Server 7+ Plugin Reference 10.1.x

    The XL Deploy JBoss Domain (DM) plugin allows you to manage deployments and resources on JBoss Enterprise Application Platform (EAP) 6 and JBoss Application Server (AS)/WildFly 7.1+.

    This document provides information that is specific to this version of the JBoss DM plugin. For general information about the plugin, refer to Introduction to the XL Deploy JBoss Domain plugin.

    Requirements

    • XL Deploy 5.1.0 or later
    • JBoss AS/WildFly 7.1
    • WildFly: 8.0.x, 8.1.x, or 9.0.x
    • JBoss EAP: 6.2.0, 6.3.0, 6.4.0 and 7.0.0
    • User credentials for accessing the host and JBoss command-line interface

    Using the deployables and deployeds

    Deployable vs. container table

    The following table describes which deployable/container combinations are possible.

    Deployable Container Generated deployed
    jee.Ear
    jbossdm.Ear
    jbossdm.Domain
    jbossdm.StandaloneServer
    jbossdm.ServerGroup
    jbossdm.EarModule
    jee.War
    jbossdm.War
    jbossdm.Domain
    jbossdm.StandaloneServer
    jbossdm.ServerGroup
    jbossdm.WarModule
    jee.DataSourceSpec jbossdm.Domain
    jbossdm.StandaloneServer
    jbossdm.Profile
    jbossdm.JeeXaDataSource
    jbossdm.JeeDataSource
    jbossdm.XaDataSourceSpec jbossdm.Domain
    jbossdm.StandaloneServer
    jbossdm.Profile
    jbossdm.XaDataSource
    jbossdm.DataSourceSpec jbossdm.Domain
    jbossdm.StandaloneServer
    jbossdm.Profile
    jbossdm.Datasource
    jee.QueueSpec
    jbossdm.QueueSpec
    jbossdm.Domain
    jbossdm.StandaloneServer
    jbossdm.Profile
    jbossdm.Queue
    jee.TopicSpec
    jbossdm.TopicSpec
    jbossdm.Domain
    jbossdm.StandaloneServer
    jbossdm.Profile
    jbossdm.Topic

    Deployed actions table

    The following table describes the effect a deployed has on its container.

    Deployed Actions performed for operations
      Create Destroy Modify
    jbossdm.EarModule
    jbossdm.WarModule
    • upload artifact
    • deploy application
    • undeploy old application version
    • undeploy old application version
    • deploy new application version
    jbossdm.DataSource
    jbossdm.XaDataSource
    jbossdm.JeeDataSource
    jbossdm.JeeXaDataSource
    • create datasource
    • set connection/datasource properties
    • enable datasource
    • destroy datasource
    • destroy datasource
    • create datasource
    • set connection/datasource properties
    • enable datasource
    jbossdm.Queue
    • create Queue
    • destroy Queue
    • destroy Queue
    • create modified Queue
    jbossdm.Topic
    • create Topic
    • destroy Topic
    • destroy Topic
    • create modified Topic

    Release notes

    Version 9.0.0

    Bug fixes

    • [XLINT-758] Fix deployment timeout issues in certain JBoss EAP versions.

    Version 7.5.0

    Bug fixes

    • [DEPL-12303] This release provides a fix for an issue that caused the JBoss daemon to hang

    Version 6.0.2

    • [DEPL-10679] Support for JBoss EAP 7.0

    Version 6.0.1

    Compatible with XL Deploy 6.0

    Version 6.0.0

    Compatible with XL Deploy 6.0

    Version 5.1.0

    Features

    • [DEPL-9084] Support for JBoss EAP 6.4
    • [DEPL-9089] Support for Wildfly 9

    Bug fixes

    • [DEPL-8922] Deployment fails with an incorrect deployment error

    Version 5.0.2

    Features

    • [DEPL-9084] Support for JBoss EAP 6.4
    • [DEPL-9089] Support for Wildfly 9

    Bug fixes

    • [DEPL-8922] Deployment fails with an incorrect deployment error

    Version 5.0.1

    Features

    • [DEPL-8431] Fixed issue where special characters were not escaped when deploying without a daemon (introduced commandExecutionMode property on CLIBasedContainer)
      • Implemented command execution in non-daemon mode via jboss-cli file paramater

    Bug fixes

    • [DEPL-8347] Fixed issue where a deployed datasource with default pool data fails the connection test
    • [DEPL-7750] Fixed issue where recovery file couldn't be written throwing a 'SshElevatedUserFile is not serializable' exception
    • [DEPL-7937] Fixed error handling problem if Daemon is enabled

    Version 5.0.0

    Compatible with XL Deploy 5.0

    Bug fixes

    • [DEPL-7782] jboss-cli step fails if the connection type is SFTP

    Version 4.5.1

    Features

    • [DEPL-6847] Add jboss-cli step primitive

    Bug fixes

    • [DEPL-7703] Cancelling or rolling back a deployment can give the wrong results in jbossdm plugin

    Improvements

    • [DEPL-5851] CliProcessOutputHandler should handle error lines
    • [DEPL-6782] Datasources, jms resources and application names should not contain whitespace characters.

    Version 4.5.0

    Feature

    • [DEPL-4895] - Support JBoss EAP 6.2.0, EAP 6.3.0
    • [DEPL-5566] - Support Wildfly 8.0.0.Final, 8.1.0.Final

    Version 4.0.2

    Feature

    • [DEPL-4895] - Support JBoss EAP 6.2.0, EAP 6.3.0
    • [DEPL-5566] - Support Wildfly 8.0.0.Final, 8.1.0.Final

    Version 4.0.1

    Feature

    • [DEPL-5524] - Support staging of artifacts

    Bug fixes

    • [DEPL-5665] - Deployit hangs when JBoss CLI terminates unexpectedly
    • [DEPL-5666] - JBossDM Datasource attributes are truncated when value has spaces.

    Improvements

    • [DEPL-5664] - Show preview of JBoss DM steps in analyser
    • [DEPL-5667] - Better propagation JBoss CLI errors and jython scripting errors to the user.

    Version 4.0.0

    Bug fixes

    • [DEPL-5234] - jbossdm-plugin JAR is packaged twice in the distribution zip file
    • [DEPL-5304] - A context root is required when deploying to JBoss DM

    Improvements

    • [DEPL-5225] - Update JBoss DM plugin documentation with manifest.xml example

    Version 3.9.1

    Bug fixes

    • DEPLOYITPB-4950 contextRoot is a required parameter on jbossdm.WarModule
    • DEPLOYITPB-4896 jbossdm-plugin distribution does not contain jython-standalone-2.5.1.jar
    • DEPLOYITPB-4340 Exceptions that occur during execution of JBoss CLI command are masked

    Version 3.9.0

    Improvements

    • [DEPLOYITPB-4430] - Added jbossdm.EjbJar type for EJB deployments.

    Version 3.8.1

    Bug fixes

    • [DEPLOYITPB-3948] - Orders have not been configured correctly
    • [DEPLOYITPB-4140] - Jboss DM plugin uses List as an asContainment property

    Version 3.8.0

    Improvements

    • [DEPLOYITPB-2906] - Support JBoss 7+ and JBoss EAP 6+

    CI Reference

    Configuration Item Overview

    Deployables

    CIDescription
    jbossdm.DataSourceSpec DataSource. This deployed is used when a jbossdm.DataSourceSpec is specified in a package. (deployable)
    jbossdm.Ear A JEE EAR archive
    jbossdm.EjbJar A JEE EJBJAR archive
    jbossdm.JeeDataSourceSpec Description unavailable
    jbossdm.QueueSpec A Queue
    jbossdm.TopicSpec A Topic
    jbossdm.War A JEE WAR archive
    jbossdm.XaDataSourceSpec XA DataSource. This deployed is used when a jbossdm.XaDataSourceSpec is specified in a package. (deployable)

    Deployeds

    CIDescription
    jbossdm.BaseDataSource Base definition of a DataSource
    jbossdm.CliManagedDeployed Base for all deployed that utilize the JBoss Cli for configuration
    jbossdm.CliManagedDeployedArtifact Base for all deployed artifacts that utilize the JBoss Cli for configuration
    jbossdm.DataSource DataSource. This deployed is used when a jbossdm.DataSourceSpec is specified in a package.
    jbossdm.EarModule Ear with values configured for a deployment
    jbossdm.EjbJarModule EJbJar with values configured for a deployment
    jbossdm.JeeDataSource Datasource. This deployed is used when a jee.DataSourceSpec is specified in a package.
    jbossdm.JeeXaDataSource XA DataSource. This deployed is used when a jee.DataSourceSpec is specified in a package.
    jbossdm.Queue A Jboss Queue
    jbossdm.Topic A JBoss topic
    jbossdm.WarModule War with values configured for a deployment
    jbossdm.XaDataSource XA DataSource. This deployed is used when a jbossdm.XaDataSourceSpec is specified in a package.

    Containers

    CIDescription
    jbossdm.CliBasedContainer JBoss Cli Managed Container
    jbossdm.Domain Description unavailable
    jbossdm.Profile JBoss Profile
    jbossdm.ServerGroup JBoss Server Group
    jbossdm.StandaloneServer JBoss Standalone Server

    Configuration Item Details

    jbossdm.BaseDataSource

    Virtual Type
    Type Hierarchy jbossdm.CliManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    Base definition of a DataSource

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    driverName: STRING
    Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit.
     
     
    jndiName: STRING
    Specifies the JNDI name for the datasource
     
     
    backgroundValidation: BOOLEAN
    An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
     
     
    checkValidSql: STRING
    Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    exceptionSorter: STRING
    An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error
     
     
    maxPoolSize: INTEGER
    The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool
     
     
    minPoolSize: INTEGER
    The min-pool-size element specifies the minimum number of connections for a pool
     
     
    password: STRING
    Specifies the password used when creating a new connection
     
     
    prefillEnabled: BOOLEAN
    Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
     
     
    securityDomain: STRING
    Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool
     
     
    sharePreparedStatements: BOOLEAN
    Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement
     
     
    staleConnectionChecker: STRING
    An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException
     
     
    statementCacheSize: INTEGER = -1
    The number of prepared statements per connection in an LRU cache
     
     
    strictMinimum: BOOLEAN
    Specifies if the min-pool-size should be considered strictly
     
     
    username: STRING
    Specify the user name used when creating a new connection
     
     
    validConnectionChecker: STRING
    An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element
     
     
    validateOnMatch: BOOLEAN
    The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation
     
     
    validationMillis: INTEGER = -1
    The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise
      Hidden properties
     
     
    createOrder: INTEGER = 60
    The order of the step in the step list for the create operation.
     
     
    createScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the create operation.
     
     
    createVerb: STRING = Create
    Create Verb
     
     
    destroyOrder: INTEGER = 40
    The order of the step in the step list for the destroy operation.
     
     
    destroyVerb: STRING = Destroy
    Destroy Verb
     
     
    libraries: LIST_OF_STRING = [jboss/dm/ds/datasource-lib.py]
    List of python library scripts that should be automatically loaded when using a JBoss CLI script.
     
     
    modifyOrder: INTEGER = 60
    The order of the step in the step list for the modify operation.
     
     
    modifyVerb: STRING = Modify
    Modify Verb
     
     
    noopOrder: INTEGER = 50
    The order of the step in the step list for the noop operation.
     
     
    noopVerb: STRING = Modify
    Noop Verb
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
     
     
    destroyScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the destroy operation.
     
     
    inspectScript: STRING
    Classpath to the script used to inspect the generic container.
     
     
    modifyScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the modify operation.
     
     
    noopScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the noop operation.

    jbossdm.CliBasedContainer

    Virtual Type
    Type Hierarchy udm.BaseContainer >> udm.BaseConfigurationItem
    Interfaces jbossdm.ApplicationContainer, jbossdm.CliManagedContainer, jbossdm.CliManagingContainer, udm.Container, overthere.HostContainer, jbossdm.ResourceContainer, udm.Taggable

    JBoss Cli Managed Container

      Parent
     
     
    host: CI<overthere.Host>
    Host
      Public properties
     
     
    cliScriptPrefix: STRING = jboss-cli
    JBoss CLI script prefix. Depending on the host, either an '.sh' or '.bat' will be appended to get the cli script name.
     
     
    home: STRING
    JBoss home directory
     
     
    port: INTEGER = 9999
    TCP port which is used to login to JBoss Native Administration, default is 9999
     
     
    adminHostAddress: STRING = localhost
    Host which is used to login to JBoss Native Administration, default is localhost
     
     
    commandExecutionMode: ENUM [CLI_COMMANDS, CLI_FILE] = CLI_COMMANDS
    Command execution mode when daemon is disabled. Commands can be executed directly against remote jboss CLI process using --commands option (CLI_COMMANDS) or they can be uploaded to a temporary file and executed using --file option (CLI_FILE). By default it is set to CLI_COMMANDS, but if you have special characters like '{}[]=@()' set it to the CLI_FILE value
     
     
    enableDaemon: BOOLEAN = true
    Connection to CLI is setup using a daemon. Set it to false if connection to the host does not support streaming.
     
     
    password: STRING
    Password which is used to login to JBoss Native Administration.
     
     
    tags: SET_OF_STRING
    If set, only deployables with the same tag will be automatically mapped to this container.
     
     
    username: STRING
    Username which is used to login to JBoss Native Administration.
      Hidden properties
     
     
    daemonConnectTimeout: INTEGER
    Connection read timeout for CLI daemon boot up.
     
     
    libraries: LIST_OF_STRING = [jboss/dm/library/runtime.py]
    List of python library scripts that should be automatically loaded when using a JBoss CLI script

    jbossdm.CliManagedDeployed

    Virtual Type
    Type Hierarchy udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    Base for all deployed that utilize the JBoss Cli for configuration

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
      Hidden properties
     
     
    createOrder: INTEGER = 60
    The order of the step in the step list for the create operation.
     
     
    createScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the create operation.
     
     
    createVerb: STRING = Create
    Create Verb
     
     
    destroyOrder: INTEGER = 40
    The order of the step in the step list for the destroy operation.
     
     
    destroyVerb: STRING = Destroy
    Destroy Verb
     
     
    modifyOrder: INTEGER = 60
    The order of the step in the step list for the modify operation.
     
     
    modifyVerb: STRING = Modify
    Modify Verb
     
     
    noopOrder: INTEGER = 50
    The order of the step in the step list for the noop operation.
     
     
    noopVerb: STRING = Modify
    Noop Verb
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
     
     
    destroyScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the destroy operation.
     
     
    inspectScript: STRING
    Classpath to the script used to inspect the generic container.
     
     
    libraries: LIST_OF_STRING
    List of python library scripts that should be automatically loaded when using a JBoss CLI script.
     
     
    modifyScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the modify operation.
     
     
    noopScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the noop operation.

    jbossdm.CliManagedDeployedArtifact

    Virtual Type
    Type Hierarchy jbossdm.CliManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer

    Base for all deployed artifacts that utilize the JBoss Cli for configuration

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    placeholders: MAP_STRING_STRING
    A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
      Hidden properties
     
     
    createOrder: INTEGER = 70
    The order of the step in the step list for the create operation.
     
     
    createScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the create operation.
     
     
    createVerb: STRING = Create
    Create Verb
     
     
    destroyOrder: INTEGER = 30
    The order of the step in the step list for the destroy operation.
     
     
    destroyVerb: STRING = Destroy
    Destroy Verb
     
     
    modifyOrder: INTEGER = 70
    The order of the step in the step list for the modify operation.
     
     
    modifyVerb: STRING = Modify
    Modify Verb
     
     
    noopOrder: INTEGER = 50
    The order of the step in the step list for the noop operation.
     
     
    noopVerb: STRING = Modify
    Noop Verb
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
     
     
    destroyScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the destroy operation.
     
     
    inspectScript: STRING
    Classpath to the script used to inspect the generic container.
     
     
    libraries: LIST_OF_STRING
    List of python library scripts that should be automatically loaded when using a JBoss CLI script.
     
     
    modifyScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the modify operation.
     
     
    noopScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the noop operation.

    jbossdm.DataSource

    Type Hierarchy jbossdm.JeeDataSource >> jbossdm.BaseDataSource >> jbossdm.CliManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    DataSource. This deployed is used when a jbossdm.DataSourceSpec is specified in a package.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    connectionUrl: STRING
    The JDBC driver connection URL
     
     
    driverName: STRING
    Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit.
     
     
    jndiName: STRING
    Specifies the JNDI name for the datasource
     
     
    backgroundValidation: BOOLEAN
    An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
     
     
    checkValidSql: STRING
    Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool
     
     
    connectionProperties: MAP_STRING_STRING
    JDBC connection properties
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    exceptionSorter: STRING
    An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error
     
     
    maxPoolSize: INTEGER
    The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool
     
     
    minPoolSize: INTEGER
    The min-pool-size element specifies the minimum number of connections for a pool
     
     
    newConnectionSql: STRING
    Specifies an SQL statement to execute whenever a connection is added to the connection pool
     
     
    password: STRING
    Specifies the password used when creating a new connection
     
     
    prefillEnabled: BOOLEAN
    Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
     
     
    securityDomain: STRING
    Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool
     
     
    sharePreparedStatements: BOOLEAN
    Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement
     
     
    staleConnectionChecker: STRING
    An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException
     
     
    statementCacheSize: INTEGER = -1
    The number of prepared statements per connection in an LRU cache
     
     
    strictMinimum: BOOLEAN
    Specifies if the min-pool-size should be considered strictly
     
     
    transactionIsolation: STRING
    Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE
     
     
    useCcm: BOOLEAN
    Enable the use of a cached connection manager
     
     
    useJta: BOOLEAN
    Enable JTA integration
     
     
    username: STRING
    Specify the user name used when creating a new connection
     
     
    validConnectionChecker: STRING
    An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element
     
     
    validateOnMatch: BOOLEAN
    The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation
     
     
    validationMillis: INTEGER = -1
    The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise
      Hidden properties
     
     
    createOrder: INTEGER = 60
    The order of the step in the step list for the create operation.
     
     
    createScript: STRING = jboss/dm/ds/create-datasource.py
    Classpath to the script that is uploaded and executed on the generic container for the create operation.
     
     
    createVerb: STRING = Create
    Create Verb
     
     
    destroyOrder: INTEGER = 40
    The order of the step in the step list for the destroy operation.
     
     
    destroyScript: STRING = jboss/dm/ds/destroy-datasource.py
    Classpath to the script that is uploaded and executed on the generic container for the destroy operation.
     
     
    destroyVerb: STRING = Destroy
    Destroy Verb
     
     
    inspectScript: STRING = jboss/dm/ds/inspect-datasource.py
    Classpath to the script used to inspect the generic container.
     
     
    libraries: LIST_OF_STRING = [jboss/dm/ds/datasource-lib.py]
    List of python library scripts that should be automatically loaded when using a JBoss CLI script.
     
     
    modifyOrder: INTEGER = 60
    The order of the step in the step list for the modify operation.
     
     
    modifyVerb: STRING = Modify
    Modify Verb
     
     
    noopOrder: INTEGER = 50
    The order of the step in the step list for the noop operation.
     
     
    noopVerb: STRING = Modify
    Noop Verb
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
     
     
    modifyScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the modify operation.
     
     
    noopScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the noop operation.

    jbossdm.DataSourceSpec

    Type Hierarchy jee.DataSourceSpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.Deployable, udm.Taggable

    DataSource. This deployed is used when a jbossdm.DataSourceSpec is specified in a package. (deployable)

      Public properties
     
     
    backgroundValidation: STRING
    An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise. (boolean) default(false)
     
     
    checkValidSql: STRING
    Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool (string)
     
     
    connectionProperties: MAP_STRING_STRING
    JDBC connection properties (map_string_string)
     
     
    connectionUrl: STRING
    The JDBC driver connection URL (string)
     
     
    driverName: STRING
    Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit. (string)
     
     
    exceptionSorter: STRING
    An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error (string)
     
     
    jndiName: STRING
    Specifies the JNDI name for the datasource (string)
     
     
    maxPoolSize: STRING
    The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool (integer)
     
     
    minPoolSize: STRING
    The min-pool-size element specifies the minimum number of connections for a pool (integer)
     
     
    newConnectionSql: STRING
    Specifies an SQL statement to execute whenever a connection is added to the connection pool (string)
     
     
    password: STRING
    Specifies the password used when creating a new connection (string)
     
     
    prefillEnabled: STRING
    Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise. (boolean) default(false)
     
     
    securityDomain: STRING
    Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool (string)
     
     
    sharePreparedStatements: STRING
    Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement (boolean)
     
     
    staleConnectionChecker: STRING
    An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException (string)
     
     
    statementCacheSize: STRING
    The number of prepared statements per connection in an LRU cache (integer) default(-1)
     
     
    strictMinimum: STRING
    Specifies if the min-pool-size should be considered strictly (boolean) default(false)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    transactionIsolation: STRING
    Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE (string)
     
     
    useCcm: STRING
    Enable the use of a cached connection manager (boolean) default(false)
     
     
    useJta: STRING
    Enable JTA integration (boolean) default(false)
     
     
    username: STRING
    Specify the user name used when creating a new connection (string)
     
     
    validConnectionChecker: STRING
    An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element (string)
     
     
    validateOnMatch: STRING
    The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation (boolean) default(false)
     
     
    validationMillis: STRING
    The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise (integer) default(-1)
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    jbossdm.Domain

    Type Hierarchy jbossdm.CliBasedContainer >> udm.BaseContainer >> udm.BaseConfigurationItem
    Interfaces jbossdm.ApplicationContainer, jbossdm.CliManagedContainer, jbossdm.CliManagingContainer, udm.Container, overthere.HostContainer, jbossdm.ResourceContainer, udm.Taggable

    Description unavailable

      Parent
     
     
    host: CI<overthere.Host>
    Host
      Children
     
     
    profiles: SET_OF_CI<jbossdm.Profile>
    Profiles defined in domain
     
     
    serverGroups: SET_OF_CI<jbossdm.ServerGroup>
    Server groups defined in domain
      Public properties
     
     
    cliScriptPrefix: STRING = jboss-cli
    JBoss CLI script prefix. Depending on the host, either an '.sh' or '.bat' will be appended to get the cli script name.
     
     
    home: STRING
    JBoss home directory
     
     
    port: INTEGER = 9999
    TCP port which is used to login to JBoss Native Administration, default is 9999
     
     
    adminHostAddress: STRING = localhost
    Host which is used to login to JBoss Native Administration, default is localhost
     
     
    commandExecutionMode: ENUM [CLI_COMMANDS, CLI_FILE] = CLI_COMMANDS
    Command execution mode when daemon is disabled. Commands can be executed directly against remote jboss CLI process using --commands option (CLI_COMMANDS) or they can be uploaded to a temporary file and executed using --file option (CLI_FILE). By default it is set to CLI_COMMANDS, but if you have special characters like '{}[]=@()' set it to the CLI_FILE value
     
     
    enableDaemon: BOOLEAN = true
    Connection to CLI is setup using a daemon. Set it to false if connection to the host does not support streaming.
     
     
    password: STRING
    Password which is used to login to JBoss Native Administration.
     
     
    tags: SET_OF_STRING
    If set, only deployables with the same tag will be automatically mapped to this container.
     
     
    username: STRING
    Username which is used to login to JBoss Native Administration.
      Hidden properties
     
     
    daemonConnectTimeout: INTEGER = 300000
    Connection read timeout for CLI daemon boot up.
     
     
    libraries: LIST_OF_STRING = [jboss/dm/library/runtime.py]
    List of python library scripts that should be automatically loaded when using a JBoss CLI script

    jbossdm.Ear

    Type Hierarchy jee.Ear >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.ArchiveArtifact, udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable

    A JEE EAR archive

      Public properties
     
     
    checksum: STRING
    The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
     
     
    credentials: CI<credentials.Credentials>
    Credentials of the URI.
     
     
    excludeFileNamesRegex: STRING
    Regular expression that matches file names that must be excluded from scanning
     
     
    fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
    A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
     
     
    fileUri: STRING
    The URI pointing to the (remote) location of the file this artifact represents
     
     
    isRescanned: BOOLEAN
    Indicates if the artifact has been rescanned
     
     
    placeholders: SET_OF_STRING
    Placeholders detected in this artifact
     
     
    preScannedPlaceholders: BOOLEAN
    Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
     
     
    proxySettings: CI<credentials.ProxySettings>
    Proxy Settings for artifact location
     
     
    scanPlaceholders: BOOLEAN
    Whether to scan this artifact to replace placeholders when it is imported
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
      Hidden properties
     
     
    textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
    Regular expression that matches file names of text files
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.
     
     
    delimiters: STRING = {{ }}
    The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter

    jbossdm.EarModule

    Type Hierarchy jbossdm.CliManagedDeployedArtifact >> jbossdm.CliManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer

    Ear with values configured for a deployment

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    placeholders: MAP_STRING_STRING
    A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
      Hidden properties
     
     
    createOrder: INTEGER = 70
    The order of the step in the step list for the create operation.
     
     
    createScript: STRING = jboss/dm/application/install-ear.py
    Classpath to the script that is uploaded and executed on the generic container for the create operation.
     
     
    createVerb: STRING = Create
    Create Verb
     
     
    destroyOrder: INTEGER = 30
    The order of the step in the step list for the destroy operation.
     
     
    destroyScript: STRING = jboss/dm/application/uninstall-ear.py
    Classpath to the script that is uploaded and executed on the generic container for the destroy operation.
     
     
    destroyVerb: STRING = Destroy
    Destroy Verb
     
     
    inspectScript: STRING = jboss/dm/application/inspect-ear.py
    Classpath to the script used to inspect the generic container.
     
     
    libraries: LIST_OF_STRING = [jboss/dm/application/application-lib.py]
    List of python library scripts that should be automatically loaded when using a JBoss CLI script.
     
     
    modifyOrder: INTEGER = 70
    The order of the step in the step list for the modify operation.
     
     
    modifyVerb: STRING = Modify
    Modify Verb
     
     
    noopOrder: INTEGER = 50
    The order of the step in the step list for the noop operation.
     
     
    noopVerb: STRING = Modify
    Noop Verb
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
     
     
    modifyScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the modify operation.
     
     
    noopScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the noop operation.

    jbossdm.EjbJar

    Type Hierarchy jee.EjbJar >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.ArchiveArtifact, udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable

    A JEE EJBJAR archive

      Public properties
     
     
    checksum: STRING
    The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
     
     
    credentials: CI<credentials.Credentials>
    Credentials of the URI.
     
     
    excludeFileNamesRegex: STRING
    Regular expression that matches file names that must be excluded from scanning
     
     
    fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
    A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
     
     
    fileUri: STRING
    The URI pointing to the (remote) location of the file this artifact represents
     
     
    isRescanned: BOOLEAN
    Indicates if the artifact has been rescanned
     
     
    placeholders: SET_OF_STRING
    Placeholders detected in this artifact
     
     
    preScannedPlaceholders: BOOLEAN
    Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
     
     
    proxySettings: CI<credentials.ProxySettings>
    Proxy Settings for artifact location
     
     
    scanPlaceholders: BOOLEAN
    Whether to scan this artifact to replace placeholders when it is imported
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
      Hidden properties
     
     
    textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
    Regular expression that matches file names of text files
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.
     
     
    delimiters: STRING = {{ }}
    The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter

    jbossdm.EjbJarModule

    Type Hierarchy jbossdm.CliManagedDeployedArtifact >> jbossdm.CliManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer

    EJbJar with values configured for a deployment

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    placeholders: MAP_STRING_STRING
    A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
      Hidden properties
     
     
    createOrder: INTEGER = 70
    The order of the step in the step list for the create operation.
     
     
    createScript: STRING = jboss/dm/application/install-ejbjar.py
    Classpath to the script that is uploaded and executed on the generic container for the create operation.
     
     
    createVerb: STRING = Create
    Create Verb
     
     
    destroyOrder: INTEGER = 30
    The order of the step in the step list for the destroy operation.
     
     
    destroyScript: STRING = jboss/dm/application/uninstall-ejbjar.py
    Classpath to the script that is uploaded and executed on the generic container for the destroy operation.
     
     
    destroyVerb: STRING = Destroy
    Destroy Verb
     
     
    inspectScript: STRING = jboss/dm/application/inspect-ejbjar.py
    Classpath to the script used to inspect the generic container.
     
     
    libraries: LIST_OF_STRING = [jboss/dm/application/application-lib.py]
    List of python library scripts that should be automatically loaded when using a JBoss CLI script.
     
     
    modifyOrder: INTEGER = 70
    The order of the step in the step list for the modify operation.
     
     
    modifyVerb: STRING = Modify
    Modify Verb
     
     
    noopOrder: INTEGER = 50
    The order of the step in the step list for the noop operation.
     
     
    noopVerb: STRING = Modify
    Noop Verb
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
     
     
    modifyScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the modify operation.
     
     
    noopScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the noop operation.

    jbossdm.JeeDataSource

    Type Hierarchy jbossdm.BaseDataSource >> jbossdm.CliManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    Datasource. This deployed is used when a jee.DataSourceSpec is specified in a package.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    connectionUrl: STRING
    The JDBC driver connection URL
     
     
    driverName: STRING
    Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit.
     
     
    jndiName: STRING
    Specifies the JNDI name for the datasource
     
     
    backgroundValidation: BOOLEAN
    An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
     
     
    checkValidSql: STRING
    Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool
     
     
    connectionProperties: MAP_STRING_STRING
    JDBC connection properties
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    exceptionSorter: STRING
    An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error
     
     
    maxPoolSize: INTEGER
    The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool
     
     
    minPoolSize: INTEGER
    The min-pool-size element specifies the minimum number of connections for a pool
     
     
    newConnectionSql: STRING
    Specifies an SQL statement to execute whenever a connection is added to the connection pool
     
     
    password: STRING
    Specifies the password used when creating a new connection
     
     
    prefillEnabled: BOOLEAN
    Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
     
     
    securityDomain: STRING
    Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool
     
     
    sharePreparedStatements: BOOLEAN
    Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement
     
     
    staleConnectionChecker: STRING
    An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException
     
     
    statementCacheSize: INTEGER = -1
    The number of prepared statements per connection in an LRU cache
     
     
    strictMinimum: BOOLEAN
    Specifies if the min-pool-size should be considered strictly
     
     
    transactionIsolation: STRING
    Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE
     
     
    useCcm: BOOLEAN
    Enable the use of a cached connection manager
     
     
    useJta: BOOLEAN
    Enable JTA integration
     
     
    username: STRING
    Specify the user name used when creating a new connection
     
     
    validConnectionChecker: STRING
    An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element
     
     
    validateOnMatch: BOOLEAN
    The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation
     
     
    validationMillis: INTEGER = -1
    The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise
      Hidden properties
     
     
    createOrder: INTEGER = 60
    The order of the step in the step list for the create operation.
     
     
    createScript: STRING = jboss/dm/ds/create-datasource.py
    Classpath to the script that is uploaded and executed on the generic container for the create operation.
     
     
    createVerb: STRING = Create
    Create Verb
     
     
    destroyOrder: INTEGER = 40
    The order of the step in the step list for the destroy operation.
     
     
    destroyScript: STRING = jboss/dm/ds/destroy-datasource.py
    Classpath to the script that is uploaded and executed on the generic container for the destroy operation.
     
     
    destroyVerb: STRING = Destroy
    Destroy Verb
     
     
    inspectScript: STRING = jboss/dm/ds/inspect-datasource.py
    Classpath to the script used to inspect the generic container.
     
     
    libraries: LIST_OF_STRING = [jboss/dm/ds/datasource-lib.py]
    List of python library scripts that should be automatically loaded when using a JBoss CLI script.
     
     
    modifyOrder: INTEGER = 60
    The order of the step in the step list for the modify operation.
     
     
    modifyVerb: STRING = Modify
    Modify Verb
     
     
    noopOrder: INTEGER = 50
    The order of the step in the step list for the noop operation.
     
     
    noopVerb: STRING = Modify
    Noop Verb
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
     
     
    modifyScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the modify operation.
     
     
    noopScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the noop operation.

    jbossdm.JeeDataSourceSpec

    Virtual Type
    Type Hierarchy jee.DataSourceSpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.Deployable, udm.Taggable

    Description unavailable

      Public properties
     
     
    jndiName: STRING
    Name used to lookup this resource in JNDI
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    jbossdm.JeeXaDataSource

    Type Hierarchy jbossdm.BaseDataSource >> jbossdm.CliManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    XA DataSource. This deployed is used when a jee.DataSourceSpec is specified in a package.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    driverName: STRING
    Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit.
     
     
    jndiName: STRING
    Specifies the JNDI name for the datasource
     
     
    xaProperties: MAP_STRING_STRING
    Properties to assign to the XADataSource implementation class. At least one XA property is required (i.e. url)
     
     
    backgroundValidation: BOOLEAN
    An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
     
     
    checkValidSql: STRING
    Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    exceptionSorter: STRING
    An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error
     
     
    interleave: BOOLEAN
    An element to enable interleaving for XA connections
     
     
    maxPoolSize: INTEGER
    The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool
     
     
    minPoolSize: INTEGER
    The min-pool-size element specifies the minimum number of connections for a pool
     
     
    newConnectionSql: STRING
    Specifies an SQL statement to execute whenever a connection is added to the connection pool
     
     
    padXid: BOOLEAN
    Should the Xid be padded
     
     
    password: STRING
    Specifies the password used when creating a new connection
     
     
    prefillEnabled: BOOLEAN
    Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
     
     
    sameRmOverride: BOOLEAN
    The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false
     
     
    securityDomain: STRING
    Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool
     
     
    sharePreparedStatements: BOOLEAN
    Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement
     
     
    staleConnectionChecker: STRING
    An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException
     
     
    statementCacheSize: INTEGER = -1
    The number of prepared statements per connection in an LRU cache
     
     
    strictMinimum: BOOLEAN
    Specifies if the min-pool-size should be considered strictly
     
     
    transactionIsolation: STRING
    Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE
     
     
    username: STRING
    Specify the user name used when creating a new connection
     
     
    validConnectionChecker: STRING
    An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element
     
     
    validateOnMatch: BOOLEAN
    The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation
     
     
    validationMillis: INTEGER = -1
    The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise
     
     
    wrapXa: BOOLEAN
    Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance
      Hidden properties
     
     
    createOrder: INTEGER = 60
    The order of the step in the step list for the create operation.
     
     
    createScript: STRING = jboss/dm/ds/create-xa-datasource.py
    Classpath to the script that is uploaded and executed on the generic container for the create operation.
     
     
    createVerb: STRING = Create
    Create Verb
     
     
    destroyOrder: INTEGER = 40
    The order of the step in the step list for the destroy operation.
     
     
    destroyScript: STRING = jboss/dm/ds/destroy-xa-datasource.py
    Classpath to the script that is uploaded and executed on the generic container for the destroy operation.
     
     
    destroyVerb: STRING = Destroy
    Destroy Verb
     
     
    inspectScript: STRING = jboss/dm/ds/inspect-xa-datasource.py
    Classpath to the script used to inspect the generic container.
     
     
    libraries: LIST_OF_STRING = [jboss/dm/ds/datasource-lib.py]
    List of python library scripts that should be automatically loaded when using a JBoss CLI script.
     
     
    modifyOrder: INTEGER = 60
    The order of the step in the step list for the modify operation.
     
     
    modifyVerb: STRING = Modify
    Modify Verb
     
     
    noopOrder: INTEGER = 50
    The order of the step in the step list for the noop operation.
     
     
    noopVerb: STRING = Modify
    Noop Verb
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
     
     
    modifyScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the modify operation.
     
     
    noopScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the noop operation.

    jbossdm.Profile

    Type Hierarchy udm.BaseContainer >> udm.BaseConfigurationItem
    Interfaces jbossdm.CliManagedContainer, udm.Container, overthere.HostContainer, jbossdm.ResourceContainer, udm.Taggable

    JBoss Profile

      Parent
     
     
    domain: CI<jbossdm.Domain>
    Domain to which the server group belongs.
      Public properties
     
     
    tags: SET_OF_STRING
    If set, only deployables with the same tag will be automatically mapped to this container.

    jbossdm.Queue

    Type Hierarchy jbossdm.CliManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    A Jboss Queue

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    jndiName: STRING
    (Comma separated list) The jndi names the queue will be bound to.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    durable: BOOLEAN = true
    Whether the queue is durable or not
     
     
    selector: STRING
    The queue selector
      Hidden properties
     
     
    createOrder: INTEGER = 60
    The order of the step in the step list for the create operation.
     
     
    createScript: STRING = jboss/dm/jms/create-queue.py
    Classpath to the script that is uploaded and executed on the generic container for the create operation.
     
     
    createVerb: STRING = Create
    Create Verb
     
     
    destroyOrder: INTEGER = 40
    The order of the step in the step list for the destroy operation.
     
     
    destroyScript: STRING = jboss/dm/jms/destroy-queue.py
    Classpath to the script that is uploaded and executed on the generic container for the destroy operation.
     
     
    destroyVerb: STRING = Destroy
    Destroy Verb
     
     
    inspectScript: STRING = jboss/dm/jms/inspect-queue.py
    Classpath to the script used to inspect the generic container.
     
     
    modifyOrder: INTEGER = 60
    The order of the step in the step list for the modify operation.
     
     
    modifyVerb: STRING = Modify
    Modify Verb
     
     
    noopOrder: INTEGER = 50
    The order of the step in the step list for the noop operation.
     
     
    noopVerb: STRING = Modify
    Noop Verb
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
     
     
    libraries: LIST_OF_STRING
    List of python library scripts that should be automatically loaded when using a JBoss CLI script.
     
     
    modifyScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the modify operation.
     
     
    noopScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the noop operation.

    jbossdm.QueueSpec

    Type Hierarchy jee.QueueSpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.Deployable, udm.Taggable

    A Queue

      Public properties
     
     
    durable: STRING
    Whether the queue is durable or not (boolean) default(true)
     
     
    jndiName: STRING
    (Comma separated list) The jndi names the queue will be bound to. (string)
     
     
    selector: STRING
    The queue selector (string)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    jbossdm.ServerGroup

    Type Hierarchy udm.BaseContainer >> udm.BaseConfigurationItem
    Interfaces jbossdm.ApplicationContainer, jbossdm.CliManagedContainer, udm.Container, overthere.HostContainer, udm.Taggable

    JBoss Server Group

      Parent
     
     
    domain: CI<jbossdm.Domain>
    Domain to which the server group belongs.
      Public properties
     
     
    tags: SET_OF_STRING
    If set, only deployables with the same tag will be automatically mapped to this container.

    jbossdm.StandaloneServer

    Type Hierarchy jbossdm.CliBasedContainer >> udm.BaseContainer >> udm.BaseConfigurationItem
    Interfaces jbossdm.ApplicationContainer, jbossdm.CliManagedContainer, jbossdm.CliManagingContainer, udm.Container, overthere.HostContainer, jbossdm.ResourceContainer, udm.Taggable

    JBoss Standalone Server

      Parent
     
     
    host: CI<overthere.Host>
    Host
      Public properties
     
     
    cliScriptPrefix: STRING = jboss-cli
    JBoss CLI script prefix. Depending on the host, either an '.sh' or '.bat' will be appended to get the cli script name.
     
     
    home: STRING
    JBoss home directory
     
     
    port: INTEGER = 9999
    TCP port which is used to login to JBoss Native Administration, default is 9999
     
     
    adminHostAddress: STRING = localhost
    Host which is used to login to JBoss Native Administration, default is localhost
     
     
    commandExecutionMode: ENUM [CLI_COMMANDS, CLI_FILE] = CLI_COMMANDS
    Command execution mode when daemon is disabled. Commands can be executed directly against remote jboss CLI process using --commands option (CLI_COMMANDS) or they can be uploaded to a temporary file and executed using --file option (CLI_FILE). By default it is set to CLI_COMMANDS, but if you have special characters like '{}[]=@()' set it to the CLI_FILE value
     
     
    enableDaemon: BOOLEAN = true
    Connection to CLI is setup using a daemon. Set it to false if connection to the host does not support streaming.
     
     
    password: STRING
    Password which is used to login to JBoss Native Administration.
     
     
    tags: SET_OF_STRING
    If set, only deployables with the same tag will be automatically mapped to this container.
     
     
    username: STRING
    Username which is used to login to JBoss Native Administration.
      Hidden properties
     
     
    daemonConnectTimeout: INTEGER = 300000
    Connection read timeout for CLI daemon boot up.
     
     
    libraries: LIST_OF_STRING = [jboss/dm/library/runtime.py]
    List of python library scripts that should be automatically loaded when using a JBoss CLI script

    jbossdm.Topic

    Type Hierarchy jbossdm.CliManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    A JBoss topic

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    jndiName: STRING
    (Comma separated list) The jndi names the topic will be bound to.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
      Hidden properties
     
     
    createOrder: INTEGER = 60
    The order of the step in the step list for the create operation.
     
     
    createScript: STRING = jboss/dm/jms/create-topic.py
    Classpath to the script that is uploaded and executed on the generic container for the create operation.
     
     
    createVerb: STRING = Create
    Create Verb
     
     
    destroyOrder: INTEGER = 40
    The order of the step in the step list for the destroy operation.
     
     
    destroyScript: STRING = jboss/dm/jms/destroy-topic.py
    Classpath to the script that is uploaded and executed on the generic container for the destroy operation.
     
     
    destroyVerb: STRING = Destroy
    Destroy Verb
     
     
    inspectScript: STRING = jboss/dm/jms/inspect-topic.py
    Classpath to the script used to inspect the generic container.
     
     
    modifyOrder: INTEGER = 60
    The order of the step in the step list for the modify operation.
     
     
    modifyVerb: STRING = Modify
    Modify Verb
     
     
    noopOrder: INTEGER = 50
    The order of the step in the step list for the noop operation.
     
     
    noopVerb: STRING = Modify
    Noop Verb
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
     
     
    libraries: LIST_OF_STRING
    List of python library scripts that should be automatically loaded when using a JBoss CLI script.
     
     
    modifyScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the modify operation.
     
     
    noopScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the noop operation.

    jbossdm.TopicSpec

    Type Hierarchy jee.TopicSpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.Deployable, udm.Taggable

    A Topic

      Public properties
     
     
    jndiName: STRING
    (Comma separated list) The jndi names the topic will be bound to. (string)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    jbossdm.War

    Type Hierarchy jee.War >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.ArchiveArtifact, udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable

    A JEE WAR archive

      Public properties
     
     
    checksum: STRING
    The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
     
     
    contextRoot: STRING
    Context root for the web application (string)
     
     
    credentials: CI<credentials.Credentials>
    Credentials of the URI.
     
     
    excludeFileNamesRegex: STRING
    Regular expression that matches file names that must be excluded from scanning
     
     
    fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
    A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
     
     
    fileUri: STRING
    The URI pointing to the (remote) location of the file this artifact represents
     
     
    isRescanned: BOOLEAN
    Indicates if the artifact has been rescanned
     
     
    placeholders: SET_OF_STRING
    Placeholders detected in this artifact
     
     
    preScannedPlaceholders: BOOLEAN
    Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
     
     
    proxySettings: CI<credentials.ProxySettings>
    Proxy Settings for artifact location
     
     
    scanPlaceholders: BOOLEAN
    Whether to scan this artifact to replace placeholders when it is imported
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
      Hidden properties
     
     
    textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
    Regular expression that matches file names of text files
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.
     
     
    delimiters: STRING = {{ }}
    The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter

    jbossdm.WarModule

    Type Hierarchy jbossdm.CliManagedDeployedArtifact >> jbossdm.CliManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer

    War with values configured for a deployment

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    contextRoot: STRING
    Context root for the web application
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    placeholders: MAP_STRING_STRING
    A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
      Hidden properties
     
     
    createOrder: INTEGER = 70
    The order of the step in the step list for the create operation.
     
     
    createScript: STRING = jboss/dm/application/install-war.py
    Classpath to the script that is uploaded and executed on the generic container for the create operation.
     
     
    createVerb: STRING = Create
    Create Verb
     
     
    destroyOrder: INTEGER = 30
    The order of the step in the step list for the destroy operation.
     
     
    destroyScript: STRING = jboss/dm/application/uninstall-war.py
    Classpath to the script that is uploaded and executed on the generic container for the destroy operation.
     
     
    destroyVerb: STRING = Destroy
    Destroy Verb
     
     
    inspectScript: STRING = jboss/dm/application/inspect-war.py
    Classpath to the script used to inspect the generic container.
     
     
    libraries: LIST_OF_STRING = [jboss/dm/application/application-lib.py]
    List of python library scripts that should be automatically loaded when using a JBoss CLI script.
     
     
    modifyOrder: INTEGER = 70
    The order of the step in the step list for the modify operation.
     
     
    modifyVerb: STRING = Modify
    Modify Verb
     
     
    noopOrder: INTEGER = 50
    The order of the step in the step list for the noop operation.
     
     
    noopVerb: STRING = Modify
    Noop Verb
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
     
     
    modifyScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the modify operation.
     
     
    noopScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the noop operation.

    jbossdm.XaDataSource

    Type Hierarchy jbossdm.JeeXaDataSource >> jbossdm.BaseDataSource >> jbossdm.CliManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    XA DataSource. This deployed is used when a jbossdm.XaDataSourceSpec is specified in a package.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    driverName: STRING
    Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit.
     
     
    jndiName: STRING
    Specifies the JNDI name for the datasource
     
     
    xaProperties: MAP_STRING_STRING
    Properties to assign to the XADataSource implementation class. At least one XA property is required (i.e. url)
     
     
    backgroundValidation: BOOLEAN
    An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
     
     
    checkValidSql: STRING
    Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    exceptionSorter: STRING
    An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error
     
     
    interleave: BOOLEAN
    An element to enable interleaving for XA connections
     
     
    maxPoolSize: INTEGER
    The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool
     
     
    minPoolSize: INTEGER
    The min-pool-size element specifies the minimum number of connections for a pool
     
     
    newConnectionSql: STRING
    Specifies an SQL statement to execute whenever a connection is added to the connection pool
     
     
    padXid: BOOLEAN
    Should the Xid be padded
     
     
    password: STRING
    Specifies the password used when creating a new connection
     
     
    prefillEnabled: BOOLEAN
    Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
     
     
    sameRmOverride: BOOLEAN
    The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false
     
     
    securityDomain: STRING
    Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool
     
     
    sharePreparedStatements: BOOLEAN
    Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement
     
     
    staleConnectionChecker: STRING
    An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException
     
     
    statementCacheSize: INTEGER = -1
    The number of prepared statements per connection in an LRU cache
     
     
    strictMinimum: BOOLEAN
    Specifies if the min-pool-size should be considered strictly
     
     
    transactionIsolation: STRING
    Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE
     
     
    username: STRING
    Specify the user name used when creating a new connection
     
     
    validConnectionChecker: STRING
    An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element
     
     
    validateOnMatch: BOOLEAN
    The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation
     
     
    validationMillis: INTEGER = -1
    The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise
     
     
    wrapXa: BOOLEAN
    Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance
      Hidden properties
     
     
    createOrder: INTEGER = 60
    The order of the step in the step list for the create operation.
     
     
    createScript: STRING = jboss/dm/ds/create-xa-datasource.py
    Classpath to the script that is uploaded and executed on the generic container for the create operation.
     
     
    createVerb: STRING = Create
    Create Verb
     
     
    destroyOrder: INTEGER = 40
    The order of the step in the step list for the destroy operation.
     
     
    destroyScript: STRING = jboss/dm/ds/destroy-xa-datasource.py
    Classpath to the script that is uploaded and executed on the generic container for the destroy operation.
     
     
    destroyVerb: STRING = Destroy
    Destroy Verb
     
     
    inspectScript: STRING = jboss/dm/ds/inspect-xa-datasource.py
    Classpath to the script used to inspect the generic container.
     
     
    libraries: LIST_OF_STRING = [jboss/dm/ds/datasource-lib.py]
    List of python library scripts that should be automatically loaded when using a JBoss CLI script.
     
     
    modifyOrder: INTEGER = 60
    The order of the step in the step list for the modify operation.
     
     
    modifyVerb: STRING = Modify
    Modify Verb
     
     
    noopOrder: INTEGER = 50
    The order of the step in the step list for the noop operation.
     
     
    noopVerb: STRING = Modify
    Noop Verb
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
     
     
    modifyScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the modify operation.
     
     
    noopScript: STRING
    Classpath to the script that is uploaded and executed on the generic container for the noop operation.

    jbossdm.XaDataSourceSpec

    Type Hierarchy jbossdm.JeeDataSourceSpec >> jee.DataSourceSpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.Deployable, udm.Taggable

    XA DataSource. This deployed is used when a jbossdm.XaDataSourceSpec is specified in a package. (deployable)

      Public properties
     
     
    backgroundValidation: STRING
    An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise. (boolean) default(false)
     
     
    checkValidSql: STRING
    Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool (string)
     
     
    driverName: STRING
    Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit. (string)
     
     
    exceptionSorter: STRING
    An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error (string)
     
     
    interleave: STRING
    An element to enable interleaving for XA connections (boolean) default(false)
     
     
    jndiName: STRING
    Specifies the JNDI name for the datasource (string)
     
     
    maxPoolSize: STRING
    The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool (integer)
     
     
    minPoolSize: STRING
    The min-pool-size element specifies the minimum number of connections for a pool (integer)
     
     
    newConnectionSql: STRING
    Specifies an SQL statement to execute whenever a connection is added to the connection pool (string)
     
     
    padXid: STRING
    Should the Xid be padded (boolean) default(false)
     
     
    password: STRING
    Specifies the password used when creating a new connection (string)
     
     
    prefillEnabled: STRING
    Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise. (boolean) default(false)
     
     
    sameRmOverride: STRING
    The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false (boolean) default(false)
     
     
    securityDomain: STRING
    Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool (string)
     
     
    sharePreparedStatements: STRING
    Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement (boolean)
     
     
    staleConnectionChecker: STRING
    An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException (string)
     
     
    statementCacheSize: STRING
    The number of prepared statements per connection in an LRU cache (integer) default(-1)
     
     
    strictMinimum: STRING
    Specifies if the min-pool-size should be considered strictly (boolean) default(false)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    transactionIsolation: STRING
    Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE (string)
     
     
    username: STRING
    Specify the user name used when creating a new connection (string)
     
     
    validConnectionChecker: STRING
    An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element (string)
     
     
    validateOnMatch: STRING
    The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation (boolean) default(false)
     
     
    validationMillis: STRING
    The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise (integer) default(-1)
     
     
    wrapXa: STRING
    Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance (boolean) default(false)
     
     
    xaProperties: MAP_STRING_STRING
    Properties to assign to the XADataSource implementation class. At least one XA property is required (i.e. url) (map_string_string)
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    Step Reference

    jboss-cli

    Description

    The jboss-cli step executes a Python script that controls the JBoss/WildFly server jboss-cli command-line interface utility. The script executes on top of a thin Python wrapper library that provides convenient functions for executing jboss-cli commands, logging, and so on.

    Examples

    This is an example of a jboss-cli step that will deploy an application:

    <jboss-cli>
        <order>60</order>
        <description expression="true">"Deploying application '%s'" % deployed.name</description>
        <script>jboss/dm/application/install-ear.py</script>
        <python-context>
            <container expression="true">deployed.container</container>
        </python-context>
        <additional-libraries>
            <value>jboss/dm/application/application-lib.py</value>
        </additional-libraries>
    </jboss-cli>
    

    Note: The jboss/dm/application/install-ear.py and jboss/dm/application/application-lib.py scripts are provided with the jbossdm-plugin.

    To create the same step with a script rule:

    context.addStep(steps.jboss_cli(
        order = 60,
        description = "Deploying application '%s'" % deployed.name,
        script = "jboss/dm/application/install-ear.py",
        python_context = { "container": deployed.container },
        additional_libraries = ["jboss/dm/application/application-lib.py"],
    upload_artifacts_in_python_context = True
    ))
    

    The following xl-rules.xml file disables the existing Java-based rule and triggers the new rule:

    <rules xmlns="http://www.xebialabs.com/xl-deploy/xl-rules">
    
        <disable-rule name="jbossdm.EarModule.executeCreate_CREATE" />
    
        <rule name="jbossdm.EarModule.CREATE" scope="deployed">
            <conditions>
                <type>jbossdm.EarModule</type>
                <operation>CREATE</operation>
            </conditions>
            <steps>
                <jboss-cli>
                    <order>60</order>
                    <script>jboss/dm/application/install-ear.py</script>
                    <python-context>
                        <container expression="true">deployed.container</container>
                    </python-context>
                    <additional-libraries>
                        <value>jboss/dm/application/application-lib.py</value>
                    </additional-libraries>
                </jboss-cli>
            </steps>
        </rule>
    </rules>
    

    Handling artifacts

    Without the jboss-cli step, scripts must use the uploadFile function to upload a file to the target container. With the jboss-cli step, all variables of type udm.Artifact are uploaded to the target container host. The file property is updated with a reference to a remote OverthereFile. This allows you to access staged or automatically uploaded artifacts bound to the jboss-cli Python context.

    For example, the deployed is automatically bound to the Python context. The parameter uploadArtifactsInPythonContext is enabled by default, so the deployed artifact will be uploaded to the target container and deployed.file will be updated with a reference to the remote OverthereFile. If staging was enabled, deployed.file contains a reference to the staged OverthereFile.

    Thus, deployed.file.path will return the path on the target container and not on the filesystem where the XL Deploy server runs.

    To manually control the upload, set uploadArtifactsInPythonContext to false and use uploadFile function.

    Instead of:

    uploadedEar = uploadFile(deployed.file, appName)
    errMsg = executeCmd("deploy %s %s" % (uploadedEar.path, targetServerGroups()))
    

    You can use use:

    errMsg = executeCmd("deploy %s %s" % (deployed.file.path, targetServerGroups()))
    

    This behaviour is enabled by default and can be disabled via the uploadArtifactsInPythonContext parameter.

    Available functions

    Some of the functions from the wrapper layer are described below. For a full listing of available functions, see the jboss/dm/library/runtime.py file.

    executeCmd

    Executes the jboss-cli command on the target domain.

    Parameters:

    • cmd - command to execute
    • exitOnFailure - should the function exit in case of failure (defaults to True)
    logOutput

    Logs the info message to the step output.

    Parameters:

    • msg - message to log
    logError

    Logs the error message to the step output.

    Parameters:

    • msg - message to log
    uploadFile

    Uploads the file to the remote working directory and returns OverthereFile.

    Parameters:

    • file - file to upload
    • targetName - target file name in a remote working directory

    Calculated step parameters

    Container

    The container parameter of a step is calculated as follows:

    • If the scope is deployed:
    • In other cases, container cannot be automatically calculated and must be specified manually.

    Step Parameters

    ParameterTypeDescriptionRequiredCalculated
    additional-librariesListList of python library scripts that should be automatically loaded when using a JBoss CLI script. Usage of additional script libraries is discouraged, please use proper Python modules.NoYes
    containerCliManagedContainerCLI managed container (domain, standalone server, profile or managed group) where to execute the cli scriptYesYes
    descriptionStringDescription of this step, as it should appear in generated deployment plansYesYes
    orderIntegerExecution order of the stepYesYes
    python-contextMapDictionary that represent context available to the python scriptNoYes
    scriptStringPath to the python script to be executed.YesNo
    upload-artifacts-in-python-contextBooleanIf true, artifacts from the python context will be uploaded to the target host and available to the script as .file (of type OverthereFile). Defaults to true. If set to false it will prevent staging.YesNo
    Note: For information about how values are calculated, refer to Use a predefined step in a rule.