Preface

This document describes the functionality provided by the JBoss Domain (JBoss AS 7.1+, JBoss EAP 6) plugin.

See the Deployit Reference Manual for background information on Deployit and deployment concepts.

Overview

The JBoss Domain plugin is a Deployit plugin that adds the capability to manage deployments and resources on JBoss application server 7.1+ or JBoss EAP 6. The plugin has the capability of managing application artifacts, datasource and other JMS resources via the JBoss Cli, and can easily be extended to support more deployment options or management of new artifacts/resources on JBoss AS.

Features

  • Domain and Standalone mode support
  • Deployment of application artifacts
    • Enterprise application (EAR)
    • Web application (WAR)
  • Deployment of resources
    • Datasource including XA Datasource
    • JMS Queue
    • JMS Topic
  • Discovery of Profiles and ServerGroups in Domain

Requirements

  • Deployit requirements

    • Deployit: version 3.7+
    • Jython: jython-standalone-2.5.1.jar installed in <DEPLOYIT_SERVER_HOME>/lib

  • Infrastructural requirements

    • JBoss AS versions: 7.1+
    • JBoss EAP versions: 6.x
    • User credentials for accessing the Host and JBoss Cli.

Usage in Deployment Packages

The plugin works with the standard deployment package of DAR format. Please see the Packaging Manual for more details about the DAR format and the ways to compose one.

The following is a sample MANIFEST.MF file that can be used to create a JBoss AS specific deployment package. It contains declarations for an Ear, a datasource and a couple of JMS resources.


Manifest-Version: 1.0
Deployit-Package-Format-Version: 1.3
CI-Application: SampleApp
CI-Version: 1.0

Name: PetClinic-1.0.ear
CI-Name: PetClinic
CI-Type: jee.Ear

Name: testDatasource
CI-Type: jbossdm.DatasourceSpec
CI-jndiName: jdbc/sampleDatasource
CI-connectionUrl: jdbc:mysql://localhost/test
CI-driverName: mysql
CI-username: {{DATABASE_USERNAME}}
CI-password: {{DATABASE_PASSWORD}}

Name: testQueue
CI-Type: jbossdm.QueueSpec
CI-jndiName: jms/testQueue

Name: testTopic
CI-Type: jbossdm.TopicSpec
CI-jndiName: jms/testTopic

Using the deployables and deployeds

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

Deployable vs. Container table

Deployable Container Generated deployed
jee.Ear
jbossdm.Ear		 jbossdm.ApplicationContainer jbossdm.EarModule
jee.War
jbossdm.War		 jbossdm.ApplicationContainer jbossdm.WarModule
jee.DataSourceSpec jbossdm.ResourceContainer jbossdm.JeeXaDataSource
jbossdm.JeeDataSource
jbossdm.XaDataSourceSpec jbossdm.ResourceContainer jbossdm.XaDataSource
jbossdm.DataSourceSpec jbossdm.ResourceContainer jbossdm.Datasource
jee.QueueSpec
jbossdm.QueueSpec		 jbossdm.ResourceContainer jbossdm.Queue
jee.TopicSpec
jbossdm.TopicSpec		 jbossdm.ResourceContainer jbossdm.Topic

The following table describes the effect a deployed has on it's container

Deployed Actions Table

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

Deploying applications

Note that the plugin uses the JBoss Cli to (un)install artifacts and resources. As such, the plugin assumes that the JBoss Domain or Standalone server has already been started. The plugin does not support the starting of the domain or standalone server prior to a deployment.

Standalone Mode

Artifacts (war, ear) and resources (datasources, queues, topics, etc) can be targeted to a StandaloneServer.

Domain Mode

Artifacts (war, ear) can be targeted to either a Domain or ServerGroup. When targeted to a domain, the artifacts are (un)installed on all server groups defined for the domain. For specific targetting of artifacts to certain server groups, you can define the server groups in your environment.

Resources (datasources, queues, topics, etc) can be targeted to either a Domain or Profile. When targeted to a domain, the resources are (un)installed in the "default" profile. For specific targetting of resources to certain profiles, you can define the profiles in your environment.

Discovery

The plugin supports the discovery of Profiles and Server Groups in a Domain.

Here is an example CLI script which discovers a sample Domain:

