JBoss Application Server Plugin Reference

The XL Deploy JBoss Application Server (AS) plugin allows you to manage deployments and resources on a JBoss Application Server.

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

Requirements

XL Deploy 5.0.0 or later
JBoss Application Server 4.x, 5.x, or 6.x
User credentials for accessing the host running the JBoss Application Server
JBoss installed as a service when running on Microsoft Windows (refer to the JBoss Native guide for information about installing JBoss as a service)

Using the deployables and deployeds

Deployable vs. container table

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

Deployable	Container	Generated deployed
Application artifact: jee.Ear jee.War	Server	jbossas.EarModule jbossas.WarModule
jbossas.TransactionalDatasourceSpec jbossas.TransactionalXADatasourceSpec jbossas.NonTransactionalDatasourceSpec	Server	jbossas.TransactionalDatasource jbossas.TransactionalXADatasource jbossas.NonTransactionalDatasource
jbossas.QueueSpec	Server	jbossas.Queue
jbossas.TopicSpec	Server	jbossas.Topic
jbossas.ConfigurationFile	Server	jbossas.DeployedConfigurationFile
jbossas.ConfigurationFolder	Server	jbossas.DeployedConfigurationFolder

Deployed actions table

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

Deployed	Actions performed for operations
	Create	Destroy	Modify
jbossas.EarModule jbossas.WarModule	stop Server deploy application start Server	stop Server undeploy old application version start Server	stop Server undeploy old application version deploy new application version start Server
jbossas.TransactionalDatasource jbossas.TransactionalXADatasource jbossas.NonTransactionalDatasource	create datasource	destroy datasource	destroy datasource create modified datasource
jbossas.Queue	stop Server create Queue start Server	stop Server destroy Queue start Server	stop Server destroy Queue create modified Queue start Server
jbossas.Topic	stop Server create Topic start Server	stop Server destroy Topic start Server	stop Server destroy Topic create modified Topic start Server
jbossas.DeployedConfigurationFile	stop Server deploying config files start Server	stop Server undeploy config files start Server	stop Server undeploy config files deploy new config files start Server
jbossas.DeployedConfigurationFolder	stop Server deploying configuration folder start Server	stop Server undeploy configuration folder start Server	stop Server undeploy configuration folder deploy new configuration folder start Server

Release Notes - JBoss AS Plugin

Version 5.0.0

new XL Deploy plugin format

Improvements

[DEPL-6989] - Make JBOSS-AS plugin Satellite Aware

Version 4.0.0

Improvements

[DEPL-5901] - Added support for XL Deploy 4.0.0

Version 3.9.0

Improvements

[DEPL-4431] - Added jbossas.EjbJar type for EJB deployments.

Version 3.8.1

Improvements

[DEPL-2887] - Added support for starting and stopping JBoss on Windows when installed as a service.

Bug fixes

[DEPL-4037] - Made restartRequired property optional to get rid of warning when Deployit starts up.
[DEPL-3829] - Incorrect exit code when server not stopped.

Version 3.8.0

Improvements

[DEPL-3520] - Added support for XA datasource properties.

Bug fixes

[DEPL-3631] - JBoss datasource cannot handle list_of_string properties.
[DEPL-3647] - Fixed serialization of task.
[DEPL-3648] - Fixed serialization of task.
[DEPL-3732] - jbossas.BaseServer should be a virtual type.

Version 3.7.0

Bug fixes

[DEPL-2266] - TwiddleStep in jboss plugin should clean up open connections.
[DEPL-2604] - jbossas.DataSourceSpec should be removed.
[DEPL-2605] - JBoss is not restarted after deployment of a datasource.
[DEPL-2682] - Jboss plugin stop.sh script fails for localhost. It assumes that the host is always remote.

Version 3.6.0

Bug fixes

[DEPL-2266] - TwiddleStep in jboss plugin should clean up open connections.
[DEPL-2604] - jbossas.DataSourceSpec should be removed.
[DEPL-2605] - JBoss is not restarted after deployment of a datasource.
[DEPL-2682] - Jboss plugin stop.sh script fails for localhost. It assumes that the host is always remote.

CI Reference

Configuration Item Overview

Deployables

CI	Description
jbossas.ConfigurationFile	File containing application configurations that is deployed to the server conf directory
jbossas.ConfigurationFolder	Folder containing files for application configuration that are deployed to the server conf directory
jbossas.Ear	A JEE EAR archive
jbossas.EjbJar	A JEE EjbJar archive
jbossas.Library	null (deployable)
jbossas.NonTransactionalDatasourceSpec	null (deployable)
jbossas.QueueSpec	Specification for a JBoss queue
jbossas.TopicSpec	Specification for a JBoss topic
jbossas.TransactionalDatasourceSpec	null (deployable)
jbossas.TransactionalXADatasourceSpec	null (deployable)
jbossas.War	A JEE WAR archive

Deployeds

CI	Description
jbossas.Artifact	Base type for a JBoss artifact
jbossas.Configuration	Base type for a JBoss configuration
jbossas.Datasource	Base type for a JBoss datasource
jbossas.DeployedConfigurationFile	Deployed configuration file
jbossas.DeployedConfigurationFolder	Deployed configuration folder
jbossas.DeployedLibrary	The Library as deployed on the jboss server
jbossas.EarModule	Ear with values configured for a deployment
jbossas.EjbJarModule	EjbJar with values configured for a deployment
jbossas.NonTransactionalDatasource	A JBoss No Transaction Datasource
jbossas.Queue	A JBoss Queue
jbossas.Resource	Description unavailable
jbossas.Topic	A JBoss topic
jbossas.TransactionalDatasource	A JBoss Local Transaction Datasource
jbossas.TransactionalXADatasource	A JBoss XA Datasource
jbossas.WarModule	War with values configured for a deployment

Containers

CI	Description
jbossas.BaseServer	Base JBoss Application Server
jbossas.ServerV4	Jboss 4 application server
jbossas.ServerV5	Jboss 5 application server
jbossas.ServerV6	Jboss 6 application server

Other Configuration Items

CI	Description
jbossas.Artifact	Base type for a JBoss artifact
jbossas.BaseServer	Base JBoss Application Server
jbossas.Configuration	Base type for a JBoss configuration
jbossas.ConfigurationFile	File containing application configurations that is deployed to the server conf directory
jbossas.ConfigurationFolder	Folder containing files for application configuration that are deployed to the server conf directory
jbossas.Datasource	Base type for a JBoss datasource
jbossas.DeployedConfigurationFile	Deployed configuration file
jbossas.DeployedConfigurationFolder	Deployed configuration folder
jbossas.DeployedLibrary	The Library as deployed on the jboss server
jbossas.Ear	A JEE EAR archive
jbossas.EarModule	Ear with values configured for a deployment
jbossas.EjbJar	A JEE EjbJar archive
jbossas.EjbJarModule	EjbJar with values configured for a deployment
jbossas.Library	null (deployable)
jbossas.NonTransactionalDatasource	A JBoss No Transaction Datasource
jbossas.NonTransactionalDatasourceSpec	null (deployable)
jbossas.Queue	A JBoss Queue
jbossas.QueueSpec	Specification for a JBoss queue
jbossas.Resource	Description unavailable
jbossas.ServerV4	Jboss 4 application server
jbossas.ServerV5	Jboss 5 application server
jbossas.ServerV6	Jboss 6 application server
jbossas.Topic	A JBoss topic
jbossas.TopicSpec	Specification for a JBoss topic
jbossas.TransactionalDatasource	A JBoss Local Transaction Datasource
jbossas.TransactionalDatasourceSpec	null (deployable)
jbossas.TransactionalXADatasource	A JBoss XA Datasource
jbossas.TransactionalXADatasourceSpec	null (deployable)
jbossas.War	A JEE WAR archive
jbossas.WarModule	War with values configured for a deployment

Configuration Item Details

jbossas.Artifact

Virtual Type
Type Hierarchy	generic.CopiedArtifact >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem

Base type for a JBoss artifact.

		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>
		targetFile : STRING
		Name of the artifact on the generic server.

		Hidden Properties
		createOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER = 50
		The order of the step in the step list for the create operation.
		createVerb : STRING = Deploy
		Create Verb
		destroyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		destroyOrder : INTEGER = 40
		The order of the step in the step list for the destroy operation.
		destroyVerb : STRING = Undeploy
		Destroy Verb
		modifyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		modifyOrder : INTEGER = 50
		The order of the step in the step list for the modify operation.
		modifyVerb : STRING = Update
		Modify Verb
		noopOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		noopOrder : INTEGER = 50
		The order of the step in the step list for the noop operation.
		noopVerb : STRING = Modify
		Noop Verb
		targetDirectory : STRING = ${deployed.container.home}/server/${deployed.container.serverName}/deploy
		Path to which artifact must be copied to on the generic server.
		copyDirectlyToTargetPath : BOOLEAN = false
		If set to true, files are directly copied to the target directory without first being uploaded to the staging or temporary directory (like versions of XL Deploy prior to 4.0.0)
		createTargetDirectory : BOOLEAN = false
		Create the target directory on the generic server if it does not exist.
		inspectClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
		inspectScript : STRING
		Classpath to the script used to inspect the generic container.
		inspectTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		preserveExistingFiles : BOOLEAN = false
		If set to true, preserve the existing files on the remote host (do not delete the copied files during the destroy operation).
		restartRequired : BOOLEAN = true
		The generic container requires a restart for the action performed by this deployed.
		restartRequiredForNoop : BOOLEAN = false
		The generic container requires a restart for the NOOP action performed by this deployed.
		targetDirectoryShared : BOOLEAN = true
		Is the target directory shared by others on the generic server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it.
		targetPathSharedSubDirectories : BOOLEAN = false
		If set to true, the sub directories on the target machine are not deleted if files other than that copied by XL Deploy are present. Please note that setting this option to true will cause the removal process to be a slower.

jbossas.BaseServer

Virtual Type
Type Hierarchy	generic.Container >> generic.BaseGenericContainer >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces	udm.Container, overthere.HostContainer, udm.ConfigurationItem, udm.Taggable, generic.GenericContainer

Base JBoss Application Server

		Parent
		host : CI<overthere.Host>
		Host upon which the container resides

		Public Properties
		ajpPort : INTEGER = 8009
		AJP connector port
		controlPort : INTEGER = 1099
		Connector control port
		home : STRING
		JBoss application server installation directory. e.g. /opt/jboss/5.1.0.GA
		httpPort : INTEGER = 8080
		HTTP/1.1 connector port
		serverName : STRING = default
		Server configuration name e.g. default or minimal
		adminPassword : STRING
		Password of the user who connect to jboss using twiddle
		adminUsername : STRING
		Username used to connect to jboss using twiddle
		envVars : MAP_STRING_STRING
		Environment variables for container
		stopStartRestartConnection : CI<overthere.Host>
		If set, the connection settings to use to connect to the target system to execute start, stop, restart etc. operations for the container.
		tags : SET_OF_STRING
		If set, only deployables with the same tag will be automatically mapped to this container.
		windowsServiceName : STRING
		The service name under which JBoss is running. By default, XL Deploy expects JBoss to be installed as a service on Windows.

		Hidden Properties
		bindAddress : STRING = 0.0.0.0
		Address where to bind the server on starting.
		inspectTemplate : STRING = jboss/container/inspect
		Script (a freemarker template) used to inspect the server
		inspectTemplateClasspathResources : SET_OF_STRING = [twiddle-invoker.ftl, jboss/container/inspect.bat, jboss/container/inspect.sh, jboss/container/query.sh, jboss/container/query.bat]
		Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		jmsResourceFileSuffix : STRING = service
		Jms Resource File Suffix
		queryTemplate : STRING = jboss/container/query
		Script (a freemarker template) used to query a mbean value from the server
		restartOrder : INTEGER = 90
		The order of the restart container step in the step list.
		restartWaitTime : INTEGER = 0
		The time to wait in seconds for a container restart action.
		startOrder : INTEGER = 90
		The order of the start container step in the step list.
		startScript : STRING = jboss/container/start
		Script used to start the server
		startWaitTime : INTEGER = 30
		Duration (in secs) to wait after the start server step has been executed
		stopOrder : INTEGER = 10
		The order of the stop container step in the step list.
		stopScript : STRING = jboss/container/stop
		Script used to stop the server
		stopWaitTime : INTEGER = 10
		Duration (in secs) to wait after the stop server step has been executed
		inspectClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
		inspectScript : STRING
		Classpath to the script used to inspect the generic container.
		restartClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the restart script.
		restartScript : STRING
		Classpath to the script used to restart the generic container.
		restartTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the restart script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		startClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the start script.
		startOptions : STRING =
		Optional command line arguments to pass to the JBoss startup script.
		startTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the start script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		stopClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the stop script.
		stopTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the stop script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.

jbossas.Configuration

Virtual Type
Type Hierarchy	jbossas.Artifact >> generic.CopiedArtifact >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem

Base type for a JBoss 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>
		targetFile : STRING
		Name of the artifact on the generic server.

		Hidden Properties
		createOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER = 50
		The order of the step in the step list for the create operation.
		createVerb : STRING = Deploy
		Create Verb
		destroyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		destroyOrder : INTEGER = 40
		The order of the step in the step list for the destroy operation.
		destroyVerb : STRING = Undeploy
		Destroy Verb
		modifyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		modifyOrder : INTEGER = 50
		The order of the step in the step list for the modify operation.
		modifyVerb : STRING = Update
		Modify Verb
		noopOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		noopOrder : INTEGER = 50
		The order of the step in the step list for the noop operation.
		noopVerb : STRING = Modify
		Noop Verb
		targetDirectory : STRING = ${deployed.container.home}/server/${deployed.container.serverName}/conf
		Path to which artifact must be copied to on the generic server.
		copyDirectlyToTargetPath : BOOLEAN = false
		If set to true, files are directly copied to the target directory without first being uploaded to the staging or temporary directory (like versions of XL Deploy prior to 4.0.0)
		createTargetDirectory : BOOLEAN = false
		Create the target directory on the generic server if it does not exist.
		inspectClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
		inspectScript : STRING
		Classpath to the script used to inspect the generic container.
		inspectTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		preserveExistingFiles : BOOLEAN = false
		If set to true, preserve the existing files on the remote host (do not delete the copied files during the destroy operation).
		restartRequired : BOOLEAN = true
		The generic container requires a restart for the action performed by this deployed.
		restartRequiredForNoop : BOOLEAN = false
		The generic container requires a restart for the NOOP action performed by this deployed.
		targetDirectoryShared : BOOLEAN = true
		Is the target directory shared by others on the generic server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it.
		targetPathSharedSubDirectories : BOOLEAN = false
		If set to true, the sub directories on the target machine are not deleted if files other than that copied by XL Deploy are present. Please note that setting this option to true will cause the removal process to be a slower.

jbossas.ConfigurationFile

Type Hierarchy	generic.File >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact

File containing application configurations that is deployed to the server conf directory

		Public Properties
		checksum : STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		excludeFileNamesRegex : STRING
		Regular expression that matches file names that must be excluded from scanning
		fileUri : STRING
		The URI pointing to the (remote) location of the file this artifact represents
		placeholders : SET_OF_STRING
		Placeholders detected in this artifact
		scanPlaceholders : BOOLEAN = true
		Whether to scan this artifact for placeholders when it is imported
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		targetFile : STRING
		Name of the artifact on the generic server. (string)

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

jbossas.ConfigurationFolder

Type Hierarchy	generic.Folder >> udm.BaseDeployableFolderArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.FolderArtifact, udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable

Folder containing files for application configuration that are deployed to the server conf directory

		Public Properties
		checksum : STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		excludeFileNamesRegex : STRING
		Regular expression that matches file names that must be excluded from scanning
		fileUri : STRING
		The URI pointing to the (remote) location of the file this artifact represents
		placeholders : SET_OF_STRING
		Placeholders detected in this artifact
		scanPlaceholders : BOOLEAN = true
		Whether to scan this artifact for placeholders when it is imported
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		targetFile : STRING
		Name of the artifact on the generic server. (string)

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

jbossas.Datasource

Virtual Type
Type Hierarchy	jbossas.Resource >> generic.ProcessedTemplate >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Base type for a JBoss datasource

		Parent
		container : CI<udm.Container>
		The container on which this deployed runs.

		Public Properties
		jndiName : STRING
		Jndi Name
		maxPoolSize : INTEGER = 20
		Max Pool Size
		minPoolSize : INTEGER = 0
		Min Pool Size
		checkValidConnectionSql : STRING
		an sql statement that is executed before it is checked out from the pool to make sure it is still valid. If the sql fails, the connection is closed and new ones created.
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.
		exceptionSorterClassName : STRING
		a class that looks at vendor specific messages to determine whether sql errors are fatal and thus the connection should be destroyed. If none specified, no errors will be treated as fatal.
		password : STRING
		the password used when creating the connection (not used when security is configured)
		useJavaContext : BOOLEAN = true
		Use Java Context
		userName : STRING
		the user name used when creating the connection (not used when security is configured)

		Hidden Properties
		createOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER = 50
		The order of the step in the step list for the create operation.
		createVerb : STRING = Create
		Create Verb
		destroyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		destroyOrder : INTEGER = 40
		The order of the step in the step list for the destroy operation.
		destroyVerb : STRING = Destroy
		Destroy Verb
		inspectTemplate : STRING = jboss/datasource/inspect.sh.ftl
		Inspect Template
		modifyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		modifyOrder : INTEGER = 50
		The order of the step in the step list for the modify operation.
		modifyVerb : STRING = Modify
		Modify Verb
		noopOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		noopOrder : INTEGER = 50
		The order of the step in the step list for the noop operation.
		noopVerb : STRING = Modify
		Noop Verb
		targetDirectory : STRING = ${deployed.container.home}/server/${deployed.container.serverName}/deploy
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING = ${deployed.deployable.name}-ds.xml
		Name of the artifact on the generic server.
		template : STRING = jboss/datasource/template.xml.ftl
		Classpath to the freemarker template used to generate the content of the final text base artifact.
		createTargetDirectory : BOOLEAN = false
		Create the target directory on the generic server if it does not exist.
		inspectClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
		inspectScript : STRING
		Classpath to the script used to inspect the generic container.
		inspectTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		restartRequired : BOOLEAN = true
		The generic container requires a restart for the action performed by this deployed.
		restartRequiredForNoop : BOOLEAN = false
		The generic container requires a restart for the NOOP action performed by this deployed.
		targetDirectoryShared : BOOLEAN = true
		Is the target directory shared by others on the generic server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it.

jbossas.DeployedConfigurationFile

Type Hierarchy	jbossas.Configuration >> jbossas.Artifact >> generic.CopiedArtifact >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem

Deployed configuration file

		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>
		targetFile : STRING
		Name of the artifact on the generic server.

		Hidden Properties
		createOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER = 50
		The order of the step in the step list for the create operation.
		createVerb : STRING = Deploy
		Create Verb
		destroyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		destroyOrder : INTEGER = 40
		The order of the step in the step list for the destroy operation.
		destroyVerb : STRING = Undeploy
		Destroy Verb
		modifyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		modifyOrder : INTEGER = 50
		The order of the step in the step list for the modify operation.
		modifyVerb : STRING = Update
		Modify Verb
		noopOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		noopOrder : INTEGER = 50
		The order of the step in the step list for the noop operation.
		noopVerb : STRING = Modify
		Noop Verb
		targetDirectory : STRING = ${deployed.container.home}/server/${deployed.container.serverName}/conf
		Path to which artifact must be copied to on the generic server.
		copyDirectlyToTargetPath : BOOLEAN = false
		If set to true, files are directly copied to the target directory without first being uploaded to the staging or temporary directory (like versions of XL Deploy prior to 4.0.0)
		createTargetDirectory : BOOLEAN = false
		Create the target directory on the generic server if it does not exist.
		inspectClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
		inspectScript : STRING
		Classpath to the script used to inspect the generic container.
		inspectTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		preserveExistingFiles : BOOLEAN = false
		If set to true, preserve the existing files on the remote host (do not delete the copied files during the destroy operation).
		restartRequired : BOOLEAN = true
		The generic container requires a restart for the action performed by this deployed.
		restartRequiredForNoop : BOOLEAN = false
		The generic container requires a restart for the NOOP action performed by this deployed.
		targetDirectoryShared : BOOLEAN = true
		Is the target directory shared by others on the generic server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it.
		targetPathSharedSubDirectories : BOOLEAN = false
		If set to true, the sub directories on the target machine are not deleted if files other than that copied by XL Deploy are present. Please note that setting this option to true will cause the removal process to be a slower.

jbossas.DeployedConfigurationFolder

Type Hierarchy	jbossas.Configuration >> jbossas.Artifact >> generic.CopiedArtifact >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem

Deployed configuration folder

		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>
		targetFile : STRING
		Name of the artifact on the generic server.

		Hidden Properties
		createOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER = 50
		The order of the step in the step list for the create operation.
		createVerb : STRING = Deploy
		Create Verb
		destroyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		destroyOrder : INTEGER = 40
		The order of the step in the step list for the destroy operation.
		destroyVerb : STRING = Undeploy
		Destroy Verb
		modifyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		modifyOrder : INTEGER = 50
		The order of the step in the step list for the modify operation.
		modifyVerb : STRING = Update
		Modify Verb
		noopOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		noopOrder : INTEGER = 50
		The order of the step in the step list for the noop operation.
		noopVerb : STRING = Modify
		Noop Verb
		targetDirectory : STRING = ${deployed.container.home}/server/${deployed.container.serverName}/conf
		Path to which artifact must be copied to on the generic server.
		copyDirectlyToTargetPath : BOOLEAN = false
		If set to true, files are directly copied to the target directory without first being uploaded to the staging or temporary directory (like versions of XL Deploy prior to 4.0.0)
		createTargetDirectory : BOOLEAN = false
		Create the target directory on the generic server if it does not exist.
		inspectClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
		inspectScript : STRING
		Classpath to the script used to inspect the generic container.
		inspectTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		preserveExistingFiles : BOOLEAN = false
		If set to true, preserve the existing files on the remote host (do not delete the copied files during the destroy operation).
		restartRequired : BOOLEAN = true
		The generic container requires a restart for the action performed by this deployed.
		restartRequiredForNoop : BOOLEAN = false
		The generic container requires a restart for the NOOP action performed by this deployed.
		targetDirectoryShared : BOOLEAN = true
		Is the target directory shared by others on the generic server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it.
		targetPathSharedSubDirectories : BOOLEAN = false
		If set to true, the sub directories on the target machine are not deleted if files other than that copied by XL Deploy are present. Please note that setting this option to true will cause the removal process to be a slower.

