Tomcat Plugin Reference 6.2.x

CI Reference

Configuration Item Overview

Deployables

CI	Description
jee.DataSourceSpec	Deployable Java EE DataSource accessible via JNDI
jee.Ear	Deployable EAR artifact
jee.EjbJar	Deployable EJB JAR artifact
jee.JndiResourceSpec	Deployable Java EE Resource accessible via JNDI
jee.MailSessionSpec	Deployable Java EE Mail Session accessible via JNDI
jee.QueueConnectionFactorySpec	Deployable Java EE JMS QueueConnectionFactory accessible via JNDI
jee.QueueSpec	Deployable Java EE JMS Queue accessible via JNDI
jee.ResourceSpec	Description unavailable
jee.TopicConnectionFactorySpec	Deployable Java EE JMS TopicConnectionFactory accessible via JNDI
jee.TopicSpec	Deployable Jave EE JMS Topic accessible via JNDI
jee.War	Deployable WAR artifact
tomcat.ActiveMqConnectionFactorySpec	ActiveMQ connection factory installed on a Tomcat virtual host or the common context
tomcat.ActiveMqQueueSpec	ActiveMQ queue installed on a Tomcat virtual host or the common context
tomcat.ActiveMqTopicSpec	ActiveMQ topic installed on a Tomcat virtual host or the common context
tomcat.ConfigurationFile	File that contains application configurations
tomcat.ConfigurationFolder	Folder that contains files for application configuration
tomcat.DataSourceLinkSpec	Create a datasoure link to a global JNDI resource
tomcat.DataSourceSpec	DataSource installed on a Tomcat virtual host or the common context
tomcat.ExplodedWar	Exploded WAR file installed on a Tomcat virtual host
tomcat.Library	The library as deployed on the Tomcat server
tomcat.MailSessionSpec	Mail session installed on a Tomcat virtual host or the common context
tomcat.ResourceLinkSpec	Creates a link to a global JNDI resource
tomcat.War	WAR file installed on a Tomcat virtual host
tomcat.WebsphereMqQueueConnectionFactorySpec	WebSphere MQ queue connection factory installed on a Tomcat virtual host or the common context
tomcat.WebsphereMqQueueSpec	WebSphere MQ queue installed on a Tomcat virtual host or the common context
tomcat.WebsphereMqTopicConnectionFactorySpec	WebSphere MQ topic connection factory installed on a Tomcat virtual host or the common context
tomcat.WebsphereMqTopicSpec	WebSphere MQ topic installed on a Tomcat virtual host or the common context

Deployeds

CI	Description
tomcat.ActiveMqConnectionFactory	ActiveMQ connection factory installed on a Tomcat virtual host or the common context
tomcat.ActiveMqQueue	ActiveMQ queue installed on a Tomcat virtual host or the common context
tomcat.ActiveMqTopic	ActiveMQ topic installed on a Tomcat virtual host or the common context
tomcat.ContextElement	Base type for all Tomcat resources
tomcat.ContextWarModule	War Module that has an associated context
tomcat.CopiedArtifact	Base type for a Tomcat configuration
tomcat.DataSource	DataSource installed on a Tomcat virtual host or the common context
tomcat.DataSourceLink	Create a datasoure link to a global JNDI resource
tomcat.DeployedConfigurationFile	Deployed configuration file
tomcat.DeployedConfigurationFolder	Deployed configuration folder
tomcat.DeployedLibrary	The library as deployed on the Tomcat server
tomcat.ExplodedWarModule	Exploded WAR file installed on a Tomcat virtual host
tomcat.JeeActiveMqConnectionFactory	ActiveMQ connection factory installed on a Tomcat virtual host or the common context
tomcat.JeeActiveMqQueue	ActiveMQ queue installed on a Tomcat virtual host or the common context
tomcat.JeeActiveMqTopic	ActiveMQ topic installed on a Tomcat virtual host or the common context
tomcat.JeeWebsphereMqQueue	WebSphere MQ queue installed on a Tomcat virtual host or the common context
tomcat.JeeWebsphereMqQueueConnectionFactory	Websphere MQ queue connection factory installed on a Tomcat virtual host or the common context
tomcat.JeeWebsphereMqTopic	WebSphere MQ topic installed on a Tomcat virtual host or the common context
tomcat.JeeWebsphereMqTopicConnectionFactory	WebSphere MQ Topic Connection Factory installed on a Tomcat virtual host or the common context
tomcat.JndiContextElement	Resource installed on a Tomcat virtual host or the common context
tomcat.MailSession	Mail session installed on a Tomcat virtual host or the common context
tomcat.ResourceLink	Creates a link to a global JNDI resource
tomcat.WarModule	WAR file installed on a Tomcat virtual host
tomcat.WebsphereMqQueue	WebSphere MQ queue installed on a Tomcat virtual host or the common context
tomcat.WebsphereMqQueueConnectionFactory	WebSphere MQ queue connection factory installed on a Tomcat virtual host or the common context
tomcat.WebsphereMqTopic	WebSphere MQ topic installed on a Tomcat virtual host or the common context
tomcat.WebsphereMqTopicConnectionFactory	WebSphere MQ topic connection factory installed on a Tomcat virtual host or the common context

Containers

CI	Description
tomcat.CommonContext	The context element information will be loaded by all webapps
tomcat.ContextContainer	Models a Tomcat context on a Tomcat server in XL Deploy's infrastructure
tomcat.Server	Tomcat server on the host
tomcat.VirtualHost	Represents a virtual host, which associates a network name for a server (such as 'www

Configuration Item Details

jee.DataSourceSpec

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

Deployable Java EE DataSource accessible via JNDI.

		Public Properties
		jndiName : STRING
		Name used to lookup this resource in JNDI
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

---

jee.Ear

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

Deployable EAR artifact.

		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

---

jee.EjbJar

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

Deployable EJB JAR artifact.

		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

---

jee.JndiResourceSpec

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

Deployable Java EE Resource accessible via JNDI.

		Public Properties
		jndiName : STRING
		Name used to lookup this resource in JNDI
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

---

jee.MailSessionSpec

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

Deployable Java EE Mail Session accessible via JNDI.

		Public Properties
		jndiName : STRING
		Name used to lookup this resource in JNDI
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

---

jee.QueueConnectionFactorySpec

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

Deployable Java EE JMS QueueConnectionFactory accessible via JNDI.

		Public Properties
		jndiName : STRING
		Name used to lookup this resource in JNDI
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

---

jee.QueueSpec

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

Deployable Java EE JMS Queue accessible via JNDI.

		Public Properties
		jndiName : STRING
		Name used to lookup this resource in JNDI
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

---

jee.ResourceSpec

Virtual Type
Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.ConfigurationItem, udm.Taggable, udm.Deployable

Description unavailable

		Public Properties
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

---

jee.TopicConnectionFactorySpec

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

Deployable Java EE JMS TopicConnectionFactory accessible via JNDI.

		Public Properties
		jndiName : STRING
		Name used to lookup this resource in JNDI
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

---

jee.TopicSpec

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

Deployable Jave EE JMS Topic accessible via JNDI.

		Public Properties
		jndiName : STRING
		Name used to lookup this resource in JNDI
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

---

jee.War

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

Deployable WAR artifact.

		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

---

tomcat.ActiveMqConnectionFactory

Type Hierarchy	tomcat.JeeActiveMqConnectionFactory >> tomcat.JndiContextElement >> tomcat.ContextElement >> generic.ProcessedTemplate >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

ActiveMQ connection factory installed on a Tomcat virtual host or the common context.

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

		Public Properties
		brokerName : STRING
		Broker Name
		brokerUrl : STRING
		Broker Url
		description : STRING  = JMS Connection Factory
		Description
		jndiName : STRING
		Name used to look up the resource in JNDI.
		context : STRING
		The name of the context that this resource is associated with
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden Properties
		auth : STRING  = Container
		Auth
		createOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER  = 60
		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
		elementName : STRING  = ${deployed.jndiName}
		Element Name
		elementPropertyMapping : MAP_STRING_STRING  = {jndiName=name, auth=, resourceType=type, description=, factory=, brokerUrl=brokerURL, brokerName=}
		Mapping of the configuration item (CI) properties to their factory equivalents. Leave this property blank to use the same name as the key.
		elementTag : STRING  = Resource
		Element Tag
		factory : STRING  = org.apache.activemq.jndi.JNDIReferenceFactory
		Factory
		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
		resourceType : STRING  = org.apache.activemq.ActiveMQConnectionFactory
		Resource Type
		targetDirectory : STRING  = ${deployed.container.contextDirectory}
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING  = ${deployed.context}.xml
		Name of the artifact on the generic server.
		template : STRING  = tc/context/context-element.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.

---

tomcat.ActiveMqConnectionFactorySpec

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

ActiveMQ connection factory installed on a Tomcat virtual host or the common context. (deployable)

		Public Properties
		brokerName : STRING
		Broker Name (string)
		brokerUrl : STRING
		Broker Url (string)
		context : STRING
		The name of the context that this resource is associated with (string)
		description : STRING
		Description (string) default(JMS Connection Factory)
		jndiName : STRING
		Name used to look up the resource in JNDI. (string)
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

---

tomcat.ActiveMqQueue

Type Hierarchy	tomcat.JeeActiveMqQueue >> tomcat.JndiContextElement >> tomcat.ContextElement >> generic.ProcessedTemplate >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

ActiveMQ queue installed on a Tomcat virtual host or the common context.

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

		Public Properties
		description : STRING
		Description
		jndiName : STRING
		Name used to look up the resource in JNDI.
		physicalName : STRING
		Physical Name
		context : STRING
		The name of the context that this resource is associated with
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden Properties
		auth : STRING  = Container
		Auth
		createOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER  = 60
		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
		elementName : STRING  = ${deployed.jndiName}
		Element Name
		elementPropertyMapping : MAP_STRING_STRING  = {jndiName=name, auth=, resourceType=type, description=, factory=, physicalName=}
		Mapping of the configuration item (CI) properties to their factory equivalents. Leave this property blank to use the same name as the key.
		elementTag : STRING  = Resource
		Element Tag
		factory : STRING  = org.apache.activemq.jndi.JNDIReferenceFactory
		Factory
		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
		resourceType : STRING  = org.apache.activemq.command.ActiveMQQueue
		Resource Type
		targetDirectory : STRING  = ${deployed.container.contextDirectory}
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING  = ${deployed.context}.xml
		Name of the artifact on the generic server.
		template : STRING  = tc/context/context-element.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.

---

tomcat.ActiveMqQueueSpec

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

ActiveMQ queue installed on a Tomcat virtual host or the common context. (deployable)

		Public Properties
		context : STRING
		The name of the context that this resource is associated with (string)
		description : STRING
		Description (string)
		jndiName : STRING
		Name used to look up the resource in JNDI. (string)
		physicalName : STRING
		Physical Name (string)
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

---

tomcat.ActiveMqTopic

Type Hierarchy	tomcat.JeeActiveMqTopic >> tomcat.JndiContextElement >> tomcat.ContextElement >> generic.ProcessedTemplate >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

ActiveMQ topic installed on a Tomcat virtual host or the common context.

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

		Public Properties
		description : STRING
		Description
		jndiName : STRING
		Name used to look up the resource in JNDI.
		physicalName : STRING
		Physical Name
		context : STRING
		The name of the context that this resource is associated with
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden Properties
		auth : STRING  = Container
		Auth
		createOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER  = 60
		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
		elementName : STRING  = ${deployed.jndiName}
		Element Name
		elementPropertyMapping : MAP_STRING_STRING  = {jndiName=name, auth=, resourceType=type, description=, factory=, physicalName=}
		Mapping of the configuration item (CI) properties to their factory equivalents. Leave this property blank to use the same name as the key.
		elementTag : STRING  = Resource
		Element Tag
		factory : STRING  = org.apache.activemq.jndi.JNDIReferenceFactory
		Factory
		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
		resourceType : STRING  = org.apache.activemq.command.ActiveMQTopic
		Resource Type
		targetDirectory : STRING  = ${deployed.container.contextDirectory}
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING  = ${deployed.context}.xml
		Name of the artifact on the generic server.
		template : STRING  = tc/context/context-element.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.

---

tomcat.ActiveMqTopicSpec

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

ActiveMQ topic installed on a Tomcat virtual host or the common context. (deployable)

		Public Properties
		context : STRING
		The name of the context that this resource is associated with (string)
		description : STRING
		Description (string)
		jndiName : STRING
		Name used to look up the resource in JNDI. (string)
		physicalName : STRING
		Physical Name (string)
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

---

tomcat.CommonContext

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

The context element information will be loaded by all webapps.

		Parent
		server : CI<tomcat.Server >
		Server

		Public Properties
		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.

		Hidden Properties
		contextDirectory : STRING  = ${container.server.home}/conf
		Context Directory
		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.
		startWaitTime : INTEGER  = 0
		The time to wait in seconds for a container start action.
		stopOrder : INTEGER  = 10
		The order of the stop container step in the step list.
		stopWaitTime : INTEGER  = 0
		The time to wait in seconds for a container stop action.
		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.
		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.
		startScript : STRING
		Classpath to the script used to start the generic container.
		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.
		stopScript : STRING
		Classpath to the script used to stop the generic container.
		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.

---

tomcat.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 that contains application configurations. This file is deployed to the server configuration 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.
		targetDirectory : STRING
		Path to which artifact must be copied to on the generic server. (string)
		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

---

tomcat.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 that contains files for application configuration. These files are deployed to the server configuration 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.
		targetDirectory : STRING
		Path to which artifact must be copied to on the generic server. (string)
		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

---

tomcat.ContextContainer

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

Models a Tomcat context on a Tomcat server in XL Deploy's infrastructure.

		Public Properties
		contextDirectory : STRING
		Context Directory
		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.

		Hidden Properties
		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.
		startWaitTime : INTEGER  = 0
		The time to wait in seconds for a container start action.
		stopOrder : INTEGER  = 10
		The order of the stop container step in the step list.
		stopWaitTime : INTEGER  = 0
		The time to wait in seconds for a container stop action.
		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.
		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.
		startScript : STRING
		Classpath to the script used to start the generic container.
		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.
		stopScript : STRING
		Classpath to the script used to stop the generic container.
		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.

---

tomcat.ContextElement

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

Base type for all Tomcat resources

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

		Public Properties
		context : STRING
		The name of the context that this resource is associated with
		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
		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  = false
		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.

---

tomcat.ContextWarModule

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

War Module that has an associated context.xml

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

		Public Properties
		contextRoot : STRING  = ${deployed.name}
		Context root under which the web application can be access
		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
		contextSubject : STRING  = war settings
		Context Subject
		contextTemplate : STRING
		Freemarker template used to create the context xml for the War
		contextXmlTargetDirectory : STRING
		Target directory to which the context xml must to copied to on the target system
		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.
		createOrderOfContextXml : INTEGER  = 60
		The order of the create context 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.
		destroyOrderOfContextXml : INTEGER  = 40
		The order of the destroy context step in the step list for the create 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.
		modifyOrderOfContextXml : INTEGER  = 60
		The order of the rename context root 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
		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.
		deleteGeneratedResources : SET_OF_STRING
		Absolute paths to files on the target system that was generated and must be clean up during a destroy operation
		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.
		manageContextXml : BOOLEAN  = true
		If set to true, create and destroy context.xml files. Set to false to provide your own context.xml file.
		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).
		removeContextXml : BOOLEAN  = false
		If set to false, keep context file on destroy. Set to true to destroy the context file.
		restartRequired : BOOLEAN  = false
		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.

---

tomcat.CopiedArtifact

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 Tomcat configuration.

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

		Public Properties
		targetDirectory : STRING
		Path to which artifact must be copied to on the generic server.
		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  = 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
		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  = true
		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.

---

tomcat.DataSource

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

DataSource installed on a Tomcat virtual host or the common context.

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

		Public Properties
		driverClassName : STRING
		The fully qualified Java class name of the JDBC driver to use.
		jndiName : STRING
		Name used to look up the resource in JNDI.
		password : STRING
		The connection password to pass to the XL Deploy JDBC driver to establish a connection.
		url : STRING
		The connection URL to pass to the XL Deploy JDBC driver to establish a connection.
		username : STRING
		The connection username to pass to the XL Deploy JDBC driver to establish a connection.
		connectionProperties : MAP_STRING_STRING
		The connection properties to send to the XL Deploy JDBC driver when establishing new connections.
		context : STRING
		The name of the context that this resource is associated with
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.
		initialSize : INTEGER  = 0
		The initial number of connections that are created when the pool is started.
		maxActive : INTEGER  = 8
		The maximum number of active connections that can be allocated from this pool at the same time (negative for no limit).
		maxIdle : INTEGER  = 8
		The maximum number of connections that can remain idle in the pool without extra connections being released (negative for no limit).
		maxWait : INTEGER  = -1
		The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception (-1 to wait indefinitely).
		minIdle : INTEGER  = 0
		The minimum number of connections that can remain idle in the pool without extra connections being created (zero to create none).

		Hidden Properties
		auth : STRING  = Container
		Auth
		createOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER  = 60
		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
		elementName : STRING  = ${deployed.jndiName}
		Element Name
		elementPropertyMapping : MAP_STRING_STRING  = {jndiName=name, auth=, resourceType=type, driverClassName=, url=, username=, password=, maxActive=, maxIdle=, minIdle=, maxWait=, initialSize=, connectionProperties=}
		Mapping of the configuration item (CI) properties to their factory equivalents. Leave this property blank to use the same name as the key.
		elementTag : STRING  = Resource
		Element Tag
		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
		resourceType : STRING  = javax.sql.DataSource
		Resource Type
		targetDirectory : STRING  = ${deployed.container.contextDirectory}
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING  = ${deployed.context}.xml
		Name of the artifact on the generic server.
		template : STRING  = tc/context/context-element.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.

---

tomcat.DataSourceLink

Type Hierarchy	tomcat.ResourceLink >> tomcat.JndiContextElement >> tomcat.ContextElement >> generic.ProcessedTemplate >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Create a datasoure link to a global JNDI resource. Performing a JNDI lookup on the link name will return the linked global resource. This is installed on a Tomcat virtual host or the common context.

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

		Public Properties
		globalName : STRING
		The name of the linked global resource in the global JNDI context.
		jndiName : STRING
		The name of the resource link to be created, relative to the java:comp/env context.
		context : STRING
		The name of the context that this resource is associated with
		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  = 60
		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
		elementName : STRING  = ${deployed.jndiName}
		Element Name
		elementPropertyMapping : MAP_STRING_STRING  = {jndiName=name, resourceType=type, globalName=}
		Mapping of the configuration item (CI) properties to their factory equivalents. Leave this property blank to use the same name as the key.
		elementTag : STRING  = ResourceLink
		Element Tag
		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
		resourceType : STRING  = javax.sql.DataSource
		The fully qualified Java class name that the web application expects when it performs a lookup for this resource link.
		targetDirectory : STRING  = ${deployed.container.contextDirectory}
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING  = ${deployed.context}.xml
		Name of the artifact on the generic server.
		template : STRING  = tc/context/context-element.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.