host = repository.create(factory.configurationItem('Infrastructure/jboss-host', 'overthere.SshHost',
    {'connectionType':'SFTP','address': 'jboss-7','username': 'root','password':'centos','os':'UNIX'}))
jboss = factory.configurationItem('Infrastructure/jboss-host/jboss-domain', 'jbossdm.Domain',
    {'home':'/opt/jboss/7', 'host':'Infrastructure/jboss-host', 'username':"jbossAdmin", "password":"jboss"})
cis = deployit.discover(jboss)
print cis

#discovery just discovers the topology and keeps the configuration items in memory. Save them in Deployit repository
repository.create(cis)

Few things to note about the above discovery example:

  • JBoss Domain has a containment relation with a Host (created under a Host), so the server id has been kept as 'Infrastructure/jboss-host/jboss-domain'

Extension points

The plugin is designed to be extended through Deployit's Plugin API type system and jython. The plugin wraps the JBoss Cli with a jython runtime environment, thus allowing extenders to interact with JBoss and Deployit from the script. Note that the jython script is executed on the Deployit Server itself and has full access to the following Deployit objects :

  • deployed: The current deployed object on which the operation has been triggered.
  • step: The step object that the script is being executed from. Exposes an overthere remote connection for file manipulation and a method to execute JBoss Cli commands.
  • container: The container object to which the deployed is targeted to.
  • delta: The delta specification that lead to the script being executed.
  • deployedApplication: The entire deployed application.

The plugin associates Create, Modify, Destroy, Noop and Inspect operations received from Deployit with jython scripts that need to be executed for the specific operation to be performed.

There also exists an advanced method to extend the plugin, but the implementation of this form of extension needs to be written in the Java programming language and consists of writing so-called Deployed contributors, PlanPreProcessors and Contributors.

Please refer to the Customization Manual for a detailed explanation of the type system and advanced methods of customization of plugins. Also refer to the Overthere documentation for working with remote files.

Extending the plugin to support JDBC Driver deployment

In this example we will deploy a jdbc driver jar to a Domain or StandaloneServer as a module and register the driver with JBoss datasources subsystem.

Define the deployed and deployable to represent a JDBC Driver

The following synthetic.xml snippet shows the definition of the JDBC Driver deployed. The deployed will be targeted to a Domain or a StandaloneServer. Please refer to the CI reference section of this document to understand the interfaces and class hierarchy of these types.

<type type="jbossdm.JdbcDriverModule" extends="jbossdm.CliManagedDeployedArtifact" 
      deployable-type="jbossdm.JdbcDriver" container-type="jbossdm.CliManagingContainer">
  <generate-deployable type="jbossdm.JdbcDriver" extends="udm.BaseDeployableArchiveArtifact">

  <property name="driverName"/>
  <property name="driverModuleName"/>
  <property name="driverXaDatasourceClassName/>

  <!-- hidden properties to specify the jython scripts to execute for an operation -->
  <property name="createScript" default="jboss/dm/ds/create-jdbc-driver.py" hidden="true"/>
</type>

Defined the create-jdbc-driver.py

from com.xebialabs.overthere.util import OverthereUtils

#create module directory to copy jar and module.xml to
driverModuleName = deployed.getProperty("driverModuleName")
moduleRelPath = driverModuleName.replaceAll("\\.","/")
moduleAbsolutePath = "%s/modules/%s" % (container.getProperty("home"), moduleRelPath)
moduleDir = step.getRemoteConnection().getFile(moduleAbsolutePath);
moduleDir.mkdirs();
#upload jar
moduleJar = moduleDir.getFile(deployed.file.getName())
deployed.file.copyTo(moduleJar)

moduleXmlContent = """
 <?xml version="1.0" encoding="UTF-8"?>
 <module xmlns="urn:jboss:module:1.0" name="%s">
    <resources>
       <resource-root path="%s"/>
    </resources>
    <dependencies>
       <module name="javax.api"/>
        <module name="javax.transaction.api"/>
    </dependencies>
 </module>
 """ % (deployed.getProperty("driverModuleName"), deployed.file.getName())

#create module.xml
moduleXml = moduleDir.getFile("module.xml")
OverthereUtils.write(moduleXlContent.getBytes(),moduleXml)

