Skip Headers
Oracle® Identity Manager Installation and Configuration Guide for JBoss Application Server
Release 9.1.0

Part Number E10369-04
Go to Documentation Home
Go to Book List
Book List
Go to Table of Contents
Go to Index
Go to Feedback page
Contact Us

Go to previous page
Go to next page
View PDF

7 Postinstallation Configuration for Oracle Identity Manager and JBoss Application Server

After installing Oracle Identity Manager, you must complete some postinstallation tasks before using the application. Depending on the deployment, you might choose not to perform some of these tasks. The following is a list of the postinstallation tasks documented in this chapter:


The examples in this chapter are Microsoft Windows-based, however the postinstallation tasks apply to UNIX as well.

7.1 Default JMS Queue Configuration

In releases earlier than 9.1.0, Oracle Identity Manager uses a single JMS queue (named xlQueue) for all asynchronous operations including requests, reconciliation, attestation, and offline tasks. Release 9.1.0 onward, by default, Oracle Identity Manager uses separate JMS queues for specific operations to optimize JMS queue processing. The following list shows the JMS queues in the default configuration and indicates the operation related to each queue:

7.2 Reserving JBoss Application Server Ports on Microsoft Windows Installation

Perform the following steps to reserve the necessary ports for JBoss Application Server on Microsoft Windows installation:

  1. Select Run from the Windows Start menu. The Run dialog box is displayed.

  2. Enter regedt32 in the Run dialog box and click OK. The Registry Editor window is displayed.

  3. Navigate to the following registry key:

  4. If it does not already exist, create a ReservedPorts value, as follows:

    1. Point to New on the Edit menu and click Multi-String Value.

    2. Enter ReservedPorts as the value name and press Enter.

  5. Double-click the ReservedPorts value. The Edit Multi-String dialog box is displayed.

  6. In the Edit Multi-String dialog box, enter 1098-1434 in the Value data box.

  7. Click OK to close the Edit Multi-String dialog box, and then close the Registry Editor window.

7.3 Changing Keystore Passwords

During installation, the passwords for the Oracle Identity Manager keystores are set to xellerate. The Installer scripts and installation log contain this default password. It is strongly recommended that you change the keystore passwords for all production installations.

To change the keystore passwords, you must change the storepass of .xlkeystore and the keypass of the xell entry in .xlkeystore—and these two values must be identical. Use the keytool and the following steps to change the keystore passwords:

  1. Open a command prompt on the Oracle Identity Manager host computer.

  2. Navigate to the OIM_HOME\xellerate\config directory.

  3. Run the keytool with the following options to change the storepass:

    JAVA_HOME\jre\bin\keytool -storepasswd -new new_password -storepass xellerate -keystore .xlkeystore -storetype JKS
  4. Run the keytool with the following options to change the keypass of the xell entry in .xlkeystore:

    JAVA_HOME\jre\bin\keytool -keypasswd -alias xell -keypass xellerate -new new_password -keystore .xlkeystore -storepass new_password


    Replace new_password with the same password entered in step 3.

    Table 7-1 lists the options used in the preceding example of keytool usage.

    Table 7-1 Command Options for the keytool Utility

    Option Description


    Location of the Java directory associated with the application server


    New password for the keystore

    -keystore option

    Keystore whose password you are changing (.xlkeystore for Oracle Identity Manager or .xldatabasekey for the database)

    -storetype option

    JKS for .xlkeystore and JCEKS for .xldatabasekey

  5. Open OIM_HOME\xellerate\config\xlconfig.xml in a text editor.

  6. Edit the <xl-configuration>.<Security>.<XLPKIProvider>.<KeyStore> section, <xl-configuration>.<Security>.<XLPKIProvider>.<Keys> section, and <RMSecurity>.<KeyStore> section to specify the keystore password as follows:


    Change the <XLSymmetricProvider>.<KeyStore> section of the configuration file to update the password for the database keystore (.xldatabasekey).
    • Change the password tag to encrypted="false".

    • Enter the password (in the clear), for example:

            <Password encrypted="false">new_password</Password>
      <Password encrypted="false">new_password</Password> 
      <Password encrypted="false">new_password</Password> 
  7. Save and close the xlconfig.xml file.

  8. Restart the application server.

    When you stop and start the application server, a backup of the configuration file is created. The configuration file (with the new password) is read in, and the password is encrypted in the file.

  9. If all of the preceding steps have succeeded, you can delete the backup file.


    On UNIX, you might also want to clear the shell's command history by using the following command:

    history -c

