Skip to main content
Version: Deploy 24.3

Extend the Tomcat plugin

This topic provides information about the Apache Tomcat plugin for Deploy which is designed to be extended through Deploy's plugin API type system.

For more information about this plugin, see Apache Tomcat plugin.

Add context attributes​

Tomcat contexts have several attributes that can be set for a WAR file. By default, the Tomcat plugin only sets the unpackWAR and docBase attributes. When additional attributes are required, you can create a type modification on the corresponding tomcat.WarModule.

For example, to add 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>

This adds a hidden property called antiResourceLocking to the deployed, with a default value of true. 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 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 such as datasources, queues, and so on.

Add new context elements​

Tomcat contexts have several nested components or special features that can be defined in XML, such as context parameters, lifecycle listeners, and so on. You can model these features in the Tomcat plugin and then deploy these resources.

For example, to add support for the context parameter feature:

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

Add the following lines 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"/>
    <property name="elementTag" default="Resource" hidden="true"/>
    <property name="elementPropertyMapping" kind="map_string_string" hidden="true" default="paramName:name, value:, override:"/>
</type>