#register driver with the datasource subsystem
driverName = deployed.getProperty("driveName")
xaClassName = deployed.getProperty("driverXaDatasourceClassName")
cmd = '/subsystem=datasources/jdbc-driver=%s:add(driver-name="%s",driver-module-name="%s",driver-xa-datasource-class-name="%s")'      % (driverName, driverName, driverModuleName, xaClasName)
cmd = prependProfilePath(cmd) #prefix with profile if deploying to domain
executeCmd(cmd)  #used to execute a JBoss Cli command.

Extending the plugin with custom control task

The plugin has the capability to add control tasks to CliManagedDeployed or CliManagedContainer. The control task can be specified as a jython script that will be executed on the Deployit Server or as an OS shell script that will be run on the target host. The OS shell script is first processed with FreeMarker before being executed.

Creating a jython based control task to list jdbc drivers in a StandaloneServer

Synthetic.xml snippet

<type-modification type="jbossdm.StandaloneServer">
  <property name="listJdbcDriversPythonTaskScript" hidden="true" default="jboss/dm/container/list-jdbc-drivers.py"/>
  <!-- Note "PythonTaskScript" is appended to the method name to determine the script to run. -->
  <method name="listJdbcDrivers"/>
</type>

list-jdbc-drivers.py snippet

drivers = executeCmd("/subsystem=datasources:installed-drivers-list")
logOutput(drivers)  #outputs to the step log

Start the StandaloneServer

Synthetic.xml snippet

<type-modification type="jbossdm.StandaloneServer">
  <property name="startShellTaskScript" hidden="true" default="jboss/dm/container/start-standalone"/>
  <!-- Note "ShellTaskScript" is appended to the method name to determine the script to run. -->
  <method name="start"/>
</type>

start-standalone.sh snippet

nohup ${container.home}/bin/standalone.sh >>nohup.out 2>&1 &
sleep 2
echo background process to start standalone server executed.

CI Reference

Configuration Item Overview

Deployable Configuration Items

CIDescription
jbossdm.DataSourceSpecDataSource
jbossdm.EarA JEE EAR archive
jbossdm.QueueSpecA Queue
jbossdm.TopicSpecA Topic
jbossdm.WarA JEE WAR archive
jbossdm.XaDataSourceSpecXA DataSource

Deployed Configuration Items

CIDescription
jbossdm.DataSourceDataSource
jbossdm.EarModuleEar with values configured for a deployment
jbossdm.JeeDataSourceDatasource
jbossdm.JeeXaDataSourceXA DataSource
jbossdm.QueueA Jboss Queue
jbossdm.TopicA JBoss topic
jbossdm.WarModuleWar with values configured for a deployment
jbossdm.XaDataSourceXA DataSource

Topology Configuration Items

CIDescription
jbossdm.DomainJBoss Cli Managed Container
jbossdm.ProfileJBoss Profile
jbossdm.ServerGroupJBoss Server Group
jbossdm.StandaloneServerJBoss Standalone Server

Virtual Deployed Configuration Items

CIDescription
jbossdm.BaseDataSourceBase definition of a DataSource
jbossdm.CliManagedDeployedBase for all deployed that utilize the JBoss Cli for configuration
jbossdm.CliManagedDeployedArtifactBase for all deployed artifacts that utilize the JBoss Cli for configuration

Virtual Topology Configuration Items

CIDescription
jbossdm.CliBasedContainerJBoss Cli Managed Container

Configuration Item Details

jbossdm.BaseDataSource

Hierarchyjbossdm.CliManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfacesudm.Deployed, udm.ConfigurationItem

Base definition of a DataSource

Public Properties
container  : CI<udm.Container>

The container on which this deployed runs.
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 = false

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 = 0

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 = 0

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 = false

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 = false

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 = false

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 = 50

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]

Libraries
modifyOrder  : INTEGER = 50

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
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

Hierarchyudm.BaseContainer >> udm.BaseConfigurationItem
Interfacesudm.Taggable, jbossdm.CliManagedContainer, jbossdm.ApplicationContainer, jbossdm.ResourceContainer, udm.ConfigurationItem, jbossdm.CliManagingContainer, udm.Container, overthere.HostContainer

JBoss Cli Managed Container

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
host  : CI<overthere.Host>

Host
adminHostAddress : STRING = localhost

Host which is used to login to JBoss Native Administration, default is localhost
enableDaemon : BOOLEAN = true

Connection to CLI is setup using a daemon. Set to false if host connection does not support streaming.
password : STRING

Password which is used to login to JBoss Native Administration.
port : INTEGER = 9999