---

tomcat.DataSourceLinkSpec

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

Create a datasoure link to a global JNDI resource. Performing a JNDI lookup on the link name will return the linked global resource. This is installed on a Tomcat virtual host or the common context. (deployable)

		Public Properties
		context : STRING
		The name of the context that this resource is associated with (string)
		globalName : STRING
		The name of the linked global resource in the global JNDI context. (string)
		jndiName : STRING
		The name of the resource link to be created, relative to the java:comp/env context. (string)
		resourceType : STRING
		The fully qualified Java class name that the web application expects when it performs a lookup for this resource link. (string)
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

---

tomcat.DataSourceSpec

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

DataSource installed on a Tomcat virtual host or the common context. (deployable)

		Public Properties
		connectionProperties : MAP_STRING_STRING
		The connection properties to send to the XL Deploy JDBC driver when establishing new connections. (map_string_string)
		context : STRING
		The name of the context that this resource is associated with (string)
		driverClassName : STRING
		The fully qualified Java class name of the JDBC driver to use. (string)
		initialSize : STRING
		The initial number of connections that are created when the pool is started. (integer) default(0)
		jndiName : STRING
		Name used to look up the resource in JNDI. (string)
		maxActive : STRING
		The maximum number of active connections that can be allocated from this pool at the same time (negative for no limit). (integer) default(8)
		maxIdle : STRING
		The maximum number of connections that can remain idle in the pool without extra connections being released (negative for no limit). (integer) default(8)
		maxWait : STRING
		The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception (-1 to wait indefinitely). (integer) default(-1)
		minIdle : STRING
		The minimum number of connections that can remain idle in the pool without extra connections being created (zero to create none). (integer) default(0)
		password : STRING
		The connection password to pass to the XL Deploy JDBC driver to establish a connection. (string)
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		url : STRING
		The connection URL to pass to the XL Deploy JDBC driver to establish a connection. (string)
		username : STRING
		The connection username to pass to the XL Deploy JDBC driver to establish a connection. (string)

---

tomcat.DeployedConfigurationFile

Type Hierarchy	tomcat.CopiedArtifact >> 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
		targetDirectory : STRING
		Path to which artifact must be copied to on the generic server.
		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  = 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
		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  = true
		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.

---

tomcat.DeployedConfigurationFolder

Type Hierarchy	tomcat.CopiedArtifact >> 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
		targetDirectory : STRING
		Path to which artifact must be copied to on the generic server.
		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  = 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
		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  = true
		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.

---

tomcat.DeployedLibrary

Type Hierarchy	tomcat.CopiedArtifact >> 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 Tomcat 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  = 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}/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  = true
		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.

---

tomcat.ExplodedWar

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

Exploded WAR file installed on a Tomcat virtual host. (deployable)

		Public Properties
		appBase : STRING
		App Base (string) default(${deployed.container.appBaseAbsolutePath})
		checksum : STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		contextRoot : STRING
		Context root under which the web application can be access (string) default(${deployed.name})
		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.

		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

---

tomcat.ExplodedWarModule

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

Exploded WAR file installed on a Tomcat virtual host.

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

		Public Properties
		appBase : STRING  = ${deployed.container.appBaseAbsolutePath}
		App Base
		contextRoot : STRING  = ${deployed.name}
		Context root under which the web application can be access
		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
		contextElementPropertyMapping : MAP_STRING_STRING  = {docBase=}
		Mapping of the context attributes. Leave this property blank to use the same name as the key.
		contextSubject : STRING  = war settings
		Context Subject
		contextTemplate : STRING  = tc/context/context-attributes.ftl
		Freemarker template used to create the context xml for the War
		contextXmlTargetDirectory : STRING  = ${deployed.container.contextDirectory}
		Target directory to which the context xml must to copied to on the target system
		createOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER  = 70
		The order of the step in the step list for the create operation.
		createOrderOfContextXml : INTEGER  = 60
		The order of the create context 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  = 30
		The order of the step in the step list for the destroy operation.
		destroyOrderOfContextXml : INTEGER  = 40
		The order of the destroy context step in the step list for the create operation.
		destroyVerb : STRING  = Destroy
		Destroy Verb
		docBase : STRING  = ${deployed.targetDirectory}
		Doc Base
		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.
		modifyOrderOfContextXml : INTEGER  = 60
		The order of the rename context root 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.appBase}/${deployed.contextRoot}.war
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING  = NOT_USED
		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  = true
		Create the target directory on the generic server if it does not exist.
		deleteGeneratedResources : SET_OF_STRING
		Absolute paths to files on the target system that was generated and must be clean up during a destroy operation
		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.
		manageContextXml : BOOLEAN  = true
		If set to true, create and destroy context.xml files. Set to false to provide your own context.xml file.
		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).
		removeContextXml : BOOLEAN  = false
		If set to false, keep context file on destroy. Set to true to destroy the context file.
		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  = false
		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.

---

tomcat.JeeActiveMqConnectionFactory

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

ActiveMQ connection factory installed on a Tomcat virtual host or the common context.

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

		Public Properties
		brokerName : STRING
		Broker Name
		brokerUrl : STRING
		Broker Url
		description : STRING  = JMS Connection Factory
		Description
		jndiName : STRING
		Name used to look up the resource in JNDI.
		context : STRING
		The name of the context that this resource is associated with
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden Properties
		auth : STRING  = Container
		Auth
		createOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER  = 60
		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
		elementName : STRING  = ${deployed.jndiName}
		Element Name
		elementPropertyMapping : MAP_STRING_STRING  = {jndiName=name, auth=, resourceType=type, description=, factory=, brokerUrl=brokerURL, brokerName=}
		Mapping of the configuration item (CI) properties to their factory equivalents. Leave this property blank to use the same name as the key.
		elementTag : STRING  = Resource
		Element Tag
		factory : STRING  = org.apache.activemq.jndi.JNDIReferenceFactory
		Factory
		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
		resourceType : STRING  = org.apache.activemq.ActiveMQConnectionFactory
		Resource Type
		targetDirectory : STRING  = ${deployed.container.contextDirectory}
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING  = ${deployed.context}.xml
		Name of the artifact on the generic server.
		template : STRING  = tc/context/context-element.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.

