7 Using the OAAM Extensions Shared Library to Customize OAAM

Shared libraries are collections of programming and data that multiple applications can use. They can permit applications to use memory efficiently by sharing common programming and resources.

The chapter provides information on how to customize Oracle Adaptive Access Manager by using the OAAM Extensions Shared Library. It contains the following sections:

7.1 Customizing or Extending OAAM By Editing Enums

To override any Oracle Adaptive Access Manager properties or extend OAAM enumerations, add those properties and enumerations to oaam_custom.properties. Later, you will save that file in the oaam_extensions/WEB-INF/classes/bharosa_properties folder.

User-defined enums are a collection of properties that represent a list of items. Each element in the list may contain several different attributes. The definition of a user-defined enum begins with a property ending in the keyword ".enum" and has a value describing the use of the user-defined enum.

Each element definition then starts with the same property name as the enum, and adds on an element name and has a value of a unique integer as an ID. The attributes of the element follow the same pattern, beginning with the property name of the element, followed by the attribute name, with the appropriate value for that attribute.

The following is an example of an enum defining credentials displayed on the login screen of an OAAM Server implementation:

bharosa.uio.default.credentials.enum = Enum for Login Credentials
bharosa.uio.default.credentials.enum.companyid.description=Company ID

7.2 Adding Customizations Using the OAAM Extensions Shared Library

You can customize Oracle Adaptive Access Manager by adding custom JAR and JSP files and other files to the OAAM Extensions Shared Library and editing property files.

The OAAM Extensions Shared Library, oracle.oaam.extensions.war, is located in IAM_Home/oaam/oaam_extensions/generic. It is deployed in both the OAAM Server and OAAM Admin servers. By default oracle.oaam.extensions.war contains the MANIFEST.MF, which has the definition of the OAAM Extensions Shared Library.

This section provides instructions for adding customizations to Oracle Adaptive Access Manager.

7.2.1 Prerequisite

Ensure the property bharosa.uio.proxy.mode.flag is set as appropriate.

The default for the property bharosa.uio.proxy.mode.flag is false. If you are using an UIO proxy deployment, the property should be set to true. To configure custom branding for multitenancy with the OAAM Proxy, the property bharosa.uio.proxy.mode.flag must be set to true.

If you are adding customizations and also configuring integration with Oracle Access Management Access Manager 11g using the TAP scheme, the property must be set as false. Setting the property to true causes OAAM and Access Manager integration using TAP to fail with the following message:

Sorry, the identification you entered was not recognized.

7.2.2 Step 1 Extract the OAAM Extensions Shared Library

To extract the OAAM Extensions Shared Library, proceed as follows:

  1. Create a work folder named oaam_extensions.

    The folder can be created anywhere if it is outside the installation folder.

  2. Extract the oracle.oaam.extensions.war file into the work folder.

    In the oaam_extensions folder, you should see the following subfolders:

    • META-INF

    • WEB-INF

    • WEB-INF\lib

    • WEB-INF\classes

7.2.3 Step 2 Create a MANIFEST.MF File

In the META-INF folder, create a file named MANIFEST.MF and ensure it contains the following lines:

Extension-Name: oracle.oaam.extensions

The specification version and implementation version must be more than the versions in the file currently. For example, if the implementation version in the file is, you could change it to Errors are thrown if the version is not incremented.

7.2.4 Step 3 Compile Custom Java Classes

Compile custom java classes that extend or implement Oracle Adaptive Access Manager classes, adding the JAR files from the ORACLE_IDM_HOME\oaam\cli\lib folder to the build class path.

7.2.5 Step 4 Add Custom JARs and Files

Add the custom jars and files as described:

  1. Add the custom JAR files to the IAM_Home\oaam\oaam_extensions\generic\WEB-INF\lib folder.

  2. Make changes to oaam_custom.properties and save it to the oaam_extensions\WEB-INF\classes\bharosa_properties folder.

  3. Add custom JSP files directly to oaam_extensions.

7.2.6 Step 5 Repackage the OAAM Extensions Shared Library

Repackage the OAAM Extensions Shared Library, oracle.oaam.extensions.war, from the parent folder of oaam_extensions using the command:

jar -cvfm oracle.oaam.extensions.war oaam_extensions/META-INF/MANIFEST.MF -C  oaam_extensions/ .

7.2.7 Step 6 Verify If the Repackaged WAR File Contains the Custom JAR Files

Verify that the repackaged WAR file contains the custom JAR files. Use the following command to view its contents:

jar tvf oracle.oaam.extensions.war

7.2.8 Step 7 Stop All Managed Servers

Stop all managed servers if they are running:


7.2.9 Step 8 Start the WebLogic Administration Server

Start the WebLogic Administration Server:


7.2.10 Step 9 Log In to the WebLogic Administration Console

Start the WebLogic Server where Oracle Adaptive Access Manager is deployed and log in to the WebLogic Administration Console:


7.2.11 Step 10 Deploy the New OAAM Extensions Shared Library

Deploy the new oracle.oaam.extensions.war file as a shared library with oaam_server_server1 and oaam_admin_server1 as target applications.

  1. Navigate to Domain Environment > Deployments and lock the console.

  2. Click the Install button.

  3. Browse to the location of the oracle.oaam.extensions.war file and select it by clicking the option next to the WAR file and clicking Next.

  4. Ensure Install this deployment as a library is selected and click Next.

  5. Select deployment targets, oaam_admin_server1 and oaam_server_server1.

  6. Click Next again to accept the defaults in this next page and then click Finish.

  7. Click the Save button and then Activate Changes.

  8. Start the OAAM Admin and OAAM managed servers.


7.2.12 Step 11 Test the Functionality

Test the custom functionality and make sure files added to oracle.oaam.extensions.war are used by Oracle Adaptive Access Manager applications.