4.9. Bundle Hooks

The following is a table of Bundle hooks. A bundle hook is simply a script inside a bundle's "actions" directory executed in response to a BundleWorks command. For UNIX-based and Linux systems, these hooks are shell scripts with an extension of .sh (e.g., install.sh). For Windows-based systems, these hooks are batch scripts with an extension of .bat (e.g., install.bat).

Note that a bundle does not have to implement all hooks.

Table 4.3. Bundle Hooks

setupExecuted during bw add
teardownExecuted during bw remove
installExecuted during bw deploy if first deploy
upgradeExecuted during bw deploy if older version found
rollbackExecuted during bw deploy if newer version found
uninstallExecuted during bw undeploy
loadExecuted during use
unloadExecuted during use to unload a previously loaded bundle
hourlyExecuted during bw taskrun hourly
dailyExecuted during bw taskrun daily
weeklyExecuted during bw taskrun weekly
startExecuted during a start command
runExecuted during a run command
stopExecuted during a stop command
killExecuted during a kill command
statusExecuted during a status command
{other}Custom commands can be defined for bundles. Executed by name.