---

tomcat.JeeActiveMqQueue

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

ActiveMQ queue installed on a Tomcat virtual host or the common context.

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

		Public Properties
		description : STRING
		Description
		jndiName : STRING
		Name used to look up the resource in JNDI.
		physicalName : STRING
		Physical Name
		context : STRING
		The name of the context that this resource is associated with
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden Properties
		auth : STRING  = Container
		Auth
		createOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER  = 60
		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
		elementName : STRING  = ${deployed.jndiName}
		Element Name
		elementPropertyMapping : MAP_STRING_STRING  = {jndiName=name, auth=, resourceType=type, description=, factory=, physicalName=}
		Mapping of the configuration item (CI) properties to their factory equivalents. Leave this property blank to use the same name as the key.
		elementTag : STRING  = Resource
		Element Tag
		factory : STRING  = org.apache.activemq.jndi.JNDIReferenceFactory
		Factory
		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
		resourceType : STRING  = org.apache.activemq.command.ActiveMQQueue
		Resource Type
		targetDirectory : STRING  = ${deployed.container.contextDirectory}
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING  = ${deployed.context}.xml
		Name of the artifact on the generic server.
		template : STRING  = tc/context/context-element.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.

---

tomcat.JeeActiveMqTopic

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

ActiveMQ topic installed on a Tomcat virtual host or the common context.

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

		Public Properties
		description : STRING
		Description
		jndiName : STRING
		Name used to look up the resource in JNDI.
		physicalName : STRING
		Physical Name
		context : STRING
		The name of the context that this resource is associated with
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden Properties
		auth : STRING  = Container
		Auth
		createOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER  = 60
		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
		elementName : STRING  = ${deployed.jndiName}
		Element Name
		elementPropertyMapping : MAP_STRING_STRING  = {jndiName=name, auth=, resourceType=type, description=, factory=, physicalName=}
		Mapping of the configuration item (CI) properties to their factory equivalents. Leave this property blank to use the same name as the key.
		elementTag : STRING  = Resource
		Element Tag
		factory : STRING  = org.apache.activemq.jndi.JNDIReferenceFactory
		Factory
		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
		resourceType : STRING  = org.apache.activemq.command.ActiveMQTopic
		Resource Type
		targetDirectory : STRING  = ${deployed.container.contextDirectory}
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING  = ${deployed.context}.xml
		Name of the artifact on the generic server.
		template : STRING  = tc/context/context-element.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.

---

tomcat.JeeWebsphereMqQueue

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

WebSphere MQ queue installed on a Tomcat virtual host or the common context.

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

		Public Properties
		description : STRING
		Description
		jndiName : STRING
		Name used to look up the resource in JNDI.
		physicalName : STRING
		Physical Name
		context : STRING
		The name of the context that this resource is associated with
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden Properties
		auth : STRING  = Container
		Auth
		createOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER  = 60
		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
		elementName : STRING  = ${deployed.jndiName}
		Element Name
		elementPropertyMapping : MAP_STRING_STRING  = {jndiName=name, auth=, resourceType=type, description=, factory=, physicalName=QU}
		Mapping of the configuration item (CI) properties to their factory equivalents. Leave this property blank to use the same name as the key.
		elementTag : STRING  = Resource
		Element Tag
		factory : STRING  = com.ibm.mq.jms.MQQueueFactory
		Factory
		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
		resourceType : STRING  = com.ibm.mq.jms.MQQueue
		Resource Type
		targetDirectory : STRING  = ${deployed.container.contextDirectory}
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING  = ${deployed.context}.xml
		Name of the artifact on the generic server.
		template : STRING  = tc/context/context-element.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.

---

tomcat.JeeWebsphereMqQueueConnectionFactory

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

Websphere MQ queue connection factory installed on a Tomcat virtual host or the common context.

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

		Public Properties
		channel : STRING
		Channel
		description : STRING  = JMS Connection Factory
		Description
		jndiName : STRING
		Name used to look up the resource in JNDI.
		port : INTEGER
		Port
		queueManager : STRING
		Queue Manager
		server : STRING
		Server
		context : STRING
		The name of the context that this resource is associated with
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden Properties
		auth : STRING  = Container
		Auth
		createOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER  = 60
		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
		elementName : STRING  = ${deployed.jndiName}
		Element Name
		elementPropertyMapping : MAP_STRING_STRING  = {jndiName=name, auth=, resourceType=type, factory=, description=, server=HOST, port=PORT, channel=CHAN, transport=TRAN, queueManager=QMGR}
		Mapping of the configuration item (CI) properties to their factory equivalents. Leave this property blank to use the same name as the key.
		elementTag : STRING  = Resource
		Element Tag
		factory : STRING  = com.ibm.mq.jms.MQQueueConnectionFactoryFactory
		Factory
		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
		resourceType : STRING  = com.ibm.mq.jms.MQQueueConnectionFactory
		Resource Type
		targetDirectory : STRING  = ${deployed.container.contextDirectory}
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING  = ${deployed.context}.xml
		Name of the artifact on the generic server.
		template : STRING  = tc/context/context-element.ftl
		Classpath to the freemarker template used to generate the content of the final text base artifact.
		transport : STRING  = 1
		Transport
		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.

---

tomcat.JeeWebsphereMqTopic

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

WebSphere MQ topic installed on a Tomcat virtual host or the common context.

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

		Public Properties
		description : STRING
		Description
		jndiName : STRING
		Name used to look up the resource in JNDI.
		physicalName : STRING
		Physical Name
		context : STRING
		The name of the context that this resource is associated with
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden Properties
		auth : STRING  = Container
		Auth
		createOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER  = 60
		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
		elementName : STRING  = ${deployed.jndiName}
		Element Name
		elementPropertyMapping : MAP_STRING_STRING  = {jndiName=name, auth=, resourceType=type, description=, factory=, physicalName=TOP}
		Mapping of the configuration item (CI) properties to their factory equivalents. Leave this property blank to use the same name as the key.
		elementTag : STRING  = Resource
		Element Tag
		factory : STRING  = com.ibm.mq.jms.MQTopicFactory
		Factory
		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
		resourceType : STRING  = com.ibm.mq.jms.MQTopic
		Resource Type
		targetDirectory : STRING  = ${deployed.container.contextDirectory}
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING  = ${deployed.context}.xml
		Name of the artifact on the generic server.
		template : STRING  = tc/context/context-element.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.

