# Tomcat Plugin Manual

## Preface

This document describes the functionality provided by the Tomcat plugin.

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

## Overview

The Tomcat plugin is an XL Deploy plugin that adds capability for managing deployments and resources to a Tomcat Server. Standard support includes deploying/undeploying web applications, datasources, mail sessions, resource links, ActiveMQ and WebsphereMQFeatures resources. The plugin can easily be extended to support more deployment options or management of new artifacts/resources on Tomcat.

## Features

- Deployment of web applications (WAR) to a Tomcat virtual host.
- Deployment of resources to an application context on a Tomcat virtual host.
- Deployment of resources to the common Tomcat context (that is, `$TOMCAT_HOME/conf/context.xml`).
- Deployment of resource links.
- Supported JEE Resources
  - Datasource
  - JMS Queue
  - JMS Queue Connection Factory
  - JMS Topic
  - JMS Topic Connection Factory
  - Mail Session
- Supported Messaging Middleware
  - Active MQ
  - Websphere MQ
- Support for Tomcat Database Connection Pool (DBCP) Configurations
- Stopping and starting a Tomcat Server via control tasks.
- Deployment of configuration files to a Tomcat Server.
- Deployment of libraries files to a Tomcat Server.

## Requirements

- XL Deploy requirements

  - XL Deploy: version 4.5+
  - Tomcat versions: 5.5.x, 6.x, 7.x, 8.x (Unix and Windows)

- Infrastructural requirements

  - User credentials for accessing the host running the Tomcat Server.
  - Tomcat must run in the background (see Starting Tomcat).
    - On Unix, Tomcat should be installed as a daemon or the Tomcat startup script should start Tomcat in the background.
    - On Windows, you must install Tomcat as a service.

  Refer to the documentation for your version of Tomcat for information about running Tomcat in the background.

## Usage in Deployment Packages

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

The following is a sample `deployit-manifest.xml` file that can be used to create a Tomcat specific deployment package. It contain declarations for a WAR, a datasource, and a couple of JMS resources.

    <?xml version="1.0" encoding="UTF-8"?>
    <udm.DeploymentPackage version="1.0" application="SampleApp">
      <deployables>
        <jee.War name="SampleApp-1.0.war" file="SampleApp-1.0.war">
          <tags />
          <scanPlaceholders>true</scanPlaceholders>
          <checksum>b4759ef62eaf3a89db260f51ad0d1d749d22f7e4</checksum>
        </jee.War>
        <tomcat.DataSourceSpec name="testDatasource">
          <tags />
          <jndiName>jdbc/sampleDatasource</jndiName>
          <driverClassName>com.mysql.jdbc.Driver</driverClassName>
          <url>jdbc:mysql://localhost/test</url>
          <username>{{DATABASE_USERNAME}}</username>
          <password>{{DATABASE_PASSWORD}}</password>
          <connectionProperties />
        </tomcat.DataSourceSpec>
        <jee.QueueSpec name="sampleQueue">
          <tags />
          <jndiName>jms/testQueue</jndiName>
        </jee.QueueSpec>
        <jee.QueueConnectionFactorySpec name="sampleQCf">
          <tags />
          <jndiName>jms/sampleQCf</jndiName>
        </jee.QueueConnectionFactorySpec>
      </deployables>
    </udm.DeploymentPackage>

## Tomcat Topology

The Tomcat plugin allows for the modeling of a Tomcat installation into the XL Deploy infrastructure as a hierarchical set of containers. Tomcat Server, Tomcat Common Context and Tomcat Virtual Hosts containers can then be included into XL Deploy environment definitions, to which deployables can be deployed to.

### Tomcat Server

Models a Tomcat installation running on a host. This container must be defined under any Host in the XL Deploy infrastructure. The container supports OS specific stop and start commands used to control the stopping and starting of the Tomcat Server. In addition, stop and start wait times can be specified. XL Deploy will wait for the specified amount of time to elapse after the execution of a stop/start command.

### Tomcat Common Context

Models the context.xml file present in the `$TOMCAT_HOME/conf` directory. This container must be defined under a Tomcat Server container. Only a single instance should be defined. Any Tomcat Resource can be deployed to this container.

### Tomcat Virtual Host

Models a Tomcat virtual host definition (that is, `$TOMCAT_HOME/conf/[enginename]/[hostname]`). This container must be defined under a Tomcat Server container. Multiple instances can be defined. Web Applications and Tomcat Resource can be deployed to this container.

