TomcatAntBuilder
Ant builder with specialized defaults for Tomcat applications
Overview
TomcatAntBuilder:
Ant builder with specialized defaults for Tomcat applications
This type provides the following features over the AntBuilder type:
- catalinaHome is set as an attribute, with the default being the CATALINA_HOME environment variable.
- catalinaHome can also be set via the BuilderCatalinaHome setting.
- The catalina.home property is passed to ant by default via the antOpts attribute.
- The default package type is set to war.
Other than these defaults, functionality is identical to AntBuilder.
Design
- Super Type
- AntBuilder
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
| Notification | false |
| Template Directory | |
| Data View | Children, proximity: 1 |
| Logger Name | TomcatAntBuilder |
Constraints
Allowed Child Dependencies
- AntBuilderAntArgs1
- AntBuilderAntOpts1
- AntZip 1
- BuilderAntHome1
- BuilderAutoUpdate1
- BuilderBuildFile1
- BuilderBuildstamp1
- BuilderBuildTarget1
- BuilderCatalinaHome 1
- BuilderImportMax1
- BuilderImportMin1
- BuilderJavaHome1
- BuilderNotificationList1
- BuilderPackageBuildtimePattern1
- BuilderPackageExtension1
- BuilderPackageFilebase1
- BuilderPackageInstallRank1
- BuilderPackageInstallRank1
- BuilderPackageInstallroot1
- BuilderPackageRequireBuildstamp1
- BuilderPackageSeparator1
- BuilderPackageType1
- BuilderPackageVendor1
- BuilderPackageVersion1
- BuilderPath1
- BuilderScmBinding1
- BuilderScmConnection1
- BuilderScmLabel1
- BuilderScmModule1
- BuilderScmUser1
- BuilderScmView1
- BuilderVersionBuild1
- BuilderVersionMajor1
- BuilderVersionMinor1
- BuilderVersionRelease1
- BuilderVersionTag1
- CruiseControlInterval1
- CruiseControlMailHost1
- CruiseControlReturnAddress1
- JavaBin 1
- TomcatZip 1
1: These types have a Singleton constraint. Only one instance may be added as a resource.
Allowed Parent Dependencies
- CruiseControl
- Hudson
- Node
- Updater
Attributes
Exported Attributes
| Name | Property |
|---|---|
| basedir | deployment-basedir |
| targetdir | deployment-install-root |
Defaults for Imported Attributes
| Name | Default |
|---|---|
| antArgs | |
| antOpts | -Dcatalina.home=${entity.attribute.catalinaHome} |
| autoUpdate | false |
| buildAntHome | ${env.ANT_HOME} |
| buildFile | build.xml |
| buildPath | /bin:/usr/bin |
| buildTarget | all |
| catalinaHome | ${env.CATALINA_HOME} |
| cruiseControlInterval | 300 |
| importMax | 1 |
| importMin | 1 |
| javaHome | ${env.JAVA_HOME} |
| packageExtension | war |
| packageFilebase | .*? |
| packageInstallRank | 10 |
| packageSeparator | - |
| packageType | war |
| requireBuildstamp | false |
| scmBinding | cvs |
| scmLabel | |
| scmUser | ${user.name} |
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.
Related Types
The following types are defined for use with TomcatAntBuilder.
BuilderCatalinaHome
Overview
BuilderCatalinaHome:
The value of CATALINA_HOME to use for the build
Design
- Super Type
- BuilderSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property |
|---|---|
| catalinaHome | settingValue |