---

tomcat.JeeWebsphereMqTopicConnectionFactory

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

WebSphere MQ Topic Connection Factory installed on a Tomcat virtual host or the common context.

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

		Public Properties
		channel : STRING
		Channel
		description : STRING  = JMS Connection Factory
		Description
		jndiName : STRING
		Name used to look up the resource in JNDI.
		port : INTEGER
		Port
		queueManager : STRING
		Queue Manager
		server : STRING
		Server
		context : STRING
		The name of the context that this resource is associated with
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden Properties
		auth : STRING  = Container
		Auth
		createOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER  = 60
		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
		elementName : STRING  = ${deployed.jndiName}
		Element Name
		elementPropertyMapping : MAP_STRING_STRING  = {jndiName=name, auth=, resourceType=type, factory=, description=, server=HOST, port=PORT, channel=CHAN, transport=TRAN, queueManager=QMGR}
		Mapping of the configuration item (CI) properties to their factory equivalents. Leave this property blank to use the same name as the key.
		elementTag : STRING  = Resource
		Element Tag
		factory : STRING  = com.ibm.mq.jms.MQTopicConnectionFactoryFactory
		Factory
		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
		resourceType : STRING  = com.ibm.mq.jms.MQTopicConnectionFactory
		Resource Type
		targetDirectory : STRING  = ${deployed.container.contextDirectory}
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING  = ${deployed.context}.xml
		Name of the artifact on the generic server.
		template : STRING  = tc/context/context-element.ftl
		Classpath to the freemarker template used to generate the content of the final text base artifact.
		transport : STRING  = 1
		Transport
		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.

---

tomcat.JndiContextElement

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

Resource installed on a Tomcat virtual host or the common context.

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

		Public Properties
		jndiName : STRING
		Name used to look up the resource in JNDI.
		context : STRING
		The name of the context that this resource is associated with
		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  = 60
		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
		elementName : STRING  = ${deployed.jndiName}
		Element Name
		elementTag : STRING  = Resource
		Element Tag
		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.contextDirectory}
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING  = ${deployed.context}.xml
		Name of the artifact on the generic server.
		template : STRING  = tc/context/context-element.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.
		elementPropertyMapping : MAP_STRING_STRING
		Mapping of the configuration item (CI) properties to their factory equivalents. Leave this property blank to use the same name as the key.
		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.

---

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

The library as deployed on the Tomcat server. (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

---

tomcat.MailSession

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

Mail session installed on a Tomcat virtual host or the common context.

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

		Public Properties
		jndiName : STRING
		Name used to look up the resource in JNDI.
		smtpHost : STRING
		The server that provides SMTP service for your network.
		context : STRING
		The name of the context that this resource is associated with
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden Properties
		auth : STRING  = Container
		Auth
		createOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER  = 60
		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
		elementName : STRING  = ${deployed.jndiName}
		Element Name
		elementPropertyMapping : MAP_STRING_STRING  = {jndiName=name, auth=, resourceType=type, smtpHost=mail.smtp.host}
		Mapping of the configuration item (CI) properties to their factory equivalents. Leave this property blank to use the same name as the key.
		elementTag : STRING  = Resource
		Element Tag
		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
		resourceType : STRING  = javax.mail.Session
		Resource Type
		targetDirectory : STRING  = ${deployed.container.contextDirectory}
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING  = ${deployed.context}.xml
		Name of the artifact on the generic server.
		template : STRING  = tc/context/context-element.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.

---

tomcat.MailSessionSpec

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

Mail session installed on a Tomcat virtual host or the common context. (deployable)

		Public Properties
		context : STRING
		The name of the context that this resource is associated with (string)
		jndiName : STRING
		Name used to look up the resource in JNDI. (string)
		smtpHost : STRING
		The server that provides SMTP service for your network. (string)
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

---

tomcat.ResourceLink

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

Creates a link to a global JNDI resource. Performing a JNDI lookup on the link name will return the linked global resource. This is installed on a Tomcat virtual host or the common context.

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

		Public Properties
		globalName : STRING
		The name of the linked global resource in the global JNDI context.
		jndiName : STRING
		The name of the resource link to be created, relative to the java:comp/env context.
		resourceType : STRING
		The fully qualified Java class name that the web application expects when it performs a lookup for this resource link.
		context : STRING
		The name of the context that this resource is associated with
		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  = 60
		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
		elementName : STRING  = ${deployed.jndiName}
		Element Name
		elementPropertyMapping : MAP_STRING_STRING  = {jndiName=name, resourceType=type, globalName=}
		Mapping of the configuration item (CI) properties to their factory equivalents. Leave this property blank to use the same name as the key.
		elementTag : STRING  = ResourceLink
		Element Tag
		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.contextDirectory}
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING  = ${deployed.context}.xml
		Name of the artifact on the generic server.
		template : STRING  = tc/context/context-element.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.

---

tomcat.ResourceLinkSpec

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

Creates a link to a global JNDI resource. Performing a JNDI lookup on the link name will return the linked global resource. This is installed on a Tomcat virtual host or the common context. (deployable)

		Public Properties
		context : STRING
		The name of the context that this resource is associated with (string)
		globalName : STRING
		The name of the linked global resource in the global JNDI context. (string)
		jndiName : STRING
		The name of the resource link to be created, relative to the java:comp/env context. (string)
		resourceType : STRING
		The fully qualified Java class name that the web application expects when it performs a lookup for this resource link. (string)
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

---

tomcat.Server

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