## Using the deployables and deployeds

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

### Deployable vs. Container table

Deployable | Container | Deployed
--- | --- | ---
jee.War | tomcat.VirtualHost | tomcat.WarModule
tomcat.ResourceLinkSpec | tomcat.VirtualHost tomcat.CommonContext | tomcat.ResourceLink
tomcat.DataSourceLinkSpec | tomcat.VirtualHost tomcat.CommonContext | tomcat.DataSourceLink
jee.DataSourceSpec | tomcat.VirtualHost tomcat.CommonContext | tomcat.DataSource
jee.MailSessionSpec | tomcat.VirtualHost tomcat.CommonContext | tomcat.MailSession
jee.QueueConnectionFactorySpec tomcat.ActiveMqConnectionFactorySpec tomcat.WebsphereMqQueueConnectionFactorySpec | tomcat.VirtualHost tomcat.CommonContext | tomcat.ActiveMqConnectionFactory tomcat.WebsphereMqQueueConnectionFactory
jee.TopicConnectionFactorySpec tomcat.WebsphereMqTopicConnectionFactorySpec | tomcat.VirtualHost tomcat.CommonContext | tomcat.WebsphereMqTopicConnectionFactory
jee.QueueSpec tomcat.ActiveMqQueueSpec tomcat.WebsphereMqQueueSpec | tomcat.VirtualHost tomcat.CommonContext | tomcat.ActiveMqQueue tomcat.WebsphereMqQueue
jee.TopicSpec tomcat.ActiveMqTopicSpec tomcat.WebsphereMqTopicSpec | tomcat.VirtualHost tomcat.CommonContext | tomcat.ActiveMqTopic tomcat.WebsphereMqTopic
tomcat.ConfigurationFolder | tomcat.Server | tomcat.DeployedConfigurationFolder
tomcat.ConfigurationFile | tomcat.Server | tomcat.DeployedConfigurationFile
tomcat.Library | tomcat.Server | tomcat.DeployedLibrary

### Deployed Actions Table

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

Deployed | Actions performed for operations
--- | ---
| Create | Destroy | Modify
tomcat.WarModule | Stop Tomcat If `manageContextXml` is true, create a context XML file using the context root name specified on the war in the virtual host's directory (that is, `$TOMCAT_HOME/conf/Catalina/localhost`) Upload WAR to virtual host's application base directory (that is, `$TOMCAT_HOME/webapps`) Start Tomcat | Stop Tomcat Delete WAR from virtual host's application base directory. Delete exploded WAR folder from virtual host's application base directory. If `manageContextXml` is true, remove attributes (such as docBase) from the Context element in the application specific context XML file If `manageContextXml` is true, remove the application-specific context XML file Start Tomcat | Stop Tomcat Delete WAR from virtual host's application base directory. Delete exploded WAR folder from virtual host's application base directory. If `manageContextXml` is true, remove attributes (such as docBase) from the Context element in the application-specific context XML file If WAR context root changed, rename application-specific context XML in the virtual host's directory to the new context root name. If `manageContextXml` is true, modify attributes (such as docBase) from the Context element in the application-specific context XML file Upload WAR to virtual host's application base directory (that is, `$TOMCAT_HOME/webapps`) Start Tomcat
Any tomcat.JndiContextElement (tomcat.DataSource, tomcat.ActiveMqQueue, tomcat.ResourceLink, etc) | Stop Tomcat Create XML fragment (that is, `<Resource name='mail/Session' auth='Container' type='javax.mail.Session' mail.smtp.host='localhost'/>`) Insert XML fragment into context XML Start Tomcat | Stop Tomcat Find XML fragment in context XML using the name attribute Delete XML fragment from context XML Start Tomcat | Stop Tomcat Find XML fragment in context XML using the name attribute Delete XML fragment from context XML Create XML fragment (that is, `<Resource name='mail/Session' auth='Container' type='javax.mail.Session' mail.smtp.host='localhost'/>`) Insert XML fragment into context XML Start Tomcat
tomcat.DeployedConfigurationFolder | Stop Tomcat Copy files to the target directory Start Tomcat | Stop Tomcat Delete files from the target directory Start Tomcat | Stop Tomcat Delete files from the target directory Copy files to the target directory Start Tomcat

## Deploying Web Applications

Web Applications can be deployed to a Tomcat Virtual Host. The context root must be specified. The context root is used to create the corresponding application specific context XML in the virtual host. If you want to deploy the WAR file in the exploded mode, you need to package the WAR file using tomcat.ExplodedWar instead of jee.War.