TCP port which is used to login to JBoss Native Administration, default is 9999
tags : SET_OF_STRING

The tags to map deployables to containers.
username : STRING

Username which is used to login to JBoss Native Administration.
Hidden Properties
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

Hierarchyudm.BaseDeployed >> udm.BaseConfigurationItem
Interfacesudm.Deployed, udm.ConfigurationItem

Base for all deployed that utilize the JBoss Cli for configuration

Public Properties
container  : CI<udm.Container>

The container on which this deployed runs.
deployable : CI<udm.Deployable>

The deployable that this deployed is derived from.
Hidden Properties
createOrder  : INTEGER = 50

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 = 50

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
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

Hierarchyjbossdm.CliManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfacesudm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

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

Public Properties
container  : CI<udm.Container>

The container on which this deployed runs.
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 = 50

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 = 50

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
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

Hierarchyjbossdm.JeeDataSource >> jbossdm.BaseDataSource >> jbossdm.CliManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfacesudm.Deployed, udm.ConfigurationItem

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

Public Properties
connectionUrl  : STRING

The JDBC driver connection URL
container  : CI<udm.Container>

The container on which this deployed runs.
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 = false

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 = 0

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 = 0

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 = false

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 = false

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 = false

Enable the use of a cached connection manager
useJta : BOOLEAN = false

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 = false

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 = 50

The order of the step in the step list for the create operation.
createScript  : STRING = jboss/dm/ds/create-datasource.py

Create Script
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

Destroy Script
destroyVerb  : STRING = Destroy

Destroy Verb
inspectScript  : STRING = jboss/dm/ds/inspect-datasource.py

Inspect Script
libraries  : LIST_OF_STRING = [jboss/dm/ds/datasource-lib.py]

Libraries
modifyOrder  : INTEGER = 50

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
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

Hierarchyjee.DataSourceSpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfacesudm.Taggable, udm.Deployable, udm.ConfigurationItem

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)
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)
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)
strictMinimum : STRING

Specifies if the min-pool-size should be considered strictly (boolean)
tags : SET_OF_STRING

The tags to map deployables to containers.
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)
useJta : STRING

Enable JTA integration (boolean)
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)
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)

jbossdm.Domain

Hierarchyjbossdm.CliBasedContainer >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfacesudm.Taggable, jbossdm.CliManagedContainer, jbossdm.ApplicationContainer, jbossdm.ResourceContainer, udm.ConfigurationItem, udm.Container, jbossdm.CliManagingContainer, overthere.HostContainer

JBoss Cli Managed Container

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
host  : CI<overthere.Host>

Host
adminHostAddress : STRING = localhost

Host which is used to login to JBoss Native Administration, default is localhost
enableDaemon : BOOLEAN = true

Connection to CLI is setup using a daemon. Set to false if host connection does not support streaming.
password : STRING

Password which is used to login to JBoss Native Administration.
port : INTEGER = 9999

TCP port which is used to login to JBoss Native Administration, default is 9999
profiles : LIST_OF_CI<jbossdm.Profile>

Profiles defined in domain
serverGroups : LIST_OF_CI<jbossdm.ServerGroup>

Server groups defined in domain
tags : SET_OF_STRING

The tags to map deployables to containers.
username : STRING

Username which is used to login to JBoss Native Administration.
Hidden Properties
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

Hierarchyjee.Ear >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfacesudm.Taggable, udm.Deployable, udm.SourceArtifact, udm.ArchiveArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

A JEE EAR archive

Public Properties
excludeFileNamesRegex : STRING

Regular expression that matches file names that must be excluded from scanning
placeholders : SET_OF_STRING

Placeholders detected in this artifact
scanPlaceholders : BOOLEAN = true

Scan Placeholders
tags : SET_OF_STRING

The tags to map deployables to containers.
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

jbossdm.EarModule

Hierarchyjbossdm.CliManagedDeployedArtifact >> jbossdm.CliManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfacesudm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Ear with values configured for a deployment

Public Properties
container  : CI<udm.Container>

The container on which this deployed runs.
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 = 50

The order of the step in the step list for the create operation.
createScript  : STRING = jboss/dm/application/install-ear.py

Create Script
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/application/uninstall-ear.py

Destroy Script
destroyVerb  : STRING = Destroy

Destroy Verb
inspectScript  : STRING = jboss/dm/application/inspect-ear.py