Tomcat server on the host.

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

		Public Properties
		home : STRING
		Home directory for Tomcat
		startCommand : STRING
		Operating system-specific command used to start Tomcat.
		startWaitTime : INTEGER  = 0
		Number of seconds to wait after the step that starts the server is executed
		stopCommand : STRING
		Operating system-specific command used to stop Tomcat.
		stopWaitTime : INTEGER  = 0
		Number of seconds to wait after the step that stops the server is executed
		envVars : MAP_STRING_STRING
		Environment variables for container
		statusCommand : STRING
		Operating system-specific command used to retrieve the Tomcat server status. Command should return 0 when server is running and 1 or higher when the server is stopped. E.g. 'netstat -na | grep 8080 | grep -q LISTEN' or 'netstat -na | find ''LISTENING'' | find /C /I '':8080'' > NUL' to check if Tomcat is listening on port 8080.
		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.

		Hidden Properties
		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.
		serverXml : STRING  = ${container.home}/conf/server.xml
		Server Xml
		startOrder : INTEGER  = 90
		The order of the start container step in the step list.
		startScript : STRING  = tc/server/start-tc
		Classpath to the script used to start the generic container.
		statusScript : STRING  = tc/server/status-tc
		Status Script
		stopOrder : INTEGER  = 10
		The order of the stop container step in the step list.
		stopScript : STRING  = tc/server/stop-tc
		Classpath to the script used to stop the generic container.
		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.
		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.
		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.

Control task	Parameter CI	Attributes	Description
start			Start Tomcat.
status			Check status.
stop			Stop Tomcat.

---

tomcat.VirtualHost

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

Represents a virtual host, which associates a network name for a server (such as 'www.mycompany.com') to the server on which Catalina is running.

		Parent
		server : CI<tomcat.Server >
		Server

		Public Properties
		appBase : STRING  = webapps
		The application base directory for this virtual host. This is the path name of a directory that contains web applications to be deployed on this virtual host. You can specify a path that is relative to the Tomcat server home directory.
		hostName : STRING  = localhost
		Host Name
		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.

		Hidden Properties
		appBaseAbsolutePath : STRING  = ${container.server.home}/${container.appBase}
		App Base Absolute Path
		contextDirectory : STRING  = ${container.server.home}/conf/Catalina/${container.hostName}
		Context Directory
		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.
		startWaitTime : INTEGER  = 0
		The time to wait in seconds for a container start action.
		stopOrder : INTEGER  = 10
		The order of the stop container step in the step list.
		stopWaitTime : INTEGER  = 0
		The time to wait in seconds for a container stop action.
		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.
		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.
		startScript : STRING
		Classpath to the script used to start the generic container.
		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.
		stopScript : STRING
		Classpath to the script used to stop the generic container.
		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.

---

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

WAR file installed on a Tomcat virtual host. (deployable)

		Public Properties
		checksum : STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		contextRoot : STRING
		Context root under which the web application can be access (string) default(${deployed.name})
		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

---

tomcat.WarModule

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

WAR file installed on a Tomcat virtual host.

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

		Public Properties
		contextRoot : STRING  = ${deployed.name}
		Context root under which the web application can be access
		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
		contextElementPropertyMapping : MAP_STRING_STRING  = {unpackWAR=, docBase=}
		Mapping of the context attributes. Leave this property blank to use the same name as the key.
		contextSubject : STRING  = war settings
		Context Subject
		contextTemplate : STRING  = tc/context/context-attributes.ftl
		Freemarker template used to create the context xml for the War
		contextXmlTargetDirectory : STRING  = ${deployed.container.contextDirectory}
		Target directory to which the context xml must to copied to on the target system
		createOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER  = 70
		The order of the step in the step list for the create operation.
		createOrderOfContextXml : INTEGER  = 60
		The order of the create context 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  = 30
		The order of the step in the step list for the destroy operation.
		destroyOrderOfContextXml : INTEGER  = 40
		The order of the destroy context step in the step list for the create operation.
		destroyVerb : STRING  = Destroy
		Destroy Verb
		docBase : STRING  = ${deployed.targetFile}
		Doc Base
		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.
		modifyOrderOfContextXml : INTEGER  = 60
		The order of the rename context root 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.appBaseAbsolutePath}
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING  = ${deployed.contextRoot}.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.
		deleteGeneratedResources : SET_OF_STRING
		Absolute paths to files on the target system that was generated and must be clean up during a destroy operation
		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.
		manageContextXml : BOOLEAN  = true
		If set to true, create and destroy context.xml files. Set to false to provide your own context.xml file.
		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).
		removeContextXml : BOOLEAN  = false
		If set to false, keep context file on destroy. Set to true to destroy the context file.
		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.
		unpackWAR : BOOLEAN  = true
		Unpack W A R

---

tomcat.WebsphereMqQueue

Type Hierarchy	tomcat.JeeWebsphereMqQueue >> tomcat.JndiContextElement >> tomcat.ContextElement >> generic.ProcessedTemplate >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

WebSphere MQ queue installed on a Tomcat virtual host or the common context.

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

		Public Properties
		description : STRING
		Description
		jndiName : STRING
		Name used to look up the resource in JNDI.
		physicalName : STRING
		Physical Name
		context : STRING
		The name of the context that this resource is associated with
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden Properties
		auth : STRING  = Container
		Auth
		createOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER  = 60
		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
		elementName : STRING  = ${deployed.jndiName}
		Element Name
		elementPropertyMapping : MAP_STRING_STRING  = {jndiName=name, auth=, resourceType=type, description=, factory=, physicalName=QU}
		Mapping of the configuration item (CI) properties to their factory equivalents. Leave this property blank to use the same name as the key.
		elementTag : STRING  = Resource
		Element Tag
		factory : STRING  = com.ibm.mq.jms.MQQueueFactory
		Factory
		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
		resourceType : STRING  = com.ibm.mq.jms.MQQueue
		Resource Type
		targetDirectory : STRING  = ${deployed.container.contextDirectory}
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING  = ${deployed.context}.xml
		Name of the artifact on the generic server.
		template : STRING  = tc/context/context-element.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.

---

tomcat.WebsphereMqQueueConnectionFactory

Type Hierarchy	tomcat.JeeWebsphereMqQueueConnectionFactory >> tomcat.JndiContextElement >> tomcat.ContextElement >> generic.ProcessedTemplate >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