jbossas.DeployedLibrary

Type Hierarchy	jbossas.Artifact >> generic.CopiedArtifact >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem

The Library as deployed on the jboss server.

		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>
		targetFile : STRING
		Name of the artifact on the generic server.

		Hidden Properties
		createOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER = 50
		The order of the step in the step list for the create operation.
		createVerb : STRING = Deploy
		Create Verb
		destroyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		destroyOrder : INTEGER = 40
		The order of the step in the step list for the destroy operation.
		destroyVerb : STRING = Undeploy
		Destroy Verb
		modifyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		modifyOrder : INTEGER = 50
		The order of the step in the step list for the modify operation.
		modifyVerb : STRING = Update
		Modify Verb
		noopOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		noopOrder : INTEGER = 50
		The order of the step in the step list for the noop operation.
		noopVerb : STRING = Modify
		Noop Verb
		targetDirectory : STRING = ${deployed.container.home}/server/${deployed.container.serverName}/lib
		Path to which artifact must be copied to on the generic server.
		copyDirectlyToTargetPath : BOOLEAN = false
		If set to true, files are directly copied to the target directory without first being uploaded to the staging or temporary directory (like versions of XL Deploy prior to 4.0.0)
		createTargetDirectory : BOOLEAN = false
		Create the target directory on the generic server if it does not exist.
		inspectClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
		inspectScript : STRING
		Classpath to the script used to inspect the generic container.
		inspectTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		preserveExistingFiles : BOOLEAN = false
		If set to true, preserve the existing files on the remote host (do not delete the copied files during the destroy operation).
		restartRequired : BOOLEAN = true
		The generic container requires a restart for the action performed by this deployed.
		restartRequiredForNoop : BOOLEAN = false
		The generic container requires a restart for the NOOP action performed by this deployed.
		targetDirectoryShared : BOOLEAN = true
		Is the target directory shared by others on the generic server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it.
		targetPathSharedSubDirectories : BOOLEAN = false
		If set to true, the sub directories on the target machine are not deleted if files other than that copied by XL Deploy are present. Please note that setting this option to true will cause the removal process to be a slower.

jbossas.Ear

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

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.
		excludeFileNamesRegex : STRING
		Regular expression that matches file names that must be excluded from scanning
		fileUri : STRING
		The URI pointing to the (remote) location of the file this artifact represents
		placeholders : SET_OF_STRING
		Placeholders detected in this artifact
		scanPlaceholders : BOOLEAN = false
		Whether to scan this artifact for 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
		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
		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

jbossas.EarModule

Type Hierarchy	jbossas.Artifact >> generic.CopiedArtifact >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem

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
		createOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER = 50
		The order of the step in the step list for the create operation.
		createVerb : STRING = Deploy
		Create Verb
		destroyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		destroyOrder : INTEGER = 40
		The order of the step in the step list for the destroy operation.
		destroyVerb : STRING = Undeploy
		Destroy Verb
		modifyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		modifyOrder : INTEGER = 50
		The order of the step in the step list for the modify operation.
		modifyVerb : STRING = Update
		Modify Verb
		noopOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		noopOrder : INTEGER = 50
		The order of the step in the step list for the noop operation.
		noopVerb : STRING = Modify
		Noop Verb
		targetDirectory : STRING = ${deployed.container.home}/server/${deployed.container.serverName}/deploy
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING = ${deployed.deployable.name}.ear
		Name of the artifact on the generic server.
		copyDirectlyToTargetPath : BOOLEAN = false
		If set to true, files are directly copied to the target directory without first being uploaded to the staging or temporary directory (like versions of XL Deploy prior to 4.0.0)
		createTargetDirectory : BOOLEAN = false
		Create the target directory on the generic server if it does not exist.
		inspectClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
		inspectScript : STRING
		Classpath to the script used to inspect the generic container.
		inspectTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		preserveExistingFiles : BOOLEAN = false
		If set to true, preserve the existing files on the remote host (do not delete the copied files during the destroy operation).
		restartRequired : BOOLEAN = true
		The generic container requires a restart for the action performed by this deployed.
		restartRequiredForNoop : BOOLEAN = false
		The generic container requires a restart for the NOOP action performed by this deployed.
		targetDirectoryShared : BOOLEAN = true
		Is the target directory shared by others on the generic server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it.
		targetPathSharedSubDirectories : BOOLEAN = false
		If set to true, the sub directories on the target machine are not deleted if files other than that copied by XL Deploy are present. Please note that setting this option to true will cause the removal process to be a slower.

jbossas.EjbJar

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

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.
		excludeFileNamesRegex : STRING
		Regular expression that matches file names that must be excluded from scanning
		fileUri : STRING
		The URI pointing to the (remote) location of the file this artifact represents
		placeholders : SET_OF_STRING
		Placeholders detected in this artifact
		scanPlaceholders : BOOLEAN = false
		Whether to scan this artifact for 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
		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
		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

jbossas.EjbJarModule

Type Hierarchy	jbossas.Artifact >> generic.CopiedArtifact >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem

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
		createOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER = 50
		The order of the step in the step list for the create operation.
		createVerb : STRING = Deploy
		Create Verb
		destroyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		destroyOrder : INTEGER = 40
		The order of the step in the step list for the destroy operation.
		destroyVerb : STRING = Undeploy
		Destroy Verb
		modifyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		modifyOrder : INTEGER = 50
		The order of the step in the step list for the modify operation.
		modifyVerb : STRING = Update
		Modify Verb
		noopOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		noopOrder : INTEGER = 50
		The order of the step in the step list for the noop operation.
		noopVerb : STRING = Modify
		Noop Verb
		targetDirectory : STRING = ${deployed.container.home}/server/${deployed.container.serverName}/deploy
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING = ${deployed.deployable.name}.jar
		Name of the artifact on the generic server.
		copyDirectlyToTargetPath : BOOLEAN = false
		If set to true, files are directly copied to the target directory without first being uploaded to the staging or temporary directory (like versions of XL Deploy prior to 4.0.0)
		createTargetDirectory : BOOLEAN = false
		Create the target directory on the generic server if it does not exist.
		inspectClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
		inspectScript : STRING
		Classpath to the script used to inspect the generic container.
		inspectTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		preserveExistingFiles : BOOLEAN = false
		If set to true, preserve the existing files on the remote host (do not delete the copied files during the destroy operation).
		restartRequired : BOOLEAN = true
		The generic container requires a restart for the action performed by this deployed.
		restartRequiredForNoop : BOOLEAN = false
		The generic container requires a restart for the NOOP action performed by this deployed.
		targetDirectoryShared : BOOLEAN = true
		Is the target directory shared by others on the generic server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it.
		targetPathSharedSubDirectories : BOOLEAN = false
		If set to true, the sub directories on the target machine are not deleted if files other than that copied by XL Deploy are present. Please note that setting this option to true will cause the removal process to be a slower.

jbossas.Library

Type Hierarchy	generic.File >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact

null (deployable)

		Public Properties
		checksum : STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		excludeFileNamesRegex : STRING
		Regular expression that matches file names that must be excluded from scanning
		fileUri : STRING
		The URI pointing to the (remote) location of the file this artifact represents
		placeholders : SET_OF_STRING
		Placeholders detected in this artifact
		scanPlaceholders : BOOLEAN = true
		Whether to scan this artifact for placeholders when it is imported
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		targetFile : STRING
		Name of the artifact on the generic server. (string)

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

jbossas.NonTransactionalDatasource

Type Hierarchy	jbossas.Datasource >> jbossas.Resource >> generic.ProcessedTemplate >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

A JBoss No Transaction Datasource

		Parent
		container : CI<udm.Container>
		The container on which this deployed runs.

		Public Properties
		connectionUrl : STRING
		the JDBC driver connection url string
		driverClass : STRING
		the JDBC driver class implementing java.sql.Driver
		jndiName : STRING
		Jndi Name
		maxPoolSize : INTEGER = 20
		Max Pool Size
		minPoolSize : INTEGER = 0
		Min Pool Size
		checkValidConnectionSql : STRING
		an sql statement that is executed before it is checked out from the pool to make sure it is still valid. If the sql fails, the connection is closed and new ones created.
		connectionProperties : MAP_STRING_STRING
		used to configure the connections retrieved from the java.sql.Driver
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.
		exceptionSorterClassName : STRING
		a class that looks at vendor specific messages to determine whether sql errors are fatal and thus the connection should be destroyed. If none specified, no errors will be treated as fatal.
		password : STRING
		the password used when creating the connection (not used when security is configured)
		useJavaContext : BOOLEAN = true
		Use Java Context
		userName : STRING
		the user name used when creating the connection (not used when security is configured)

		Hidden Properties
		createOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER = 50
		The order of the step in the step list for the create operation.
		createVerb : STRING = Create
		Create Verb
		destroyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		destroyOrder : INTEGER = 40
		The order of the step in the step list for the destroy operation.
		destroyVerb : STRING = Destroy
		Destroy Verb
		dsType : STRING = no-tx-datasource
		Ds Type
		inspectTemplate : STRING = jboss/datasource/inspect.sh.ftl
		Inspect Template
		modifyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		modifyOrder : INTEGER = 50
		The order of the step in the step list for the modify operation.
		modifyVerb : STRING = Modify
		Modify Verb
		noopOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		noopOrder : INTEGER = 50
		The order of the step in the step list for the noop operation.
		noopVerb : STRING = Modify
		Noop Verb
		targetDirectory : STRING = ${deployed.container.home}/server/${deployed.container.serverName}/deploy
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING = ${deployed.deployable.name}-ds.xml
		Name of the artifact on the generic server.
		template : STRING = jboss/datasource/template.xml.ftl
		Classpath to the freemarker template used to generate the content of the final text base artifact.
		createTargetDirectory : BOOLEAN = false
		Create the target directory on the generic server if it does not exist.
		inspectClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
		inspectScript : STRING
		Classpath to the script used to inspect the generic container.
		inspectTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		restartRequired : BOOLEAN = true
		The generic container requires a restart for the action performed by this deployed.
		restartRequiredForNoop : BOOLEAN = false
		The generic container requires a restart for the NOOP action performed by this deployed.
		targetDirectoryShared : BOOLEAN = true
		Is the target directory shared by others on the generic server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it.

jbossas.NonTransactionalDatasourceSpec

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

null (deployable)

		Public Properties
		checkValidConnectionSql : STRING
		an sql statement that is executed before it is checked out from the pool to make sure it is still valid. If the sql fails, the connection is closed and new ones created. (string)
		connectionProperties : MAP_STRING_STRING
		used to configure the connections retrieved from the java.sql.Driver (map_string_string)
		connectionUrl : STRING
		the JDBC driver connection url string (string)
		driverClass : STRING
		the JDBC driver class implementing java.sql.Driver (string)
		exceptionSorterClassName : STRING
		a class that looks at vendor specific messages to determine whether sql errors are fatal and thus the connection should be destroyed. If none specified, no errors will be treated as fatal. (string)
		jndiName : STRING
		Jndi Name (string)
		maxPoolSize : STRING
		Max Pool Size (integer) default(20)
		minPoolSize : STRING
		Min Pool Size (integer) default(0)
		password : STRING
		the password used when creating the connection (not used when security is configured) (string)
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		useJavaContext : STRING
		Use Java Context (boolean) default(true)
		userName : STRING
		the user name used when creating the connection (not used when security is configured) (string)

jbossas.Queue

Type Hierarchy	jbossas.Resource >> generic.ProcessedTemplate >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

A JBoss Queue

		Parent
		container : CI<udm.Container>
		The container on which this deployed runs.

		Public Properties
		jndiName : STRING
		Jndi Name
		maxDepth : INTEGER = 0
		Max Depth
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden Properties
		createOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER = 50
		The order of the step in the step list for the create operation.
		createVerb : STRING = Create
		Create Verb
		destroyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		destroyOrder : INTEGER = 40
		The order of the step in the step list for the destroy operation.
		destroyVerb : STRING = Destroy
		Destroy Verb
		inspectTemplate : STRING = jboss/queue/inspect.sh.ftl
		Inspect Template
		modifyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		modifyOrder : INTEGER = 50
		The order of the step in the step list for the modify operation.
		modifyVerb : STRING = Modify
		Modify Verb
		noopOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		noopOrder : INTEGER = 50
		The order of the step in the step list for the noop operation.
		noopVerb : STRING = Modify
		Noop Verb
		targetDirectory : STRING = ${deployed.container.home}/server/${deployed.container.serverName}/deploy
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING = ${deployed.deployable.name}-${deployed.container.jmsResourceFileSuffix}.xml
		Name of the artifact on the generic server.
		template : STRING = jboss/queue/template${deployed.container.version}.xml.ftl
		Classpath to the freemarker template used to generate the content of the final text base artifact.
		createTargetDirectory : BOOLEAN = false
		Create the target directory on the generic server if it does not exist.
		inspectClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
		inspectScript : STRING
		Classpath to the script used to inspect the generic container.
		inspectTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		restartRequired : BOOLEAN = true
		The generic container requires a restart for the action performed by this deployed.
		restartRequiredForNoop : BOOLEAN = false
		The generic container requires a restart for the NOOP action performed by this deployed.
		targetDirectoryShared : BOOLEAN = true
		Is the target directory shared by others on the generic server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it.

jbossas.QueueSpec

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

Specification for a JBoss queue

		Public Properties
		jndiName : STRING
		Jndi Name (string)
		maxDepth : STRING
		Max Depth (integer) default(0)
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

jbossas.Resource

Virtual Type
Type Hierarchy	generic.ProcessedTemplate >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Description unavailable

		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.
		targetFile : STRING
		Name of the artifact on the generic server.

		Hidden Properties
		createOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER = 50
		The order of the step in the step list for the create operation.
		createVerb : STRING = Create
		Create Verb
		destroyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		destroyOrder : INTEGER = 40
		The order of the step in the step list for the destroy operation.
		destroyVerb : STRING = Destroy
		Destroy Verb
		modifyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		modifyOrder : INTEGER = 50
		The order of the step in the step list for the modify operation.
		modifyVerb : STRING = Modify
		Modify Verb
		noopOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		noopOrder : INTEGER = 50
		The order of the step in the step list for the noop operation.
		noopVerb : STRING = Modify
		Noop Verb
		targetDirectory : STRING = ${deployed.container.home}/server/${deployed.container.serverName}/deploy
		Path to which artifact must be copied to on the generic server.
		template : STRING
		Classpath to the freemarker template used to generate the content of the final text base artifact.
		createTargetDirectory : BOOLEAN = false
		Create the target directory on the generic server if it does not exist.
		inspectClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
		inspectScript : STRING
		Classpath to the script used to inspect the generic container.
		inspectTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		restartRequired : BOOLEAN = true
		The generic container requires a restart for the action performed by this deployed.
		restartRequiredForNoop : BOOLEAN = false
		The generic container requires a restart for the NOOP action performed by this deployed.
		targetDirectoryShared : BOOLEAN = true
		Is the target directory shared by others on the generic server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it.