7.4 Setting Log Levels

Oracle Identity Manager uses log4j for logging. For JBoss-based installations, logging is configured in the log4j.xml file.

By default, the log level is set to Warning, except for DDM, for which the log level is set to Debug by default. You can change the log level universally for all components or for an individual component. For normal operation of Oracle Identity Manager, this postinstallation configuration step is not required.

7.4.1 Oracle Identity Manager Component Logging

The components are listed in the OIM_HOME\xellerate\config\ file in the XELLERATE section. They are:


7.4.2 Setting Log Levels for JBoss Application Server

The log4j.xml file is used for all logging with JBoss Application Server; therefore, Oracle Identity Manager components use an Xellerate tag. The log4j.xml file contains a general setting for Xellerate:

<category name="XELLERATE">
  <priority value="WARN" />

You can change the log level for all components by editing the priority value of the general setting, or for a specific component by adding a new logging category element.

The available categories are listed in the file in the XELLERATE section. See Oracle Identity Manager Component Logging for more information.

For example, to change the level for Oracle Identity Manager, add the following element to the log4j.xml file:

<category name="XELLERATE.SERVER">
  <priority value="WARN" />
  <appender-ref ref="FILE"/>

To set Oracle Identity Manager log levels in JBoss Application Server:

  1. Open the JBOSS_HOME\server\default\conf\log4j.xml file in a text editor.

  2. Insert an element for the desired component.

  3. Set the priority value to the appropriate level for the desired components.

    The following is a list of the supported log levels, appearing in descending order of information logged (DEBUG logs the most information and FATAL logs the least information):

    • DEBUG

    • INFO

    • WARN

    • ERROR

    • FATAL

  4. Save your changes.

7.5 Enabling Single Sign-On (SSO) for Oracle Identity Manager

The following procedure describes how to enable Single Sign-On for Oracle Identity Manager with ASCII character logins. To enable Single Sign-On with non-ASCII character logins, use the following procedure—but include the additional configuration setting described in step 4.

See Also:

Oracle Identity Manager Best Practices Guide for additional information about configuring Single Sign-On for Oracle Identity Manager with Oracle Access Manager.


Header names comprised only of alphabetic characters are certified. Oracle recommends that you do not use special characters or numeric characters in header names.

To enable Single Sign-On for Oracle Identity Manager:

  1. Stop the application server gracefully.

  2. Open OIM_HOME/xellerate/config/xlconfig.xmlin a text editor.

  3. Locate the following Single Sign-On configuration (the following are the default settings without Single Sign-On):

  4. Edit the Single Sign-On configuration to the following and replace SSO_HEADER_NAME with the appropriate header configured in your Single Sign-On system:


    To enable Single Sign-On with non-ASCII character logins, you must include a decoding class name to decode the non-ASCII header value. Add the decoding class name and edit the Single Sign-On configuration as follows:


    Replace SSO_HEADER_NAME with the appropriate header configured in your Single Sign-On system.

  5. Change your application server and Web server configuration to enable Single Sign-On by referring to your application and Web server vendor documentation.

  6. Restart the application server.

7.6 Configuring Multiple JBoss Application Server Installations to Use a Single Database

When two or more non-clustered JBoss Application Server installations connected to a load balancer point to a single database, you must configure the individual JBoss Application Server instances to use different JMS tables.

Complete the following procedure on the second and all other JBoss Application Server instances by using the same Oracle Identity Manager database so they use different JMS tables:

  1. Open the JBOSS_HOME\server\default\deploy\jms\database_name-jdbc2-service.xml in a text editor.

    Note that database_name refers to the common database used by multiple JBoss Application Server instances.

  2. In all the queries and statements in the sqlProperties section of the database_name-jdbc2-service.xml, change the names of the tables represented by JMS_MESSAGES and JMS_TRANSACTIONS to new, unique, and valid values.

  3. Add the following statements to the end of the file:

        WHERE TXOP='T'


    NEW_JMS_MESSAGES_NAME represents the new name of the JMS_MESSAGES tables you changed in step 2.
  4. Save and close the file.