WebSphere MQ queue connection factory installed on a Tomcat virtual host or the common context.

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

		Public Properties
		channel : STRING
		Channel
		description : STRING  = JMS Connection Factory
		Description
		jndiName : STRING
		Name used to look up the resource in JNDI.
		port : INTEGER
		Port
		queueManager : STRING
		Queue Manager
		server : STRING
		Server
		context : STRING
		The name of the context that this resource is associated with
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden Properties
		auth : STRING  = Container
		Auth
		createOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER  = 60
		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
		elementName : STRING  = ${deployed.jndiName}
		Element Name
		elementPropertyMapping : MAP_STRING_STRING  = {jndiName=name, auth=, resourceType=type, factory=, description=, server=HOST, port=PORT, channel=CHAN, transport=TRAN, queueManager=QMGR}
		Mapping of the configuration item (CI) properties to their factory equivalents. Leave this property blank to use the same name as the key.
		elementTag : STRING  = Resource
		Element Tag
		factory : STRING  = com.ibm.mq.jms.MQQueueConnectionFactoryFactory
		Factory
		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
		resourceType : STRING  = com.ibm.mq.jms.MQQueueConnectionFactory
		Resource Type
		targetDirectory : STRING  = ${deployed.container.contextDirectory}
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING  = ${deployed.context}.xml
		Name of the artifact on the generic server.
		template : STRING  = tc/context/context-element.ftl
		Classpath to the freemarker template used to generate the content of the final text base artifact.
		transport : STRING  = 1
		Transport
		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.

---

tomcat.WebsphereMqQueueConnectionFactorySpec

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

WebSphere MQ queue connection factory installed on a Tomcat virtual host or the common context. (deployable)

		Public Properties
		channel : STRING
		Channel (string)
		context : STRING
		The name of the context that this resource is associated with (string)
		description : STRING
		Description (string) default(JMS Connection Factory)
		jndiName : STRING
		Name used to look up the resource in JNDI. (string)
		port : STRING
		Port (integer)
		queueManager : STRING
		Queue Manager (string)
		server : STRING
		Server (string)
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

---

tomcat.WebsphereMqQueueSpec

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

WebSphere MQ queue installed on a Tomcat virtual host or the common context. (deployable)

		Public Properties
		context : STRING
		The name of the context that this resource is associated with (string)
		description : STRING
		Description (string)
		jndiName : STRING
		Name used to look up the resource in JNDI. (string)
		physicalName : STRING
		Physical Name (string)
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

---

tomcat.WebsphereMqTopic

Type Hierarchy	tomcat.JeeWebsphereMqTopic >> tomcat.JndiContextElement >> tomcat.ContextElement >> generic.ProcessedTemplate >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

WebSphere MQ topic installed on a Tomcat virtual host or the common context.

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

		Public Properties
		description : STRING
		Description
		jndiName : STRING
		Name used to look up the resource in JNDI.
		physicalName : STRING
		Physical Name
		context : STRING
		The name of the context that this resource is associated with
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden Properties
		auth : STRING  = Container
		Auth
		createOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER  = 60
		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
		elementName : STRING  = ${deployed.jndiName}
		Element Name
		elementPropertyMapping : MAP_STRING_STRING  = {jndiName=name, auth=, resourceType=type, description=, factory=, physicalName=TOP}
		Mapping of the configuration item (CI) properties to their factory equivalents. Leave this property blank to use the same name as the key.
		elementTag : STRING  = Resource
		Element Tag
		factory : STRING  = com.ibm.mq.jms.MQTopicFactory
		Factory
		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
		resourceType : STRING  = com.ibm.mq.jms.MQTopic
		Resource Type
		targetDirectory : STRING  = ${deployed.container.contextDirectory}
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING  = ${deployed.context}.xml
		Name of the artifact on the generic server.
		template : STRING  = tc/context/context-element.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.

---

tomcat.WebsphereMqTopicConnectionFactory

Type Hierarchy	tomcat.JeeWebsphereMqTopicConnectionFactory >> tomcat.JndiContextElement >> tomcat.ContextElement >> generic.ProcessedTemplate >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

WebSphere MQ topic connection factory installed on a Tomcat virtual host or the common context.

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

		Public Properties
		channel : STRING
		Channel
		description : STRING  = JMS Connection Factory
		Description
		jndiName : STRING
		Name used to look up the resource in JNDI.
		port : INTEGER
		Port
		queueManager : STRING
		Queue Manager
		server : STRING
		Server
		context : STRING
		The name of the context that this resource is associated with
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden Properties
		auth : STRING  = Container
		Auth
		createOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER  = 60
		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
		elementName : STRING  = ${deployed.jndiName}
		Element Name
		elementPropertyMapping : MAP_STRING_STRING  = {jndiName=name, auth=, resourceType=type, factory=, description=, server=HOST, port=PORT, channel=CHAN, transport=TRAN, queueManager=QMGR}
		Mapping of the configuration item (CI) properties to their factory equivalents. Leave this property blank to use the same name as the key.
		elementTag : STRING  = Resource
		Element Tag
		factory : STRING  = com.ibm.mq.jms.MQTopicConnectionFactoryFactory
		Factory
		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
		resourceType : STRING  = com.ibm.mq.jms.MQTopicConnectionFactory
		Resource Type
		targetDirectory : STRING  = ${deployed.container.contextDirectory}
		Path to which artifact must be copied to on the generic server.
		targetFile : STRING  = ${deployed.context}.xml
		Name of the artifact on the generic server.
		template : STRING  = tc/context/context-element.ftl
		Classpath to the freemarker template used to generate the content of the final text base artifact.
		transport : STRING  = 1
		Transport
		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.

---

tomcat.WebsphereMqTopicConnectionFactorySpec

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

WebSphere MQ topic connection factory installed on a Tomcat virtual host or the common context. (deployable)

		Public Properties
		channel : STRING
		Channel (string)
		context : STRING
		The name of the context that this resource is associated with (string)
		description : STRING
		Description (string) default(JMS Connection Factory)
		jndiName : STRING
		Name used to look up the resource in JNDI. (string)
		port : STRING
		Port (integer)
		queueManager : STRING
		Queue Manager (string)
		server : STRING
		Server (string)
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

---

tomcat.WebsphereMqTopicSpec

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

WebSphere MQ topic installed on a Tomcat virtual host or the common context. (deployable)

		Public Properties
		context : STRING
		The name of the context that this resource is associated with (string)
		description : STRING
		Description (string)
		jndiName : STRING
		Name used to look up the resource in JNDI. (string)
		physicalName : STRING
		Physical Name (string)
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

---