jbossas.ServerV4

Type Hierarchy	jbossas.BaseServer >> generic.Container >> generic.BaseGenericContainer >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces	udm.Container, overthere.HostContainer, udm.ConfigurationItem, udm.Taggable, generic.GenericContainer

Jboss 4 application server

		Parent
		host : CI<overthere.Host>
		Host upon which the container resides

		Public Properties
		ajpPort : INTEGER = 8009
		AJP connector port
		controlPort : INTEGER = 1099
		Connector control port
		home : STRING
		JBoss application server installation directory. e.g. /opt/jboss/5.1.0.GA
		httpPort : INTEGER = 8080
		HTTP/1.1 connector port
		serverName : STRING = default
		Server configuration name e.g. default or minimal
		adminPassword : STRING
		Password of the user who connect to jboss using twiddle
		adminUsername : STRING
		Username used to connect to jboss using twiddle
		envVars : MAP_STRING_STRING
		Environment variables for container
		stopStartRestartConnection : CI<overthere.Host>
		If set, the connection settings to use to connect to the target system to execute start, stop, restart etc. operations for the container.
		tags : SET_OF_STRING
		If set, only deployables with the same tag will be automatically mapped to this container.
		windowsServiceName : STRING
		The service name under which JBoss is running. By default, XL Deploy expects JBoss to be installed as a service on Windows.

		Hidden Properties
		bindAddress : STRING = 0.0.0.0
		Address where to bind the server on starting.
		inspectTemplate : STRING = jboss/container/inspect
		Script (a freemarker template) used to inspect the server
		inspectTemplateClasspathResources : SET_OF_STRING = [twiddle-invoker.ftl, jboss/container/inspect.bat, jboss/container/inspect.sh, jboss/container/query.sh, jboss/container/query.bat]
		Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		jmsResourceFileSuffix : STRING = service
		Jms Resource File Suffix
		queryTemplate : STRING = jboss/container/query
		Script (a freemarker template) used to query a mbean value from the server
		restartOrder : INTEGER = 90
		The order of the restart container step in the step list.
		restartWaitTime : INTEGER = 0
		The time to wait in seconds for a container restart action.
		startOrder : INTEGER = 90
		The order of the start container step in the step list.
		startScript : STRING = jboss/container/start
		Script used to start the server
		startWaitTime : INTEGER = 30
		Duration (in secs) to wait after the start server step has been executed
		stopOrder : INTEGER = 10
		The order of the stop container step in the step list.
		stopScript : STRING = jboss/container/stop
		Script used to stop the server
		stopWaitTime : INTEGER = 10
		Duration (in secs) to wait after the stop server step has been executed
		version : INTEGER = 4
		Version
		inspectClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
		inspectScript : STRING
		Classpath to the script used to inspect the generic container.
		restartClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the restart script.
		restartScript : STRING
		Classpath to the script used to restart the generic container.
		restartTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the restart script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		startClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the start script.
		startOptions : STRING =
		Optional command line arguments to pass to the JBoss startup script.
		startTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the start script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		stopClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the stop script.
		stopTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the stop script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.

jbossas.ServerV5

Type Hierarchy	jbossas.BaseServer >> generic.Container >> generic.BaseGenericContainer >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces	udm.Container, overthere.HostContainer, udm.ConfigurationItem, udm.Taggable, generic.GenericContainer

Jboss 5 application server

		Parent
		host : CI<overthere.Host>
		Host upon which the container resides

		Public Properties
		ajpPort : INTEGER = 8009
		AJP connector port
		controlPort : INTEGER = 1099
		Connector control port
		home : STRING
		JBoss application server installation directory. e.g. /opt/jboss/5.1.0.GA
		httpPort : INTEGER = 8080
		HTTP/1.1 connector port
		serverName : STRING = default
		Server configuration name e.g. default or minimal
		adminPassword : STRING
		Password of the user who connect to jboss using twiddle
		adminUsername : STRING
		Username used to connect to jboss using twiddle
		envVars : MAP_STRING_STRING
		Environment variables for container
		stopStartRestartConnection : CI<overthere.Host>
		If set, the connection settings to use to connect to the target system to execute start, stop, restart etc. operations for the container.
		tags : SET_OF_STRING
		If set, only deployables with the same tag will be automatically mapped to this container.
		windowsServiceName : STRING
		The service name under which JBoss is running. By default, XL Deploy expects JBoss to be installed as a service on Windows.

		Hidden Properties
		bindAddress : STRING = 0.0.0.0
		Address where to bind the server on starting.
		inspectTemplate : STRING = jboss/container/inspect
		Script (a freemarker template) used to inspect the server
		inspectTemplateClasspathResources : SET_OF_STRING = [twiddle-invoker.ftl, jboss/container/inspect.bat, jboss/container/inspect.sh, jboss/container/query.sh, jboss/container/query.bat]
		Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		jmsResourceFileSuffix : STRING = service
		Jms Resource File Suffix
		queryTemplate : STRING = jboss/container/query
		Script (a freemarker template) used to query a mbean value from the server
		restartOrder : INTEGER = 90
		The order of the restart container step in the step list.
		restartWaitTime : INTEGER = 0
		The time to wait in seconds for a container restart action.
		startOrder : INTEGER = 90
		The order of the start container step in the step list.
		startScript : STRING = jboss/container/start
		Script used to start the server
		startWaitTime : INTEGER = 30
		Duration (in secs) to wait after the start server step has been executed
		stopOrder : INTEGER = 10
		The order of the stop container step in the step list.
		stopScript : STRING = jboss/container/stop
		Script used to stop the server
		stopWaitTime : INTEGER = 10
		Duration (in secs) to wait after the stop server step has been executed
		version : INTEGER = 5
		Version
		inspectClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
		inspectScript : STRING
		Classpath to the script used to inspect the generic container.
		restartClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the restart script.
		restartScript : STRING
		Classpath to the script used to restart the generic container.
		restartTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the restart script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		startClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the start script.
		startOptions : STRING =
		Optional command line arguments to pass to the JBoss startup script.
		startTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the start script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		stopClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the stop script.
		stopTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the stop script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.

jbossas.ServerV6

Type Hierarchy	jbossas.BaseServer >> generic.Container >> generic.BaseGenericContainer >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces	udm.Container, overthere.HostContainer, udm.ConfigurationItem, udm.Taggable, generic.GenericContainer

