Skip to end of metadata
Go to start of metadata

The AM Upgrader operates as an inline upgrade mechanism for AM when AM is deployed in LDAP SMS mode. In this mode all configuration for the server is located within the LDAP Configuration Store.

The starting point for all upgrade steps is the UpgradeStep interface which defines the contract for an upgrade step. Notice as well that there is a required annotation UpgradeStepInfo.

For this upgrade mode there is some automatic upgrade behaviour built into the upgrade framework. This is provided by the ServerUpgrade class. If your upgrade consists of any of the following operations then you may find there is no need to create an upgrade step:

  • Service Addition
  • Attribute Addition

For all other options you will need to define an upgrade step that performs the schema and configuration changes. There are numerous examples in the org.forgerock.openam.upgrade.steps package to learn from.

Related Developer Question: How do define an upgrade step?

Developer Notes

It is possible to trigger the upgrade process by simply rebuilding the AM war file and then dropping that into the container and restarting the container. AM will recognise that the timestamp of the war file is different and trigger the upgrade code.

  • No labels