Font size:
TomcatServer
A tomcat deployment
Overview
TomcatServer :
A tomcat deployment
Design
Super Type
Service
Role
Concrete . (Objects can be created.)
Instance Names
Unique
Notification
false
Template Directory
Data View
Children,
proximity:
1
Logger Name
TomcatServer
Constraints
Allowed Child Dependencies
1 : These types have a Singleton constraint. Only one instance may be added as a resource.
Attributes
Exported Attributes
Name
Property
catalinaBase
deployment-basedir
catalinaHome
deployment-install-root
Defaults for Imported Attributes
Name
Default
ajpPort
8009
contextFileName
ROOT.xml
httpsPort
8443
javaHome
${env.JAVA_HOME}
port
8080
release
5.x
shutdownPort
8005
timeout
30
Commands
Note
Commandline options displayed in square brackets "[]" are optional. If an option expects arguments, then angle brackets are shown after the option "<>". Any default value is shown within the brackets.
Update
run the update cycle
Usage
Update
Workflow
Stop
War-Packages-Install
Configure
Start
Docs-Generate
generates all defined docs
Usage
Docs-Generate [-archivedir <${entity.instance.dir}/var>] [-basedir <>]
Options
Option
Description
archivedir
dir to store current output docs
basedir
tomcat instance dir
Prepare
builds the deployment objects
Usage
Prepare [-packagetype <PlatformZip>]
Workflow
Packages-Install
Configure
Options
Option
Description
packagetype
Platform packages to install
War-Packages-Install
install war package dependencies
Usage
War-Packages-Install [-packagetype <war>]
Workflow
Packages-Install
Options
Option
Description
packagetype
Platform packages to install
assertServiceIsDown
checks if the service is down
Usage
assertServiceIsDown [-port <>]
Options
Option
Description
port
listening port
assertServiceIsUp
checks if the service is running
Usage
assertServiceIsUp [-port <>]
Options
Option
Description
port
listening port
startService
starts the service
Usage
startService [-basedir <>] [-install_root <>] [-java_home <>]
Options
Option
Description
basedir
catalina base
install_root
catalina home
java_home
jre install dir
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
Related Types
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
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
TomcatPort
Overview
TomcatPort :
Port used by Tomcat
Design
Super Type
TomcatSetting
Role
Concrete . (Objects can be created.)
Instance Names
Unique
Constraints
Allowed Parent Dependencies
TomcatServerPort
Overview
TomcatServerPort :
Tomcat server port
Design
Super Type
TomcatPort
Role
Concrete . (Objects can be created.)
Instance Names
Unique
Constraints
Allowed Parent Dependencies
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
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
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
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
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
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
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
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
TomcatServer:
A tomcat deployment