Jboss 6 application server

		Parent
		host : CI<overthere.Host>
		Host upon which the container resides

		Public Properties
		ajpPort : INTEGER = 8009
		AJP connector port
		controlPort : INTEGER = 1090
		Connector control port
		home : STRING
		JBoss application server installation directory. e.g. /opt/jboss/5.1.0.GA
		httpPort : INTEGER = 8080
		HTTP/1.1 connector port
		serverName : STRING = default
		Server configuration name e.g. default or minimal
		adminPassword : STRING
		Password of the user who connect to jboss using twiddle
		adminUsername : STRING
		Username used to connect to jboss using twiddle
		envVars : MAP_STRING_STRING
		Environment variables for container
		stopStartRestartConnection : CI<overthere.Host>
		If set, the connection settings to use to connect to the target system to execute start, stop, restart etc. operations for the container.
		tags : SET_OF_STRING
		If set, only deployables with the same tag will be automatically mapped to this container.
		windowsServiceName : STRING
		The service name under which JBoss is running. By default, XL Deploy expects JBoss to be installed as a service on Windows.

		Hidden Properties
		bindAddress : STRING = 0.0.0.0
		Address where to bind the server on starting.
		inspectTemplate : STRING = jboss/container/inspect
		Script (a freemarker template) used to inspect the server
		inspectTemplateClasspathResources : SET_OF_STRING = [twiddle-invoker.ftl, jboss/container/inspect.bat, jboss/container/inspect.sh, jboss/container/query.sh, jboss/container/query.bat]
		Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		jmsResourceFileSuffix : STRING = hornetq-jms
		Jms Resource File Suffix
		queryTemplate : STRING = jboss/container/query
		Script (a freemarker template) used to query a mbean value from the server
		restartOrder : INTEGER = 90
		The order of the restart container step in the step list.
		restartWaitTime : INTEGER = 0
		The time to wait in seconds for a container restart action.
		startOrder : INTEGER = 90
		The order of the start container step in the step list.
		startScript : STRING = jboss/container/start
		Script used to start the server
		startWaitTime : INTEGER = 30
		Duration (in secs) to wait after the start server step has been executed
		stopOrder : INTEGER = 10
		The order of the stop container step in the step list.
		stopScript : STRING = jboss/container/stop
		Script used to stop the server
		stopWaitTime : INTEGER = 10
		Duration (in secs) to wait after the stop server step has been executed
		version : INTEGER = 6
		Version
		inspectClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
		inspectScript : STRING
		Classpath to the script used to inspect the generic container.
		restartClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the restart script.
		restartScript : STRING
		Classpath to the script used to restart the generic container.
		restartTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the restart script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		startClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the start script.
		startOptions : STRING =
		Optional command line arguments to pass to the JBoss startup script.
		startTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the start script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		stopClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the stop script.
		stopTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the stop script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.

jbossas.Topic

Type Hierarchy	jbossas.Resource >> generic.ProcessedTemplate >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

A JBoss topic

		Parent
		container : CI<udm.Container>
		The container on which this deployed runs.

		Public Properties
		jndiName : STRING
		Jndi Name
		maxDepth : INTEGER = 0
		Max Depth
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden Properties
		createOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER = 50
		The order of the step in the step list for the create operation.
		createVerb : STRING = Create
		Create Verb
		destroyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		destroyOrder : INTEGER = 40
		The order of the step in the step list for the destroy operation.
		destroyVerb : STRING = Destroy
		Destroy Verb
		inspectTemplate : STRING = jboss/topic/inspect.sh.ftl
		Inspect Template
		modifyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		modifyOrder : INTEGER = 50
		The order of the step in the step list for the modify operation.
		modifyVerb : STRING = Modify
		Modify Verb
		noopOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		noopOrder : INTEGER = 50
		The order of the step in the step list for the noop operation.
		noopVerb : STRING = Modify
		Noop Verb
		targetDirectory : STRING = ${deployed.container.home}/server/${deployed.container.serverName}/deploy
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING = ${deployed.deployable.name}-${deployed.container.jmsResourceFileSuffix}.xml
		Name of the artifact on the generic server.
		template : STRING = jboss/topic/template${deployed.container.version}.xml.ftl
		Classpath to the freemarker template used to generate the content of the final text base artifact.
		createTargetDirectory : BOOLEAN = false
		Create the target directory on the generic server if it does not exist.
		inspectClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
		inspectScript : STRING
		Classpath to the script used to inspect the generic container.
		inspectTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		restartRequired : BOOLEAN = true
		The generic container requires a restart for the action performed by this deployed.
		restartRequiredForNoop : BOOLEAN = false
		The generic container requires a restart for the NOOP action performed by this deployed.
		targetDirectoryShared : BOOLEAN = true
		Is the target directory shared by others on the generic server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it.

jbossas.TopicSpec

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

Specification for a JBoss topic

		Public Properties
		jndiName : STRING
		Jndi Name (string)
		maxDepth : STRING
		Max Depth (integer) default(0)
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

jbossas.TransactionalDatasource

Type Hierarchy	jbossas.Datasource >> jbossas.Resource >> generic.ProcessedTemplate >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

A JBoss Local Transaction Datasource

		Parent
		container : CI<udm.Container>
		The container on which this deployed runs.

		Public Properties
		connectionUrl : STRING
		the JDBC driver connection url string
		driverClass : STRING
		the JDBC driver class implementing java.sql.Driver
		jndiName : STRING
		Jndi Name
		maxPoolSize : INTEGER = 20
		Max Pool Size
		minPoolSize : INTEGER = 0
		Min Pool Size
		checkValidConnectionSql : STRING
		an sql statement that is executed before it is checked out from the pool to make sure it is still valid. If the sql fails, the connection is closed and new ones created.
		connectionProperties : MAP_STRING_STRING
		used to configure the connections retrieved from the java.sql.Driver
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.
		exceptionSorterClassName : STRING
		a class that looks at vendor specific messages to determine whether sql errors are fatal and thus the connection should be destroyed. If none specified, no errors will be treated as fatal.
		password : STRING
		the password used when creating the connection (not used when security is configured)
		useJavaContext : BOOLEAN = true
		Use Java Context
		userName : STRING
		the user name used when creating the connection (not used when security is configured)

		Hidden Properties
		createOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER = 50
		The order of the step in the step list for the create operation.
		createVerb : STRING = Create
		Create Verb
		destroyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		destroyOrder : INTEGER = 40
		The order of the step in the step list for the destroy operation.
		destroyVerb : STRING = Destroy
		Destroy Verb
		dsType : STRING = local-tx-datasource
		Ds Type
		inspectTemplate : STRING = jboss/datasource/inspect.sh.ftl
		Inspect Template
		modifyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		modifyOrder : INTEGER = 50
		The order of the step in the step list for the modify operation.
		modifyVerb : STRING = Modify
		Modify Verb
		noopOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		noopOrder : INTEGER = 50
		The order of the step in the step list for the noop operation.
		noopVerb : STRING = Modify
		Noop Verb
		targetDirectory : STRING = ${deployed.container.home}/server/${deployed.container.serverName}/deploy
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING = ${deployed.deployable.name}-ds.xml
		Name of the artifact on the generic server.
		template : STRING = jboss/datasource/template.xml.ftl
		Classpath to the freemarker template used to generate the content of the final text base artifact.
		createTargetDirectory : BOOLEAN = false
		Create the target directory on the generic server if it does not exist.
		inspectClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
		inspectScript : STRING
		Classpath to the script used to inspect the generic container.
		inspectTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		restartRequired : BOOLEAN = true
		The generic container requires a restart for the action performed by this deployed.
		restartRequiredForNoop : BOOLEAN = false
		The generic container requires a restart for the NOOP action performed by this deployed.
		targetDirectoryShared : BOOLEAN = true
		Is the target directory shared by others on the generic server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it.

jbossas.TransactionalDatasourceSpec

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