## Deploying Resources

Tomcat Resource can be deployed to a Tomcat Virtual Host or Tomcat Common Context. Every resource has an optional context property. This property is always set to context when the resource is deployed to Tomcat Common Context. When the resource is deployed to a Tomcat Virtual Host, the user can specify the name of the context to which the resource must be defined.

When left blank, the plugin can default the value to that of the WAR in the current deployment. There must only be a single WAR in the current deployment for the defaulting to work. For example, deploying a WAR with context root set to sample, and a datasource to a virtual host will automatically result in the context property of the datasource been set to sample.

## Extension points

The Tomcat plugin is designed to be extended through XL Deploy's Plugin API type system. Refer to Customization Manual for an explanation of the type system.

### Adding additional context attributes

Tomcat context's have several attributes that can be set for a WAR. By default, the Tomcat plugin only sets the unpackWAR and docBase attributes. When additional attributes are required, performing a type modification on the corresponding tomcat.WarModule can be done.

For example, adding support for the `antiResourceLocking` attribute in `synthetic.xml`:

    <type-modification type="tomcat.WarModule">
        <property name="antiResourceLocking" default="true" hidden="true"/>
        <property name="contextElementPropertyMapping" kind="map_string_string" hidden="true"
                  default="unpackWAR:, docBase:, antiResourceLocking:"
    </type-modification>

An additional hidden property `antiResourceLocking` with a default value of "true" is added to the deployed. The property is added to the `contextElementPropertyMapping` property's default value. This property is used to translate properties on the deployed to their XML equivalent in the Tomcat context. The left side represents the property name in the deployed, while the right hand side represents the attribute name in the XML. When the right side is blank, the property name and XML equivalent are the same.

The same technique can be used to add attributes to other Tomcat resources like datasource, queues, and so on.

### Adding new context elements

Tomcat contexts have several nested components or special features (Context Parameters, Lifecycle Listeners, and so on), that can be defined in the XML.

It is possible to model these features in the Tomcat plugin and perform subsequence deployments of these resources. For example, adding support for the Context Parameter feature.

    <Context>
      ...
      <Parameter name="companyName" value="My Company, Incorporated"
             override="false"/>
      ...
    </Context>

Add to `synthetic.xml`:

    <type type="tomcat.ContextParameter" extends="tomcat.ContextElement"
                deployable-type="tomcat.ContextParameterSpec">
        <generate-deployable type="tomcat.ContextParameterSpec" extends="jee.ResourceSpec"/>
        <property name="paramName" description="The name of the context parameter"/>
        <property name="value"/>
        <property name="override" kind="boolean" required="false" default="false"/>

        <!--inherited hidden -->
        <property name="targetDirectory" default="${deployed.container.contextDirectory}" hidden="true"/>
        <property name="targetFile" default="${deployed.context}.xml" hidden="true"/>
        <property name="template" default="tc/context/context-element.ftl" hidden="true"/>
    </type>

## Troubleshooting

### Starting Tomcat

XL Deploy expects the Tomcat start command to return and leave Tomcat running. This means that the default Tomcat start script will cause XL Deploy to hang during deployment. You can specify start and stop commands on the Tomcat server.

For example, to start and stop Tomcat 7 when it is installed as a daemon on Unix, use `service tomcat7 start` or `/etc/init.d/tomcat7 start`. On Windows, use `net start tomcat7`.

Tip: If your start and stop scripts only return when Tomcat is actually started or stopped, set the wait times on the Tomcat server to 0.

### Restarting Tomcat after deployment

If you are running Tomcat on Unix and you find that the Tomcat server does not restart after application deployment, you may need to use the `nohup` command with the `sleep` option. This ensures that the SSH connection is not closed before the restart is processed. For example:

    nohup /usr/local/apache-tomcat-7.0.42/bin/catalina.sh start && sleep 2

### Disabling management of context.xml

If you find that the Tomcat plugin deploys additional files that cause conflicts, you may need to disable its management of the `context.xml` file, as described in the deployed actions table. To disable management, locate the following line in the `<XLDEPLOY_HOME>/conf/deployit-defaults.properties` file:

    #tomcat.manageContextXml=true

Change the line to:

    tomcat.manageContextXml=false

## Release notes

Version 4.5.1

- Improvements
- DEPL-7790 - Make start/stop steps in tomcat-plugin idempotent
- Bug
- DEPL-7962 - Fixed issue where undeploying a WAR would not remove the configuration XML from all containers in the environment
- DEPL-6448 - Fixed issue where Tomcat start/stop scripts would only work when Tomcat was installed on C: drive

Version 4.5.0

- Compatible with XL Deploy 4.5

Version 4.0.0

- Compatible with XL Deploy 4.0
- DEPL-5534: Added support for Tomcat 8

Version 3.8.0

- Updated to use plugin-api-3.8.0

Version 3.7.0

- Bug
  - [DEPLOYITPB-2988] - The Tomcat plugin contains an upgrader that is not needed

Version 3.6.0

- Bug
  - [DEPLOYITPB-2728] - Cannot create War Settings for petclinic on Windows using Tomcat Plugin
  - [DEPLOYITPB-2746] - Type "tomcat.TomcatServer" should be called "tomcat.Server"

## CI Reference

### Configuration Item Overview

#### Deployables

#### Deployeds

#### Containers

#### Other Configuration Items

### Configuration Item Details

#### jee.DataSourceSpec

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

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.Taggable, udm.Deployable, udm.SourceArtifact, udm.ArchiveArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, 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
|  | 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.Taggable, udm.Deployable, udm.SourceArtifact, udm.ArchiveArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, 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
|  | 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.Taggable, udm.Deployable, udm.ConfigurationItem

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.Taggable, udm.Deployable, udm.ConfigurationItem

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.Taggable, udm.Deployable, udm.ConfigurationItem

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.Taggable, udm.Deployable, udm.ConfigurationItem

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.Taggable, udm.Deployable, udm.ConfigurationItem

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.Taggable, udm.Deployable, udm.ConfigurationItem

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.Taggable, udm.Deployable, udm.ConfigurationItem

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.Taggable, udm.Deployable, udm.SourceArtifact, udm.ArchiveArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, 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
|  | 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 to 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 lookup 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 CI properties to there factory equivalent. A blank value assumes 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.Taggable, udm.Deployable, udm.ConfigurationItem

ActiveMq Connection Factory installed to 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 lookup 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 to 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 lookup 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 CI properties to there factory equivalent. A blank value assumes 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.Taggable, udm.Deployable, udm.ConfigurationItem

ActiveMq queue installed to 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 lookup 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 to 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 lookup 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 CI properties to there factory equivalent. A blank value assumes 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.Taggable, udm.Deployable, udm.ConfigurationItem

ActiveMq topic installed to 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 lookup 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.Taggable, udm.ConfigurationItem, udm.Container, generic.GenericContainer, overthere.HostContainer

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.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

File containing application configurations that 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
|  | 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.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FolderArtifact

Folder containing files for application configuration that 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
|  | 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.Taggable, udm.ConfigurationItem, generic.GenericContainer, udm.Container, overthere.HostContainer

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.
|  | 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.
|  | restartWaitTime : INTEGER = 0
|  | The time to wait in seconds for a container restart action.
|  | 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.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

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.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

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 to 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 be used.
|  | jndiName : STRING
|  | Name used to lookup the resource in JNDI.
|  | password : STRING
|  | The connection password to be passed to our JDBC driver to establish a connection.
|  | url : STRING
|  | The connection URL to be passed to our JDBC driver to establish a connection.
|  | username : STRING
|  | The connection username to be passed to our JDBC driver to establish a connection.
|  | connectionProperties : MAP_STRING_STRING
|  | The connection properties that will be sent to our 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, or negative for no limit.
|  | maxIdle : INTEGER = 8
|  | The maximum number of connections that can remain idle in the pool, without extra ones being released, or 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, or -1 to wait indefinitely.
|  | minIdle : INTEGER = 0
|  | The minimum number of connections that can remain idle in the pool, without extra ones being created, or 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 CI properties to there factory equivalent. A blank value assumes 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

To create a datasoure link to a global JNDI resource. Doing a JNDI lookup on the link name will then return the linked global resource. Installed to 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 CI properties to there factory equivalent. A blank value assumes 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 expected by the web application 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.Taggable, udm.Deployable, udm.ConfigurationItem

To create a datasoure link to a global JNDI resource. Doing a JNDI lookup on the link name will then return the linked global resource. Installed to 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 expected by the web application 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.Taggable, udm.Deployable, udm.ConfigurationItem

DataSource installed to a Tomcat Virtual Host or the Common Context (deployable)