7.7 Configuring Custom Authentication

This section describes how to use custom authentication solutions with Oracle Identity Manager.

Oracle Identity Manager deploys a Java Authentication and Authorization Service (JAAS) module to authenticate users. For unattended logins, which require offline message processing and scheduled task execution, Oracle Identity Manager uses signature-based authentication. Although you should use JAAS to handle signature-based authentication, you can create a custom authentication solution to handle standard authentication requests.


The Oracle Identity Manager JAAS module must be deployed on your application server and should be the first invoked authenticator.

To enable custom authentication on JBoss Application Server, you implement a custom authentication module class. Oracle Identity Manager will then delegate standard authentication requests to the custom authentication module.

To implement custom authentication for JBoss Application Server:

  1. Open the OIM_HOME\config\xlconfig.xml file in a text editor and add the following element, replacing CustomLoginModule with the name of your custom login module class.

  2. Optional. Specify configuration properties for the custom authentication module by opening the JBOSS_HOME\config\login-config.xml file in a text editor and adding a module option within the <login-module> element for the package. Oracle Identity Manager will delegate the specified properties to the custom authentication module class. For example, the following rolesProperties module option will be delegated to the custom authentication module class.

    <application-policy name = "xellerate">
          <login-module code=
               flag = "required" >
             <module-option name =
             <module-option name = 
             <module-option name = 
          </login-module>    </authentication>
  3. Copy your custom authentication JAR file to the JBOSS_HOME\server\default\lib directory.

7.7.1 Protecting the JNDI Namespace

When you specify a custom authentication solution, you should also protect the Java Naming and Directory Interface (JNDI) namespace to ensure that only designated users have permission to view resources. The primary purpose of protecting the JNDI namespace is to protect Oracle Identity Manager from any malicious applications that might be installed in the same application server instance. Even if no other applications, malicious or otherwise, are installed in the same application server instance as Oracle Identity Manager, you should protect your JNDI namespace as a routine security measure.

To protect your JNDI namespace and configure Oracle Identity Manager to access it:

  1. Open the OIM_HOME\config\xlconfig.xml file in a text editor and add the following elements to the <Discovery> element:

  2. To optionally encrypt the JNDI password, add an encrypted attribute that is assigned a value of true to the <> element, and assign the password as the element's value, as follows:

  3. Add the following elements to the <Scheduler> element:


7.7.2 Increasing the Transaction Timeout

You might have to increase the transaction timeout values for JBoss Application Servers, as the default values can be low for certain transactions. Oracle recommends the values specified in the following step:

Open the JBOSS_HOME\server\default\conf\jboss-service.xml file and ensure that transaction timeout attribute value is set to 1200 as follows:

<attribute name="TransactionTimeout">1200</attribute>


- For clustered JBoss Application Server, the corresponding file is located at JBOSS_HOME\server\all\conf\jboss-service.xml.

- JBoss Application Server clustered environments are not supported in Oracle Identity Manager release 9.1.0. See "Certified Components" in Oracle Identity Manager Release Notes for information about certified components.

7.8 Setting the Compiler Path for Adapter Compilation

To compile adapters or import Deployment Manager XML files that have adapters, you must set the compiler path. To set the compiler path for adapter compilation, you must first install the Design Console. See Chapter 10, "Installing and Configuring the Oracle Identity Manager Design Console" for instructions on installing the Design Console and then setting the compiler path for adapter compilation.

7.9 Encrypting Oracle Identity Manager Database Password in the xell-ds.xml File for JBoss Application Server

By default, JBoss Application Server does not encrypt data source passwords, as described in the JBoss document at

This section describes how to encrypt the Oracle Identity Manager database password in JBoss Application Server deployments. Specifically, you must perform the following steps to manually encrypt a password, and then modify the xell-ds.xml and login-config.xml files so that they can access the encrypted form of the password instead of the clear text version:


For a clustered installation, repeat this procedure on all the nodes of the cluster.
  1. Open a console window and navigate to the JBOSS_HOME directory.

  2. Run one of the following commands to encrypt the Oracle Identity Manager database password. In this command, replace password with the actual password that you want to encrypt.


    java -cp "JBOSS_HOME/lib/jboss-jmx.jar:lib/jboss-common.jar:server/ default/lib/jboss-jca.jar:server/default/lib/jbosssx.jar" password

    Microsoft Windows

    java -cp "JBOSS_HOME/lib/jboss-jmx.jar;lib/jboss-common.jar;server/ default/lib/jboss-jca.jar;server/default/lib/jbosssx.jar" password
  3. The command you run in the previous step returns an encoded form of the password you specify. For example, the password Welcome1 is encoded as 3146f9cc50afd6a6df8592078de921bc. Highlight and copy the encoded password.

  4. Open the JBOSS_HOME/server/default/deploy/xell-ds.xml file in a text editor.

  5. Delete the <user-name> and <password> elements from the <local-tx-datasource> element.

  6. Add the following <security-domain> element to the end of the <local-tx-datasource> element:

  7. Delete the <xa-datasource-property name="User"> and <xa-datasource-property name="Password"> elements from the <xa-datasource> element.

  8. Add the following <security-domain> element to the end of the <xa-datasource> element:

  9. Save and close the JBOSS_HOME/server/default/deploy/xell-ds.xml file.

  10. Open the JBOSS_HOME/server/default/conf/login-config.xml file in a text editor.

  11. Add the following elements to the <application-policy> element:


    Replace datasource_username with the datasource user name and encoded_password with the encoded password you copy in Step 3.
    <application-policy name = "EncryptDBPassword">
      <login-module code = "" flag = "required">
       <module-option name = "username">datasource_username</module-option>
       <module-option name = "password">encoded_password</module-option>
       <module-option name = "managedConnectionFactoryName">jboss.jca:service=LocalTxCM,name=jdbc/xlDS</module-option>
    <application-policy name = "EncryptXADBPassword">
      <login-module code = "" flag = "required">
       <module-option name = "username">datasource_username</module-option>
       <module-option name = "password">encoded_password</module-option>
       <module-option name = "managedConnectionFactoryName">jboss.jca:service=XATxCM,name=jdbc/xlXADS</module-option>
  12. Save and close the JBOSS_HOME/server/default/deploy/login-config.xml file.

7.10 Deploying the SPML Web Service

Organizations can have multiple provisioning systems that exchange information about the modification of user records. In addition, there can be applications that must interact with multiple provisioning systems. The SPML Web Service provides a layer over Oracle Identity Manager to interpret SPML requests and convert them to Oracle Identity Manager calls.

The SPML Web Service is packaged in a deployable Enterprise Archive (EAR) file. This file is generated when you install Oracle Identity Manager.

Because the EAR file is generated while you install Oracle Identity Manager, a separate batch file in the Oracle Identity Manager home directory runs the scripts that deploy the SPML Web Service on the application server on which Oracle Identity Manager is running. You must run the batch file to deploy the SPML Web Service.

For details about the SPML Web Service, see Chapter 12, "The SPML Web Service" in Oracle Identity Manager Tools Reference.

7.11 Tuning JDBC Connection Pools

To implement tuning for the JDBC connection pools used by Oracle Identity Manager, open JBOSS_HOME/server/default/deploy/xell-ds.xml file and implement the following changes:


- For a clustered installation of Oracle Identity Manager on JBoss Application Server, the xell-ds.xml file can be located at JBOSS_HOME/server/all/farm.

- JBoss Application Server clustered environments are not supported in Oracle Identity Manager release 9.1.0. See "Certified Components" in Oracle Identity Manager Release Notes for information about certified components.

- It is strongly recommended that you implement the suggested tuning for the JDBC connection pools used by Oracle Identity Manager. This can be further tuned based on the application usage.

  1. For jdbc/xlDS pool, insert the following before the line </local-tx-datasource>:

  2. For jdbc/xlXADS pool, insert the code mentioned in step 1 before the line </xa-datasource>.

  3. Restart JBoss Application Server.