AtgPlatformInstaller
ATG (JBoss) Platform self-extracting installer package
Overview
Design
- Super Type
- bin
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
| Notification | false |
| Template Directory | ${modules.dir}/AtgPlatformInstaller/templates |
| Data View | Children, proximity: 1 |
| Logger Name | AtgPlatformInstaller |
Constraints
Allowed Child Dependencies
- Package
Allowed Parent Dependencies
- Assembly
Allowed Property Values
| Property | Allowed Values | Default | Enforced |
|---|---|---|---|
| package-install-root |
|
|
false |
| package-repo-url |
|
|
false |
| package-filetype |
|
|
false |
| package-arch |
|
|
false |
| package-install-rank |
|
|
false |
Attributes
Exported Attributes
| Name | Property |
|---|---|
| atg_home | package-install-root |
| atgplatform_release | package-release |
| atgplatform_version | package-version |
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.
Install
Install object and run the package installation cycle.
- Usage
- Install [-basedir <>] [-depot <>] [-installroot <>] [-name <>] [-nodeps] [-nodir] [-nomodule] [-nopackageinstall] [-noproperties] [-subdirs <>] [-type <>]
Workflow
Error Handler
| Command |
Options
| Option | Description |
|---|---|
| basedir | instance directory |
| depot | project depot |
| installroot | package installroot |
| name | object name |
| nodeps | do not install dependencies |
| nodir | do not create directories |
| nomodule | do not update module |
| nopackageinstall | do not install package |
| noproperties | do not update properties |
| subdirs | directory list |
| type | object type |
assertPackageIsInstalled
Confirm the package process is installed.
- Usage
- assertPackageIsInstalled [-basedir <>] [-depot <>] [-executable <>] [-installroot <>] [-name <>] [-nodeps] [-nodir] [-nomodule] [-nopackageinstall] [-noproperties] [-script <>] [-subdirs <>] [-type <>]
Options
| Option | Description |
|---|---|
| basedir | instance directory |
| depot | project depot |
| executable | executable to run |
| installroot | package installroot |
| name | object name |
| nodeps | do not install dependencies |
| nodir | do not create directories |
| nomodule | do not update module |
| nopackageinstall | do not install package |
| noproperties | do not update properties |
| script | script to execute |
| subdirs | directory list |
| type | object type |
installPackage
Run the package installation cycle.
- Usage
- installPackage [-basedir <>] [-depot <>] -filename <> [-filtersfile <>] -installroot <> [-name <>] [-nodeps] [-nodir] [-nomodule] [-nopackageinstall] [-noproperties] [-subdirs <>] [-type <>] -url <>
Workflow
- installDependencies
- prepare
- get
- extract
- finish
Options
| Option | Description |
|---|---|
| basedir | instance directory |
| depot | project depot |
| filename | the filename |
| filtersfile | filtersfile |
| installroot | the install root |
| name | object name |
| nodeps | do not install dependencies |
| nodir | do not create directories |
| nomodule | do not update module |
| nopackageinstall | do not install package |
| noproperties | do not update properties |
| subdirs | directory list |
| type | object type |
| url | the repo url |
extract
Runs the ATG Platform InstallAnywhere installer non-interactively (i.e. in "silent" mode)
- Usage
- extract [-atgjbossroot <>] [-atgjdkhome <>] [-atglistenport <8080>] [-atgrmiport <8860>] [-base <>] -filename <> [-filtersfile <>] -installroot <> [-propertiestemplate <${module.dir}/templates/jboss.installer.properties.template>] -url <>
Options
| Option | Description |
|---|---|
| atgjbossroot | JBoss root directory to use for the install (ATG_JBOSS_ROOT) |
| atgjdkhome | Java home directory to use for the install (ATG_JDK_HOME) |
| atglistenport | Listener port to use for the install (ATG_LISTEN_PORT) |
| atgrmiport | RMI port to use for the install (ATG_RMI_PORT) |
| base | package base name |
| filename | the filename |
| filtersfile | filtersfile |
| installroot | the install root |
| propertiestemplate | Template property file to provide options to silent install |
| url | the repo url |



