ControlTier > controltier-elements
 

TomcatSite

Centralized management for a set of Tomcat based application server instances and contexts.

Overview

TomcatSite: Centralized management for a set of Tomcat based application server instances and contexts.

This type facilitates management of a scenario where there are multiple TomcatContext objects and a TomcatServer object. The TomcatServer and TomcatContext objects will be deployed as child dependencies of a TomcatSite object. All three types will be deployed locally to the node where the TomcatServer will run. (This is contrary to the usual practice of deploying Site objects to the server where they can be used in Jobcenter. In this sense, it may help to think of TomcatSite as the replacement for a Service type; it is deployed locally and then can be added to normal Sites deployed on the server node.)

The standard service commands such as Start, Stop, or Restart can be run against objects of this type; the commands will be dispatched to its dependencies.

Design

Super Type
Site
Role Concrete. (Objects can be created.)
Instance Names Unique
Notification false
Template Directory
Data View Children, proximity: 1
Logger Name TomcatSite

Constraints

Allowed Child Dependencies

  • DefaultAllowMultiplePackageMatches1
  • DefaultDeploymentType1
  • DefaultFailIfPackageNotReplaced1
  • DefaultPackageName1
  • DefaultPackageType1
  • DispatchBaseType1
  • DispatchChangeDependencies1
  • DispatchExecutionStrategy1
  • DispatchOptions1
  • DispatchResourceName1
  • DispatchResourceType1
  • DispatchSortOrder1
  • DispatchThreadCount1
  • TomcatContext
  • TomcatServer

1: These types have a Singleton constraint. Only one instance may be added as a resource.

Allowed Parent Dependencies

  • Node
  • Site
  • Updater

Attributes

Most of these attributes are standard and can be set via the usual correspondingly-named settings. For most use cases, the defaults are sufficient.

Exported Attributes

Name Property
basedir deployment-basedir
install-root deployment-install-root

Defaults for Imported Attributes

Name Default Description
defaultAllowMultiplePackageMatches false
defaultDeploymentType Deployment
defaultFailIfPackageNotReplaced true
defaultPackageName ^$
defaultPackageType Package
dispatchBaseType (?:deployment|service|mediator)
dispatchChangeDependencies false
dispatchExecutionStrategy localdispatch This type only dispatches locally since it is meant to be deployed alongside the service types.
dispatchOptions
dispatchResourceName .*
dispatchResourceType [^\.]*
dispatchSortOrder ascending
threadCount 1 This value to avoid race conditions; if you're sure of what you're doing, you can change this in certain situations.

Commands

View the available commands in the User Reference.