null (deployable)

		Public Properties
		checkValidConnectionSql : STRING
		an sql statement that is executed before it is checked out from the pool to make sure it is still valid. If the sql fails, the connection is closed and new ones created. (string)
		connectionProperties : MAP_STRING_STRING
		used to configure the connections retrieved from the java.sql.Driver (map_string_string)
		connectionUrl : STRING
		the JDBC driver connection url string (string)
		driverClass : STRING
		the JDBC driver class implementing java.sql.Driver (string)
		exceptionSorterClassName : STRING
		a class that looks at vendor specific messages to determine whether sql errors are fatal and thus the connection should be destroyed. If none specified, no errors will be treated as fatal. (string)
		jndiName : STRING
		Jndi Name (string)
		maxPoolSize : STRING
		Max Pool Size (integer) default(20)
		minPoolSize : STRING
		Min Pool Size (integer) default(0)
		password : STRING
		the password used when creating the connection (not used when security is configured) (string)
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		useJavaContext : STRING
		Use Java Context (boolean) default(true)
		userName : STRING
		the user name used when creating the connection (not used when security is configured) (string)

jbossas.TransactionalXADatasource

Type Hierarchy	jbossas.Datasource >> jbossas.Resource >> generic.ProcessedTemplate >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

A JBoss XA Datasource

		Parent
		container : CI<udm.Container>
		The container on which this deployed runs.

		Public Properties
		jndiName : STRING
		Jndi Name
		maxPoolSize : INTEGER = 20
		Max Pool Size
		minPoolSize : INTEGER = 0
		Min Pool Size
		xaDatasourceClass : STRING
		the class implementing the XADataSource
		checkValidConnectionSql : STRING
		an sql statement that is executed before it is checked out from the pool to make sure it is still valid. If the sql fails, the connection is closed and new ones created.
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.
		exceptionSorterClassName : STRING
		a class that looks at vendor specific messages to determine whether sql errors are fatal and thus the connection should be destroyed. If none specified, no errors will be treated as fatal.
		password : STRING
		the password used when creating the connection (not used when security is configured)
		trackConnectionByTx : BOOLEAN = true
		set to fix problems with Oracle (not necessarily in JBoss-5.x where it is enabled by default and the element is deprecated)
		useJavaContext : BOOLEAN = true
		Use Java Context
		userName : STRING
		the user name used when creating the connection (not used when security is configured)
		xaDatasourceProperties : MAP_STRING_STRING
		properties used to configure the XADataSource

		Hidden Properties
		createOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER = 50
		The order of the step in the step list for the create operation.
		createVerb : STRING = Create
		Create Verb
		destroyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		destroyOrder : INTEGER = 40
		The order of the step in the step list for the destroy operation.
		destroyVerb : STRING = Destroy
		Destroy Verb
		dsType : STRING = xa-datasource
		Ds Type
		inspectTemplate : STRING = jboss/datasource/inspect.sh.ftl
		Inspect Template
		modifyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		modifyOrder : INTEGER = 50
		The order of the step in the step list for the modify operation.
		modifyVerb : STRING = Modify
		Modify Verb
		noopOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		noopOrder : INTEGER = 50
		The order of the step in the step list for the noop operation.
		noopVerb : STRING = Modify
		Noop Verb
		targetDirectory : STRING = ${deployed.container.home}/server/${deployed.container.serverName}/deploy
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING = ${deployed.deployable.name}-ds.xml
		Name of the artifact on the generic server.
		template : STRING = jboss/datasource/template.xml.ftl
		Classpath to the freemarker template used to generate the content of the final text base artifact.
		createTargetDirectory : BOOLEAN = false
		Create the target directory on the generic server if it does not exist.
		inspectClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
		inspectScript : STRING
		Classpath to the script used to inspect the generic container.
		inspectTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		restartRequired : BOOLEAN = true
		The generic container requires a restart for the action performed by this deployed.
		restartRequiredForNoop : BOOLEAN = false
		The generic container requires a restart for the NOOP action performed by this deployed.
		targetDirectoryShared : BOOLEAN = true
		Is the target directory shared by others on the generic server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it.

jbossas.TransactionalXADatasourceSpec

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

null (deployable)

		Public Properties
		checkValidConnectionSql : STRING
		an sql statement that is executed before it is checked out from the pool to make sure it is still valid. If the sql fails, the connection is closed and new ones created. (string)
		exceptionSorterClassName : STRING
		a class that looks at vendor specific messages to determine whether sql errors are fatal and thus the connection should be destroyed. If none specified, no errors will be treated as fatal. (string)
		jndiName : STRING
		Jndi Name (string)
		maxPoolSize : STRING
		Max Pool Size (integer) default(20)
		minPoolSize : STRING
		Min Pool Size (integer) default(0)
		password : STRING
		the password used when creating the connection (not used when security is configured) (string)
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		trackConnectionByTx : STRING
		set to fix problems with Oracle (not necessarily in JBoss-5.x where it is enabled by default and the element is deprecated) (boolean) default(true)
		useJavaContext : STRING
		Use Java Context (boolean) default(true)
		userName : STRING
		the user name used when creating the connection (not used when security is configured) (string)
		xaDatasourceClass : STRING
		the class implementing the XADataSource (string)
		xaDatasourceProperties : MAP_STRING_STRING
		properties used to configure the XADataSource (map_string_string)

jbossas.War

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

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.
		excludeFileNamesRegex : STRING
		Regular expression that matches file names that must be excluded from scanning
		fileUri : STRING
		The URI pointing to the (remote) location of the file this artifact represents
		placeholders : SET_OF_STRING
		Placeholders detected in this artifact
		scanPlaceholders : BOOLEAN = false
		Whether to scan this artifact for 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
		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
		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

jbossas.WarModule

Type Hierarchy	jbossas.Artifact >> generic.CopiedArtifact >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem

War 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
		createOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER = 50
		The order of the step in the step list for the create operation.
		createVerb : STRING = Deploy
		Create Verb
		destroyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		destroyOrder : INTEGER = 40
		The order of the step in the step list for the destroy operation.
		destroyVerb : STRING = Undeploy
		Destroy Verb
		modifyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		modifyOrder : INTEGER = 50
		The order of the step in the step list for the modify operation.
		modifyVerb : STRING = Update
		Modify Verb
		noopOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		noopOrder : INTEGER = 50
		The order of the step in the step list for the noop operation.
		noopVerb : STRING = Modify
		Noop Verb
		targetDirectory : STRING = ${deployed.container.home}/server/${deployed.container.serverName}/deploy
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING = ${deployed.deployable.name}.war
		Name of the artifact on the generic server.
		copyDirectlyToTargetPath : BOOLEAN = false
		If set to true, files are directly copied to the target directory without first being uploaded to the staging or temporary directory (like versions of XL Deploy prior to 4.0.0)
		createTargetDirectory : BOOLEAN = false
		Create the target directory on the generic server if it does not exist.
		inspectClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
		inspectScript : STRING
		Classpath to the script used to inspect the generic container.
		inspectTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		preserveExistingFiles : BOOLEAN = false
		If set to true, preserve the existing files on the remote host (do not delete the copied files during the destroy operation).
		restartRequired : BOOLEAN = true
		The generic container requires a restart for the action performed by this deployed.
		restartRequiredForNoop : BOOLEAN = false
		The generic container requires a restart for the NOOP action performed by this deployed.
		targetDirectoryShared : BOOLEAN = true
		Is the target directory shared by others on the generic server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it.
		targetPathSharedSubDirectories : BOOLEAN = false
		If set to true, the sub directories on the target machine are not deleted if files other than that copied by XL Deploy are present. Please note that setting this option to true will cause the removal process to be a slower.