APM: Build Process and Package Installation Utility

Overview

The apm utility provides commands for creating, installing, and compiling packages. The apm is a command line utility that provides a set of sub commands. This structure is similar in nature to that used by utilities such as cvs and rpm. The apm utility will typically be used to install and administer an ACS 4.0 Java installation, and during the development cycle to rebuild any modified packages.

Directory Structure

In order to understand the function of each sub command it is useful to be familiar with the directory structure of an ACS 4.0 Java installation. The following directories are important to the apm utility. The are specified relative to the root directory of the ACS installation.

APM Sub Commands

The basic functionality provided by each sub command is described below. Detailed usage information for each sub command is available by using the apm help and apm usage sub commands, or by reading the usage section of this document.

• apm bootstrap

  This command is used to rebuild the apm utility itself. It compiles all the files in WEB-INF/src and builds WEB-INF/lib/bootstrap.jar. This should only be used when source code in WEB-INF/src has changed, and only source code that is directly required by the APM utility should be placed in WEB-INF/src. It is a good idea to keep a working backup copy of bootstrap.jar so that you can easily rebuild the files in WEB-INF/src if you modify them and create a faulty bootstrap.jar.

• apm build

  This command provides a convenient way to incrementally build the source files located in the package specific source directories. By default it will build all of the packages, but you can specify a set of package keys.

• apm clean

  This command removes all the target and intermediate files generated during any of the build processes. It currently removes the following directories and all their contents.

  • WEB-INF/classes
  • WEB-INF/tmp
  • WEB-INF/lib
  • WEB-INF/boot
  • www/api-doc

• apm create

  This command creates a .apm file for the specified package key. This consists of archiving all the contents of the package's directory in the specified file.

• apm install

  This command is used to install one or more ACS packages. A package can be installed directly from a .apm archive by listing that archive on the command line, or from a directory in the file-system by listing the package's .info file on the command line. For each package specified the following operations take place:

  1. If the package specified is contained within a .apm archive then it is extracted to the packages/<pkgkey> directory.
  2. The data model create script located in the packages/<pkgkey>/sql/<pkgkey>-create.sql file is sourced.
  3. The package is registered.

• apm install-acs

  This command installs the ACS into an empty tablespace. It first goes through the install procedure defined above for the core packages, and then sources the acs-install.sql script located in the acs-kernel package. Once this steps are completed the system user is created.

• apm javadoc

  This command provides a convenient way to run javadoc on all or some of the source files in an ACS installation. It places the output in the www/api-doc directory.

APM Usage

Usage:

  apm bootstrap
    Rebuilds the bootstrap.jar file that contains the apm itself. This is
    required if you modify the source for the apm itself or any of the things
    that it depends on such as the database API. Note that if you modify the
    apm in such a way that it is incapable of rebuilding itself you will either
    need to retrieve an old bootstrap.jar file in order to rebuild it, or
    rebuild the files by hand.

  apm build
    Rebuilds all the packages as needed.

  apm build <key1> ... <keyn>
    Rebuilds the specified packages as needed.

  apm clean
    Removes all the generated files.

  apm create <apmfile> <key>
    Creates an apm from the given package.

  apm help
    Prints this message.

  apm install <file1> <file2> ...
    You may specify .apm files or .info files. If you specify a .info file it
    is expected to be located within a valid package directory structure.

  apm install-acs
    Does a complete acs install.

  apm javadoc
    Rebuilds the API level documentation into www/api-doc.

  apm javadoc <key1> ... <keyn>
    Rebuilds the API level documentation into www/api-doc. Unfortunately
    javadoc is not capable of doing incremental builds at this point, so if you
    specify only a subset of packages, you will clobber any existing
    documentation in www/api-doc.

  apm usage
    Prints this message.

Revision History