Inspect Script
libraries  : LIST_OF_STRING = [jboss/dm/application/application-lib.py]

Libraries
modifyOrder  : INTEGER = 50

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
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

Hierarchyjbossdm.BaseDataSource >> jbossdm.CliManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfacesudm.Deployed, udm.ConfigurationItem

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

Public Properties
connectionUrl  : STRING

The JDBC driver connection URL
container  : CI<udm.Container>

The container on which this deployed runs.
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 = false

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 = 0

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 = 0

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 = false

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 = false

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 = false

Enable the use of a cached connection manager
useJta : BOOLEAN = false

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 = false

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 = 50

The order of the step in the step list for the create operation.
createScript  : STRING = jboss/dm/ds/create-datasource.py

Create Script
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

Destroy Script
destroyVerb  : STRING = Destroy

Destroy Verb
inspectScript  : STRING = jboss/dm/ds/inspect-datasource.py

Inspect Script
libraries  : LIST_OF_STRING = [jboss/dm/ds/datasource-lib.py]

Libraries
modifyOrder  : INTEGER = 50

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
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.JeeXaDataSource

Hierarchyjbossdm.BaseDataSource >> jbossdm.CliManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfacesudm.Deployed, udm.ConfigurationItem

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

Public Properties
container  : CI<udm.Container>

The container on which this deployed runs.
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 = false

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 = false

An element to enable interleaving for XA connections
maxPoolSize : INTEGER = 0

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 = 0

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 = false

Should the Xid be padded
password : STRING

Specifies the password used when creating a new connection
prefillEnabled : BOOLEAN = false

Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
sameRmOverride : BOOLEAN = false

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 = false

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 = false

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 = false

Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance
Hidden Properties
createOrder  : INTEGER = 50

The order of the step in the step list for the create operation.
createScript  : STRING = jboss/dm/ds/create-xa-datasource.py

Create Script
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

Destroy Script
destroyVerb  : STRING = Destroy

Destroy Verb
inspectScript  : STRING = jboss/dm/ds/inspect-xa-datasource.py

Inspect Script
libraries  : LIST_OF_STRING = [jboss/dm/ds/datasource-lib.py]

Libraries
modifyOrder  : INTEGER = 50

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
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

Hierarchyudm.BaseContainer >> udm.BaseConfigurationItem
Interfacesudm.Taggable, jbossdm.CliManagedContainer, jbossdm.ResourceContainer, udm.ConfigurationItem, udm.Container, overthere.HostContainer

JBoss Profile

Public Properties
domain  : CI<jbossdm.Domain>

Domain to which the server group belongs.
tags : SET_OF_STRING

The tags to map deployables to containers.

jbossdm.Queue

Hierarchyjbossdm.CliManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfacesudm.Deployed, udm.ConfigurationItem

A Jboss Queue

Public Properties
container  : CI<udm.Container>

The container on which this deployed runs.
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 = 50

The order of the step in the step list for the create operation.
createScript  : STRING = jboss/dm/jms/create-queue.py

Create Script
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

Destroy Script
destroyVerb  : STRING = Destroy

Destroy Verb
inspectScript  : STRING = jboss/dm/jms/inspect-queue.py

Inspect Script
modifyOrder  : INTEGER = 50

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
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

Hierarchyjee.QueueSpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfacesudm.Taggable, udm.Deployable, udm.ConfigurationItem

A Queue

Public Properties
durable : STRING

Whether the queue is durable or not (boolean)
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

The tags to map deployables to containers.

jbossdm.ServerGroup

Hierarchyudm.BaseContainer >> udm.BaseConfigurationItem
Interfacesudm.Taggable, jbossdm.CliManagedContainer, jbossdm.ApplicationContainer, udm.ConfigurationItem, udm.Container, overthere.HostContainer

JBoss Server Group

Public Properties
domain  : CI<jbossdm.Domain>

Domain to which the server group belongs.
tags : SET_OF_STRING

The tags to map deployables to containers.

jbossdm.StandaloneServer

Hierarchyjbossdm.CliBasedContainer >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfacesudm.Taggable, jbossdm.CliManagedContainer, jbossdm.ApplicationContainer, jbossdm.ResourceContainer, udm.ConfigurationItem, udm.Container, jbossdm.CliManagingContainer, overthere.HostContainer

