TomcatContext
Tomcat web application service (extended to support a custom context and an "external" property file)
Overview
TomcatContext:
Tomcat web application service (extended to support a custom context and an "external" property file)
Design
- Super Type
- Service
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
| Notification | false |
| Template Directory | |
| Data View | Children, proximity: 1 |
| Logger Name | TomcatContext |
Constraints
Allowed Child Dependencies
- DefaultDeploymentType1
- DefaultPackageName1
- DefaultPackageType1
- DispatchChangeDependencies1
- TomcatContextFile 1
- TomcatProperty
- TomcatPropertyFile1
- TomcatRestartStrategy 1
- TomcatServer 1
- war1
1: These types have a Singleton constraint. Only one instance may be added as a resource.
Allowed Parent Dependencies
- Mediator
- Node
Attributes
Exported Attributes
| Name | Property |
|---|---|
| catalinaBase | deployment-basedir |
| catalinaHome | deployment-install-root |
Defaults for Imported Attributes
| Name | Default |
|---|---|
| contextFileName | ROOT.xml |
| defaultDeploymentType | Deployment |
| defaultPackageName | ^$ |
| defaultPackageType | war |
| dispatchChangeDependencies | false |
| tomcatRestartStrategy | none |
Commands
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 |
Packages-Install
install package dependencies
- Usage
- Packages-Install [-buildstamp <>] [-packagetype <[^\.]*>] [-restartStrategy <>]
Options
| Option | Description |
|---|---|
| buildstamp | build identifer. currently ignored |
| packagetype | type of packages to install |
| restartStrategy | determines the start strategy |
Configure
Configures the instance
- Usage
- Configure [-restartStrategy <>]
Options
| Option | Description |
|---|---|
| restartStrategy | determines the stop strategy |
War-Packages-Install
install war package dependencies
- Usage
- War-Packages-Install [-packagetype <war>]
Workflow
Options
| Option | Description |
|---|---|
| packagetype | Platform packages to install |
stopService
executes the stop procedure
- Usage
- stopService [-restartStrategy <>]
Options
| Option | Description |
|---|---|
| restartStrategy | determines the stop strategy |
startService
executes the start procedure
- Usage
- startService [-restartStrategy <>]
Options
| Option | Description |
|---|---|
| restartStrategy | determines the start strategy |
assertServiceIsUp
asserts if service is up
- Usage
- assertServiceIsUp [-restartStrategy <>]
Options
| Option | Description |
|---|---|
| restartStrategy | determines the start strategy |
assertServiceIsDown
asserts if service is down
- Usage
- assertServiceIsDown [-restartStrategy <>]
Options
| Option | Description |
|---|---|
| restartStrategy | determines the stop strategy |
Related Types
The following types are defined for use with TomcatContext.
TomcatSetting
Overview
TomcatSetting:
Tomcat configuration setting
Design
- Super Type
- Setting
| Role | Abstract. (Objects cannot be created.) |
| Instance Names | Unique |
TomcatContextFile
Overview
TomcatContextFile:
Tomcat application context path file name
Design
- Super Type
- TomcatSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| contextFileName | settingValue |
TomcatRestartStrategy
Overview
TomcatRestartStrategy:
x
Design
- Super Type
- TomcatSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| tomcatRestartStrategy | settingValue |