|  | Public Properties
--- | --- | ---
|  | connectionProperties : MAP_STRING_STRING
|  | The connection properties that will be sent to our 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 be used. (string)
|  | initialSize : STRING
|  | The initial number of connections that are created when the pool is started. (integer) default(0)
|  | jndiName : STRING
|  | Name used to lookup the resource in JNDI. (string)
|  | maxActive : STRING
|  | The maximum number of active connections that can be allocated from this pool at the same time, or negative for no limit. (integer) default(8)
|  | maxIdle : STRING
|  | The maximum number of connections that can remain idle in the pool, without extra ones being released, or 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, or -1 to wait indefinitely. (integer) default(-1)
|  | minIdle : STRING
|  | The minimum number of connections that can remain idle in the pool, without extra ones being created, or zero to create none. (integer) default(0)
|  | password : STRING
|  | The connection password to be passed to our 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 be passed to our JDBC driver to establish a connection. (string)
|  | username : STRING
|  | The connection username to be passed to our 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.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

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.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

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.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

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.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FolderArtifact

Exploded War installed to 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
|  | 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.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Exploded War installed to 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. A blank value assumes 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 to 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 lookup 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 CI properties to there factory equivalent. A blank value assumes 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 to 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 lookup 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 CI properties to there factory equivalent. A blank value assumes 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 to 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 lookup 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 CI properties to there factory equivalent. A blank value assumes 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

WebsphereMq queue installed to 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 lookup 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 CI properties to there factory equivalent. A blank value assumes 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

WebsphereMq Queue Connection Factory installed to 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 lookup 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 CI properties to there factory equivalent. A blank value assumes 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

WebsphereMq topic installed to 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 lookup 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 CI properties to there factory equivalent. A blank value assumes 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

WebsphereMq Topic Connection Factory installed to 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 lookup 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 CI properties to there factory equivalent. A blank value assumes 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 to 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 lookup 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 CI properties to there factory equivalent. A blank value assumes 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.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, 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
|  | 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 to 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 lookup the resource in JNDI.
|  | smtpHost : STRING
|  | Points at 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 CI properties to there factory equivalent. A blank value assumes 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.Taggable, udm.Deployable, udm.ConfigurationItem

Mail Session installed to 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 lookup the resource in JNDI. (string)
|  | smtpHost : STRING
|  | Points at 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

To create a link to a global JNDI resource. Doing a JNDI lookup on the link name will then return the linked global resource. Installed to 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 expected by the web application 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 CI properties to there factory equivalent. A blank value assumes 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.Taggable, udm.Deployable, udm.ConfigurationItem

To create a link to a global JNDI resource. Doing a JNDI lookup on the link name will then return the linked global resource. Installed to 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 expected by the web application 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.Taggable, udm.ConfigurationItem, generic.GenericContainer, udm.Container, overthere.HostContainer

Tomcat server on 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
|  | Duration (in secs) to wait after the start server step has been executed
|  | stopCommand : STRING
|  | Operating system-specific command used to stop Tomcat.
|  | stopWaitTime : INTEGER = 0
|  | Duration (in secs) to wait after the stop server step has been 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.Taggable, udm.ConfigurationItem, udm.Container, generic.GenericContainer, overthere.HostContainer

Represents a virtual host, which is an association of a network name for a server (such as 'www.mycompany.com' with the particular 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 pathname of a directory that may contain web applications to be deployed on this virtual host. You may specify a pathname 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.Taggable, udm.Deployable, udm.SourceArtifact, udm.ArchiveArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

War installed to 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
|  | 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.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

War installed to 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. A blank value assumes 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

WebsphereMq queue installed to 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 lookup 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 CI properties to there factory equivalent. A blank value assumes 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

WebsphereMq Queue Connection Factory installed to 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 lookup 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 CI properties to there factory equivalent. A blank value assumes 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.Taggable, udm.Deployable, udm.ConfigurationItem

WebsphereMq Queue Connection Factory installed to 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 lookup 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.Taggable, udm.Deployable, udm.ConfigurationItem

WebsphereMq queue installed to 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 lookup 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

WebsphereMq topic installed to 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 lookup 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 CI properties to there factory equivalent. A blank value assumes 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

WebsphereMq Topic Connection Factory installed to 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 lookup 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 CI properties to there factory equivalent. A blank value assumes 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.Taggable, udm.Deployable, udm.ConfigurationItem

WebsphereMq Topic Connection Factory installed to 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 lookup 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.Taggable, udm.Deployable, udm.ConfigurationItem

WebsphereMq topic installed to 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 lookup 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.