JBoss Standalone Server

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
host  : CI<overthere.Host>

Host
adminHostAddress : STRING = localhost

Host which is used to login to JBoss Native Administration, default is localhost
enableDaemon : BOOLEAN = true

Connection to CLI is setup using a daemon. Set to false if host connection does not support streaming.
password : STRING

Password which is used to login to JBoss Native Administration.
port : INTEGER = 9999

TCP port which is used to login to JBoss Native Administration, default is 9999
tags : SET_OF_STRING

The tags to map deployables to containers.
username : STRING

Username which is used to login to JBoss Native Administration.
Hidden Properties
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

Hierarchyjbossdm.CliManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfacesudm.Deployed, udm.ConfigurationItem

A JBoss topic

Public Properties
container  : CI<udm.Container>

The container on which this deployed runs.
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 = 50

The order of the step in the step list for the create operation.
createScript  : STRING = jboss/dm/jms/create-topic.py

Create Script
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

Destroy Script
destroyVerb  : STRING = Destroy

Destroy Verb
inspectScript  : STRING = jboss/dm/jms/inspect-topic.py

Inspect Script
modifyOrder  : INTEGER = 50

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
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

Hierarchyjee.TopicSpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfacesudm.Taggable, udm.Deployable, udm.ConfigurationItem

A Topic

Public Properties
jndiName : STRING

(Comma separated list) The jndi names the topic will be bound to. (string)
tags : SET_OF_STRING

The tags to map deployables to containers.

jbossdm.War

Hierarchyjee.War >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfacesudm.Taggable, udm.Deployable, udm.SourceArtifact, udm.ArchiveArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

A JEE WAR archive

Public Properties
contextRoot : STRING

Context root for the web application (string)
excludeFileNamesRegex : STRING

Regular expression that matches file names that must be excluded from scanning
placeholders : SET_OF_STRING

Placeholders detected in this artifact
scanPlaceholders : BOOLEAN = true

Scan Placeholders
tags : SET_OF_STRING

The tags to map deployables to containers.
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

jbossdm.WarModule

Hierarchyjbossdm.CliManagedDeployedArtifact >> jbossdm.CliManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfacesudm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

War with values configured for a deployment

Public Properties
container  : CI<udm.Container>

The container on which this deployed runs.
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 = 50

The order of the step in the step list for the create operation.
createScript  : STRING = jboss/dm/application/install-war.py

Create Script
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/application/uninstall-war.py

Destroy Script
destroyVerb  : STRING = Destroy

Destroy Verb
inspectScript  : STRING = jboss/dm/application/inspect-war.py

Inspect Script
libraries  : LIST_OF_STRING = [jboss/dm/application/application-lib.py]

Libraries
modifyOrder  : INTEGER = 50

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
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

Hierarchyjbossdm.JeeXaDataSource >> jbossdm.BaseDataSource >> jbossdm.CliManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfacesudm.Deployed, udm.ConfigurationItem

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

Public Properties
container  : CI<udm.Container>

The container on which this deployed runs.
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 = false

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 = false

An element to enable interleaving for XA connections
maxPoolSize : INTEGER = 0

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 = 0

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 = false

Should the Xid be padded
password : STRING

Specifies the password used when creating a new connection
prefillEnabled : BOOLEAN = false

Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
sameRmOverride : BOOLEAN = false

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 = false

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 = false

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 = false

Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance
Hidden Properties
createOrder  : INTEGER = 50

The order of the step in the step list for the create operation.
createScript  : STRING = jboss/dm/ds/create-xa-datasource.py

Create Script
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

Destroy Script
destroyVerb  : STRING = Destroy

Destroy Verb
inspectScript  : STRING = jboss/dm/ds/inspect-xa-datasource.py

Inspect Script
libraries  : LIST_OF_STRING = [jboss/dm/ds/datasource-lib.py]

Libraries
modifyOrder  : INTEGER = 50

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
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

Hierarchyjee.DataSourceSpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfacesudm.Taggable, udm.Deployable, udm.ConfigurationItem

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)
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)
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)
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)
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)
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)
strictMinimum : STRING

Specifies if the min-pool-size should be considered strictly (boolean)
tags : SET_OF_STRING

The tags to map deployables to containers.
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)
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)
wrapXa : STRING

Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance (boolean)
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)
Copyright XebiaLabs B.V. 2009-2012. All rights reserved.