Sun Java System Access Manager 7.1 Developer's Guide

About Access Manager WAR Files

When you customize Access Manager, sometimes you must also modify the Access Manager WAR files. The modifications in turn result in changes to the web components.

Access Manager provides two types of WAR files. One type of Access Manager WAR file is automatically built and deployed for you at installation. The password.war and services.war files are of this type. Both password.war and services.warare related to features and services that power the Access Manager server. At installation, based on the source files in the staging directory AccessManager-base/web-src/, both password.war and services.war are automatically generated and deployed into the AccessManager-base/SUNWam/war directory. When you want to customize Access Manager features or services, you must make changes in the source files contained in the staging directory, and then regenerate and redeploy the appropriate WAR files.


Caution – Caution –

When you apply a patch or an upgrade to Access Manager, any customizations you have implemented may be overwritten.


The second type of Access Manager WAR is a specialized WAR file that you must manually deploy. The amaduthdistui.war for the Distributed Authentication UI, and the amclient.war for the Client SDK are such WARs. You can install amaduthdistui.war or amclient.warthrough the JES installer, or you can manually deploy one or both of them.

The following Access Manager WAR files are located in this directory:

AccessManager-base/SUNWam/

amcommon.war

Automatically deployed at installation, and builds the Liberty IDFF profile named Identity Provider Introduction which is used in implementing a circle of trust. You do not need to redeploy this WAR.

amconsole.war

If you choose the Legacy mode option during installation, this WAR is automatically deployed at installation, and builds the legacy mode administration console. Redeploy this WAR after you make changes to AccessManager-base/web-src/services/console/* source files.

ampassword.war

Automatically deployed at installation, and builds the password reset feature. Redeploy this WAR after you make changes to AccessManager-base/web-src/password/* source files.

amserver.war

Automatically deployed at installation, and builds Access Manager service components. Redeploy this WAR after you make changes to AccessManager-base/web-src/services/* source files.

The following Access Manager WARs are located in this directory:

AccessManager-base/SUNWam/war.

am_server.war

Use this WAR to manually install Access Manager as a stand-alone product, and without using the JES installer. For more information, see Chapter 12, Deploying Access Manager as a Single WAR File, in Sun Java System Access Manager 7.1 Postinstallation Guide.

amclient.war

Use this WAR to manually install the Client SDK on a container remote from the Access Manager server. For more information, see Installing the Client SDK.

amauthdistui.war

Use this WAR to manually install the Distributed Authentication UI server on a container remote from the Access Manager server. You can install this WAR using the JES installer. For more information, see Chapter 11, Deploying a Distributed Authentication UI Server, in Sun Java System Access Manager 7.1 Postinstallation Guide. You can also manually deploy this WAR. For more information, see Customizing the Distributed Authentication User Interface.

amconsole.war

Access Manager uses this WAR to build the realm mode administration console. The amconsole.war file is automatically generated and deployed, based on the source code in AccessManager-base/web-src/services/console, when Access Manager is installed. You cannot customize this WAR.

console.war

Access Manager uses this WAR to build the legacy mode administration console. The console.war file is automatically generated and deployed, based on the source code in AccessManager-base/web-src/services/console, when Access Manager is installed. You can customize this WAR. For more information, see Chapter 11, Customizing the Administration Console.

introduction.war

This WAR is related to the Liberty IDFF profile named Identity Provider Introduction which is used in implementing a circle of trust. The introduction.war file is automatically generated and deployed, based on the source code in AccessManager-base/web-src/services/common, when Access Manager is installed. You cannot customize this WAR.

password.war

Access Manager uses this WAR for the password reset service. The password.war file is automatically generated and deployed, based on the source code in AccessManager-base/web-src/services/password, when Access Manager is installed. You can customize this WAR. For more information, see the section password.war.

services.war

Access Manager uses this WAR to build the UI for various Access Manager Services. The services.war file is automatically generated and deployed, based on the source code in AccessManager-base/web-src/services/services, when Access Manager is installed. You can customize this WAR. For more information, see the section services.war.

password.war

The password.war contains files used by the Access Manager password reset service.

Files You Can Modify

You can modify the following password.war files:

Files You Must Not Modify

Do not modify the following password.war files. Modifying the following files may cause unintended Access Manager behaviors.

services.war

The services.war contains files used by various Access Manager services.

Files You Can Modify

You can modify the following services.war files:

Files You Must Not Modify

Do not modify the following services.war files. Modifying the following files may cause Access Manager to fail: