TomcatServer

TomcatServer: A tomcat deployment

Super Type

Service

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

Allowed Child Dependencies

• ConfigZip
• GenerateApplicationTomcatContext ¹
• GenerateDefaultTomcatContext ¹
• JavaBin ¹
• JavaHomePath ¹
• PlatformJar
• Rdb
• tgz
• TomcatMgmtStrategy ¹
• TomcatPath ¹
• TomcatSetting
• TomcatZip ¹
• war¹

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

Allowed Parent Dependencies

• Mediator
• Node
• TomcatContext

Exported Attributes

Name	Property
catalinaBase	deployment-basedir
catalinaHome	deployment-install-root

Defaults for Imported Attributes

Name	Default
ajpPort	8009
contextFileName	ROOT.xml
generateApplicationTomcatContext	false
generateDefaultTomcatContext	false
httpsPort	8443
javaHome	${env.JAVA_HOME}
javaOptions
port	8080
release	5.x
shutdownPort	8005
timeout	10
tomcatMgmtStrategy	default
tomcatNewEnvironment	true
tomcatPath	/bin:/usr/bin

Docs-Generate

generates all defined docs

Usage

Docs-Generate [-archivedir <${entity.instance.dir}/var>] [-basedir <>] [-install_root <>] [-java_home <>] [-javaoptions <>]

Options

Option	Description
archivedir	dir to store current output docs
basedir	tomcat instance dir
install_root	tomcat installation root
java_home	tomcat java_home
javaoptions	tomcat java options

assertServiceIsDown

checks if the service is down

Usage

assertServiceIsDown [-basedir <>] [-port <>]

Options

Option	Description
basedir	tomcat base directory
port	listening port

assertServiceIsUp

checks if the service is running

Usage

assertServiceIsUp [-basedir <>] [-port <>]

Options

Option	Description
basedir	tomcat base directory
port	listening port

startService

starts the service

Usage

startService [-basedir <>] [-install_root <>] [-java_home <>] [-javaoptions <>] [-newenvironment <>] [-path <>] [-timeout <>]

Options

Option	Description
basedir	catalina base
install_root	catalina home
java_home	jre install dir
javaoptions	Java options
newenvironment	Whether or not to start Tomcat with a new environment
path	PATH to use with Tomcat
timeout	timeout in seconds

stopService

starts the service

Usage

stopService [-basedir <>] [-install_root <>] [-java_home <>] [-port <>] [-timeout <>]

Options

Option	Description
basedir	catalina base
install_root	catalina home
java_home	jre install dir
port	listening port
timeout	timeout in seconds

The following types are defined for use with TomcatServer.

FilePath

Overview

FilePath: A file path/directory

Design

Super Type

Setting

Role	Abstract. (Objects cannot be created.)
Instance Names	Unique

JavaHomePath

Overview

JavaHomePath: The Java install root

Design

Super Type

FilePath

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• Service

Attributes

Exported Attributes

Name	Property
javaHome	settingValue

TomcatSetting

Overview

TomcatSetting: Tomcat configuration setting

Design

Super Type

Setting

Role	Abstract. (Objects cannot be created.)
Instance Names	Unique

TomcatMgmtStrategy

Overview

TomcatMgmtStrategy: Specifies the Tomcat Management Strategy

Design

Super Type

TomcatSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• TomcatServer

Attributes

Exported Attributes

Name	Property
tomcatMgmtStrategy	settingValue

GenerateDefaultTomcatContext

Overview

GenerateDefaultTomcatContext: determines if a default context should be generated

Design

Super Type

TomcatSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• TomcatServer

Attributes

Exported Attributes

Name	Property
generateDefaultTomcatContext	settingValue

GenerateApplicationTomcatContext

Overview

GenerateApplicationTomcatContext: determines if a application context should be generated

Design

Super Type

TomcatSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• TomcatServer

Attributes

Exported Attributes

Name	Property
generateApplicationTomcatContext	settingValue

TomcatNewEnvironment

Overview

TomcatNewEnvironment: Whether or not to start Tomcat with a new environment

Design

Super Type

TomcatSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• TomcatServer

Attributes

Exported Attributes

Name	Property
tomcatNewEnvironment	settingValue

TomcatPath

Overview

TomcatPath: PATH used by Tomcat

Design

Super Type

TomcatSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• TomcatServer

Attributes

Exported Attributes

Name	Property
tomcatPath	settingValue

TomcatPort

Overview

TomcatPort: Port used by Tomcat

Design

Super Type

TomcatSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• TomcatServer

TomcatServerPort

Overview

TomcatServerPort: Tomcat server port

Design

Super Type

TomcatPort

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• TomcatServer

Attributes

Exported Attributes

Name	Property
port	settingValue

TomcatSecureServerPort

Overview

TomcatSecureServerPort: Tomcat secure server port

Design

Super Type

TomcatPort

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• TomcatServer

Attributes

Exported Attributes

Name	Property
httpsPort	settingValue

TomcatShutdownPort

Overview

TomcatShutdownPort: Tomcat shutdown port

Design

Super Type

TomcatPort

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• TomcatServer

Attributes

Exported Attributes

Name	Property
shutdownPort	settingValue

TomcatAjpPort

Overview

TomcatAjpPort: Tomcat Apache Jakarta Protocol port

Design

Super Type

TomcatPort

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• TomcatServer

Attributes

Exported Attributes

Name	Property
ajpPort	settingValue

TomcatRelease

Overview

TomcatRelease: Tomcat major release (e.g. 4.1, 5.x or 6.x)

Design

Super Type

TomcatSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• TomcatServer

Attributes

Exported Attributes

Name	Property
release	settingValue

TomcatJavaOptions

Overview

TomcatJavaOptions: Java runtime options (JAVA_OPTS) used when the Tomcat "start", "stop", or "run" command is executed

Design

Super Type

TomcatSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• TomcatServer

Attributes

Exported Attributes

Name	Property
javaOptions	settingValue

TomcatTimeout

Overview

TomcatTimeout: Shutdown timeout period in seconds

Design

Super Type

TomcatSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• TomcatServer

Attributes

Exported Attributes

Name	Property
timeout	settingValue

TomcatPropertyFile

Overview

TomcatPropertyFile: Shopzilla Tomcat application configuration property file name

Design

Super Type

TomcatSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• TomcatContext
• TomcatServer

Attributes

Exported Attributes

Name	Property
propertyFileName	settingValue
propertyFileTemplate	settingType

TomcatProperty

Overview

TomcatProperty: Shopzilla Tomcat configuration property setting

Design

Super Type

TomcatSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• TomcatContext
• TomcatServer