The LDAP Gateway acts as the intermediary between Oracle Identity Manager and the connector components on the mainframe. The following sections of this chapter describe the procedure to deploy some components of the connector, including the LDAP Gateway, on the Oracle Identity Manager host computer:
Note:
The procedure to deploy the mainframe components of the connector is described in the next chapter.Section 3.1, "Files and Directories that Comprise the Connector"
Section 3.2, "Determining the Release Number of the Connector"
Section 3.8, "Configuring Oracle Identity Manager for Request-Based Provisioning"
Table 3-1 describes the contents of the connector installation media.
Table 3-1 Files and Directories that Comprise the Connector
| Files and Directories | Description |
|---|---|
|
configuration/ACF2Adv.xml |
This XML file contains configuration information that is used during connector installation. |
|
DataSets/ProvisionResource_OIMACF2ResourceObject.xmlDataSets/ModifyResource_OIMACF2ResourceObject.xml |
This XML file specifies the information to be submitted by the requester during a request-based provisioning operation. Section 3.8, "Configuring Oracle Identity Manager for Request-Based Provisioning" provides more information. |
|
etc/LDAP Gateway/ldapgateway.zip |
This ZIP file contains the files required to deploy the LDAP Gateway. |
|
etc/Provisioning and Reconciliation Connector/Mainframe_ACF2.zip |
This ZIP file contains the files required to deploy the Reconciliation and Provisioning Agents on the mainframe. |
|
Files in the resources directory |
Each of these resource bundles contains locale-specific information that is used by the connector. During connector installation, this file is copied to the following location:
Note: A resource bundle is a file containing localized versions of text strings that are displayed on the Administrative and User Console. These text strings include GUI element labels and messages. |
|
For Oracle Identity Manager Release 9.1.0.x: lib/acf2-provisioning-adapter.jar For Oracle Identity Manager Release 11.1.1: lib-11G/acf2-provisioning-adapter.jar |
This JAR file contains the code for the adapters that are used during connector operations. During connector installation, this file is copied to the following location:
|
|
For Oracle Identity Manager Release 9.1.0.x: lib/acf2-scheduled-tasks.jar For Oracle Identity Manager Release 11.1.1: lib-11G/acf2-scheduled-tasks.jar |
This JAR file contains the code for the scheduled task that is used during full reconciliation. During connector installation, this file is copied to the following location:
|
|
For Oracle Identity Manager Release 9.1.0.x: scripts/propertyEncrypt.bat scripts/propertyEncrypt.sh For Oracle Identity Manager Release 11.1.1: scripts-11G/propertyEncrypt.bat scripts-11G/propertyEncrypt.sh |
This script is used to encrypt the password of the user account that you create for the LDAP Gateway. |
|
xml/oimAcf2AdvConnector.xml |
This XML file contains definitions of the connector components, such as the IT resource and resource object. These objects are created in Oracle Identity Manager when you import the XML file. |
|
xml/Acf2TrustedXellerateUser.xml |
This XML file contains definitions of the connector components that are used for trusted source reconciliation. |
Note:
If you are using Oracle Identity Manager Release 9.1.0.x, then the procedure described in this section is optional.If you are using Oracle Identity Manager Release 11.1.1, then skip this section.
You might have a deployment of an earlier release of the connector. While deploying the latest release, you might want to know the release number of the earlier release. To determine the release number of the connector that has already been deployed:
In a temporary directory, extract the contents of the connector JAR file that is in the OIM_HOME/xellerate/JavaTasks directory.
Open the Manifest.mf file in a text editor. The Manifest.mf file is one of the files bundled inside the connector JAR file.
In the Manifest.mf file, the release number of the connector is displayed as the value of the Version property.
Prior to running the Connector Installer, you will need to delete the script and lib directories that do not pertain to your Oracle Identity Manager release version.
If running Oracle Identity Manager Release 9.1.0.x:
Delete the "scripts-11G" directory from the connector package.
Delete the "lib-11G" directory from the connector package.
If running Oracle Identity Manager Release 11.1.1:
Delete the "scripts" directory from the connector package.
Delete the "lib" directory from the connector package.
Rename the "scripts-11G" directory to "scripts".
Rename the "lib-11G" directory to "lib".
To run the Connector Installer:
Copy the contents of the connector installation media directory into the following directory:
Note:
In an Oracle Identity Manager cluster, copy this JAR file to each node of the cluster.For Oracle Identity Manager Release 9.1.0.x: OIM_HOME/xellerate/ConnectorDefaultDirectory
For Oracle Identity Manager Release 11.1.1: OIM_HOME/server/ConnectorDefaultDirectory
Log in to the Administrative and User Console by using the user account described in the "Creating the User Account for Installing Connectors" section of the following guide:
For Oracle Identity Manager Release 9.1.0.x:
Oracle Identity Manager Administrative and User Console Guide
For Oracle Identity Manager Release 11.1.1:
Oracle Fusion Middleware Administrator's Guide for Oracle Identity Manager
Depending on the Oracle Identity Manager release you are using, perform one of the following steps:
For Oracle Identity Manager Release 9.1.0.x:
Click Deployment Management, and then click Install Connector.
For Oracle Identity Manager Release 11.1.1:
On the Welcome to Identity Manager Advanced Administration page, in the System Management region, click Install Connector.
From the Connector List list, select CA ACF2 Advanced RELEASE_NUMBER. This list displays the names and release numbers of connectors whose installation files you copy into the default connector installation directory in Step 1.
If you have copied the installation files into a different directory, then:
In the Alternative Directory field, enter the full path and name of that directory.
To repopulate the list of connectors in the Connector List list, click Refresh.
From the Connector List list, select CA ACF2 Advanced RELEASE_NUMBER.
Click Load.
To start the installation process, click Continue.
The following tasks are performed in sequence:
Configuration of connector libraries
Import of the connector Target Resource user configuration XML file (by using the Deployment Manager). If you want to import the target system as a trusted source for reconciliation, then see Section 3.7, "Configuring Trusted Source Reconciliation."
Compilation of adapters
On successful completion of a task, a check mark is displayed for the task. If a task fails, then an X mark and a message stating the reason for failure are displayed. Depending on the reason for the failure, make the required correction and then perform one of the following steps:
Retry the installation by clicking Retry.
Cancel the installation and begin again from Step 1.
If all three tasks of the connector installation process are successful, then a message indicating successful installation is displayed. In addition, a list of the steps that you must perform after the installation is displayed. These steps are as follows:
Ensuring that the prerequisites for using the connector are addressed
Note:
At this stage, run the Oracle Identity Manager PurgeCache utility to load the server cache with content from the connector resource bundle in order to view the list of prerequisites. See Section 3.6.1, "Clearing Content Related to Connector Resource Bundles from the Server Cache" for information about running the PurgeCache utility.There are no prerequisites for some predefined connectors.
Configuring the IT resource for the connector
Record the name of the IT resource displayed on this page. The procedure to configure the IT resource is described later in this guide.
Configuring the scheduled task that is created when you installed the connector
Note:
In Oracle Identity Manager Release 11.1.1, a scheduled job is an instance of a scheduled task. In this guide, the term scheduled task used in the context of Oracle Identity Manager Release 9.1.0.x is the same as the term scheduled job in the context of Oracle Identity Manager Release 11.1.1.See Oracle Fusion Middleware Administrator's Guide for Oracle Identity Manager for more information about scheduled tasks and scheduled jobs.
Record the name of the scheduled task displayed on this page. The procedure to configure this scheduled task is described later in this guide.
When you run the Connector Installer, it copies the connector files and external code files to destination directories on the Oracle Identity Manager host computer. These files are listed in Table 3-1.
Installing the Connector in an Oracle Identity Manager Cluster
While installing Oracle Identity Manager in a cluster, you must copy all the JAR files and the contents of the connectorResources directory into the corresponding directories on each node of the cluster. See Section 3.1, "Files and Directories that Comprise the Connector" for information about the files that you must copy and their destination locations on the Oracle Identity Manager server.
You must specify values for the parameters of the Acf2Resource IT resource as follows:
Log in to the Administrative and User Console.
If you are using Oracle Identity Manager Release 9.1.0.x, expand Resource Management, and then click Manage IT Resource.
If you are using Oracle Identity Manager Release 11.1.1, then:
On the Welcome page, click Advanced in the upper-right corner of the page.
On the Welcome to Oracle Identity Manager Advanced Administration page, in the Configuration region, click Manage IT Resource.
In the IT Resource Name field on the Manage IT Resource page, enter Acf2Resource and then click Search.
Click the edit icon for the IT resource.
From the list at the top of the page, select Details and Parameters.
Specify values for the parameters of the IT resource. Table 3-2 describes each parameter.
Table 3-2 IT Resource Parameters
| Parameter | Description |
|---|---|
|
AtMap User |
This parameter holds the name of the lookup definition containing attribute mappings that are used for provisioning. Value: Note: You must not change the value of this parameter. |
|
idfPrincipalDn |
Set a user ID for an account that the connector will use to connect to the LDAP Gateway. Format: Sample value: You also set this user ID in the following files:
|
|
idfPrincipalPwd |
Set a password for the account that the connector will use to connect to the LDAP Gateway. You also set this password in the files listed in the description of the idfPrincipalDn parameter. |
|
idfRootContext |
This parameter holds the root context for CA ACF2. Value: Note: You must not change the value of this parameter. |
|
idfServerHost |
This parameter holds the host name of the computer on which you install the LDAP Gateway. For this release of the connector, you install the LDAP Gateway on the Oracle Identity Manager host computer. Value: Note: You must not change the value of this parameter. |
|
idfServerPort |
Enter the number of the port for connecting to the LDAP Gateway. Sample value: You also set this port number in the beans.xml inside the idfserver.jar file. See Step 6 in Section 3.9, "Installing and Configuring the LDAP Gateway." |
|
idfSsl |
This parameter determines whether the LDAP Gateway will use SSL to connect to the target system. Enter 'true' if using SSL; otherwise enter 'false'. Value: |
|
idfTrustStore |
This parameter holds the directory location of the trust store containing the SSL certificate. This parameter is optional, and should only be entered when using SSL authentication. Sample value: |
|
idfTrustStorePassword |
This parameter holds the password for the SSL trust store. This parameter is optional, and should only be entered when using SSL authentication. |
|
idfTrustStoreType |
This parameter holds the trust store type for the SSL trust store. This parameter is optional, and should only be entered when using SSL authentication. Sample value: |
|
Last Modified Time Stamp |
The most recent start time of the Reconcile LDAP Users reconciliation scheduled task is stored in this parameter. See Section 6.8, "Reconciling Internal LDAP Users to Oracle Identity Manager" for more information about this scheduled task. The format of the value stored in this parameter is as follows:
In this format:
|
To save the values, click Update.
Configuring Oracle Identity Manager involves the following procedures:
Note:
In an Oracle Identity Manager cluster, perform these steps on each node of the cluster.Note:
In an Oracle Identity Manager cluster, you must perform this step on each node of the cluster. Then, restart each node.When you deploy the connector, the resource bundles are copied from the resources directory on the installation media into the OIM_HOME/xellerate/connectorResources directory for Oracle Identity Manager Release 9.1.0.x, and Oracle Identity Manager database for Oracle Identity Manager Release 11.1.1. Whenever you add a new resource bundle to the connectorResources directory or make a change in an existing resource bundle, you must clear content related to connector resource bundles from the server cache.
To clear content related to connector resource bundles from the server cache:
In a command window, perform one of the following steps:
If you are using Oracle Identity Manager Release 9.1.0.x, then switch to the OIM_HOME/xellerate/bin directory.
If you are using Oracle Identity Manager Release 11.1.1, then switch to the OIM_HOME/server/bin directory.
Note:
You must perform Step 1 before you perform Step 2. An exception is thrown if you run the command described in Step 2 as follows:For Oracle Identity Manager Release 9.1.0.x:
OIM_HOME/xellerate/bin/SCRIPT_FILE_NAME
For Oracle Identity Manager Release 11.1.1:
OIM_HOME/server/bin/SCRIPT_FILE_NAME
Enter one of the following commands:
Note:
You can use the PurgeCache utility to purge the cache for any content category. RunPurgeCache.bat CATEGORY_NAME on Microsoft Windows or PurgeCache.sh CATEGORY_NAME on UNIX. The CATEGORY_NAME argument represents the name of the content category that must be purged.
For example, the following commands purge Metadata entries from the server cache:
PurgeCache.bat MetaData
PurgeCache.sh MetaData
For Oracle Identity Manager Release 9.1.0.x:
On Microsoft Windows: PurgeCache.bat ConnectorResourceBundle
On UNIX: PurgeCache.sh ConnectorResourceBundle
Note:
You can ignore the exception that is thrown when you perform Step 2. This exception is different from the one mentioned in Step 1.In this command, ConnectorResourceBundle is one of the content categories that you can delete from the server cache. See the following file for information about the other content categories:
OIM_HOME/xellerate/config/xlconfig.xml
For Oracle Identity Manager Release 11.1.1:
On Microsoft Windows: PurgeCache.bat All
On UNIX: PurgeCache.sh All
When prompted, enter the user name and password of an account belonging to the SYSTEM ADMINISTRATORS group. In addition, you are prompted to enter the service URL in the following format:
t3://OIM_HOST_NAME:OIM_PORT_NUMBER
In this format:
Replace OIM_HOST_NAME with the host name or IP address of the Oracle Identity Manager host computer.
Replace OIM_PORT_NUMBER with the port on which Oracle Identity Manager is listening.
See Oracle Fusion Middleware Administrator's Guide for Oracle Identity Manager for more information about the PurgeCache utility.
When you enable logging, Oracle Identity Manager automatically stores in a log file information about events that occur during the course of provisioning and reconciliation operations. Oracle Identity Manager uses Oracle Java Diagnostic Logging (OJDL) for logging. OJDL is based on java.util.logger.
To specify the type of event for which you want logging to take place, you can set the log level to one of the following:
ERROR:1
WARNING:1
NOTIFICATION:1
NOTIFICATION:16
TRACE:1
TRACE:16
TRACE:32
See Message Types and Levels in Oracle Fusion Middleware Administering Oracle Identity Manager for more information about the log levels.
Oracle Identity Manager level logging operations are managed by the logging.xml file which is located in the following directory:
DOMAIN_NAME/config/fmwconfig/servers/SERVER_NAME/
Loggers are used to configure logging operations for the Oracle Identity Manager functions of the connector.
To configure loggers:
In a text editor, open the DOMAIN_NAME/config/fmwconfig/servers/SERVER_NAME/logging.xml file.
Locate the logger you want to configure. If you are adding a logger for the first time, you must create the logger definition. Table 3-3, "Logger Parameters" lists the Oracle Identity Manager loggers for this connector.
| Logger | Description |
|---|---|
|
com.identityforge.util.acf2.LdapOperationsImpl |
Logs events related to basic LDAP functions, including connecting to and disconnecting from the LDAP gateway. |
|
com.identityforge.util.acf2.tasks.DeleteReconcileOIMUsersTask |
Logs events related to the ACF2 Delete OIM Users scheduled task. |
|
com.identityforge.util.acf2.tasks.FindAllAccessRulesTask |
Logs events related to the ACF2 Find All Access Rules scheduled task. |
|
com.identityforge.util.acf2.tasks.FindAllResourcesTask |
Logs events related to the ACF2 Find All Resources scheduled task. |
|
com.identityforge.util.acf2.tasks.ReconcileAllLdapUsersTask |
Logs events related to the ACF2 Resources scheduled task. |
|
com.identityforge.util.acf2.tasks.ReconcileAllUsersTask |
Logs events related to the ACF2 Reconcile All Users scheduled task. |
|
com.identityforge.util.acf2.tasks.ReconcileUsersToInternalLdapTask |
Logs events related to the ACF2 Reconcile Users to Internal LDAP scheduled task. |
Note:
This section describes an optional procedure. Perform this procedure only if you want to configure CA ACF2 as a trusted source for identity data. By performing this procedure, you enable trusted source reconciliation for both full reconciliation runs and incremental reconciliation.Section 4.1, "Performing Full Reconciliation" describe the remaining steps for configuring trusted source reconciliation.
The XML file for trusted source reconciliation, Acf2TrustedXellerateUser.xml, contains definitions of the connector components that are used for trusted source reconciliation. To import this XML file:
Open the Oracle Identity Manager Administrative and User Console.
If you are using Oracle Identity Manager Release 9.1.0.x, then:
Click the Deployment Management link on the left navigation pane.
Click the Import link under Deployment Management. A dialog box for opening files is displayed.
If you are using Oracle Identity Manager Release 11.1.1, then:
On the Welcome page, click Advanced in the upper-right corner of the page.
On the Welcome to Oracle Identity Manager Advanced Administration page, in the System Management region, click Import Deployment Manager File. A dialog box for opening files is displayed.
Locate and open the Acf2TrustedXellerateUser.xml file from the xml directory on the installation media. Details of this XML file are shown on the File Preview page.
Click Add File. The Substitutions page is displayed.
Click Next. The Confirmation page is displayed.
Click Import.
In the message that is displayed, click Import to confirm that you want to import the XML file and then click OK.
Note:
Perform the procedure described in this section only if you are using Oracle Identity Manager Release 11.1.1 and you want to configure request-based provisioning.In request-based provisioning, an end user creates a request for a resource by using the Administrative and User Console. Administrators or other users can also create requests for a particular user. Requests for a particular resource on the resource can be viewed and approved by approvers designated in Oracle Identity Manager.
The following are features of request-based provisioning:
A user can be provisioned only one resource (account) on the target system.
Note:
Direct provisioning allows the provisioning of multiple target system accounts on the target system.Direct provisioning cannot be used if you enable request-based provisioning.
To configure request-based provisioning, perform the following procedures:
A request dataset is an XML file that specifies the information to be submitted by the requester during a provisioning operation. Predefined request datasets are shipped with this connector. These request datasets specify information about the default set of attributes for which the requester must submit information during a request-based provisioning operation. The following predefined request datasets are available in the DataSets directory on the installation media:
ProvisionResource_OIMACF2ResourceObject.xml
ModifyResource_OIMACF2ResourceObject.xml
Copy these files from the installation media to any directory on the Oracle Identity Manager host computer. It is recommended that you create a directory structure as follows:
/custom/connector/RESOURCE_NAME
For example:
E:\MyDatasets\custom\connector\acf2Adv
Note:
Until you complete the procedure to configure request-based provisioning, ensure that there are no other files or directories inside the parent directory in which you create the directory structure. In the preceding example, ensure that there are no other files or directories inside the E:\MyDatasets directory.The directory structure to which you copy the dataset files is the MDS location into which these files are imported after you run the Oracle Identity Manager MDS Import utility. The procedure to import dataset files is described in the next section.
Depending on your requirement, you can modify the file names of the request datasets. In addition, you can modify the information in the request datasets. See Oracle Fusion Middleware Developer's Guide for Oracle Identity Manager for information on modifying request datasets.
All request datasets must be imported into the metadata store (MDS), which can be done by using the Oracle Identity Manager MDS Import utility.
To import a request dataset definition into MDS:
Ensure that you have set the environment for running the MDS Import utility. See Oracle Fusion Middleware Developer's Guide for Oracle Identity Manager for detailed information about setting up the environment for MDS utilities.
Note:
While setting up the properties in the weblogic.properties file, ensure that the value of the metadata_from_loc property is the parent directory of the /custom/connector/RESOURCE_NAME directory. For example, while performing the procedure in Section 3.8.1, "Copying Predefined Request Datasets," if you copy the files to the E:\MyDatasets\custom\connector\acf2Adv directory, then set the value of the metada_from_loc property toE:\MyDatasets.In a command window, change to the OIM_HOME\server\bin directory.
Run one of the following commands:
On Microsoft Windows
weblogicImportMetadata.bat
On UNIX
weblogicImportMetadata.sh
When prompted, enter the following values:
Please enter your username [weblogic]
Enter the username used to log in to the WebLogic server
Sample value: WL_User
Please enter your password [weblogic]
Enter the password used to log in to the WebLogic server.
Please enter your server URL [t3://localhost:7001]
Enter the URL of the application server in the following format:
t3://HOST_NAME_IP_ADDRESS:PORT
In this format, replace:
HOST_NAME_IP_ADDRESS with the host name or IP address of the computer on which Oracle Identity Manager is installed.
PORT with the port on which Oracle Identity Manager is listening.
The request dataset is imported into MDS at the following location:
/custom/connector/RESOURCE_NAME
To enable the Auto Save Form feature:
Log in to the Design Console.
Expand Process Management, and then double-click Process Definition.
Search for and open the OIMACF2ProvisioningProcess process definition.
Select the Auto Save Form check box.
Click the Save icon.
Run the PurgeCache utility to clear content belonging to the Metadata category from the server cache. See Section 3.6.1, "Clearing Content Related to Connector Resource Bundles from the Server Cache" for instructions.
The procedure to configure request-based provisioning ends with this step.
The IT resource contains connection information for Oracle Identity Manager to connect to the LDAP Gateway. The acf2.properties file is one of the components of the gateway. This file contains information used by the gateway to connect to the mainframe. Configuring the gateway involves setting values in the acf2.properties file and the other files that constitute the gateway.
Note:
In addition to the following procedure, see Section 5.4, "Configuring the Connector for Provisioning to Multiple Installations of the Target System" if you want to configure the connector to work with multiple LPARs on the IBM z/OS system.To install and configure the LDAP Gateway:
Extract the contents of the ldapgateway.zip file to a directory on the computer on which you want to install the LDAP Gateway. This ZIP file is in the etc/LDAP Gateway directory on the installation media.
Note:
In this document, the location (and name) of the ldapgateway directory on the Oracle Identity Manager host computer is referred to as LDAP_INSTALL_DIR.Copy the acf2-adv-agent-recon.jar andVOYAGER_ID.properties files from the lib directory on the installation media to the LDAP_INSTALL_DIR/etc directory.
In a text editor, open the LDAP_INSTALL_DIR/conf/acf2.properties file. Enter values for the properties listed in this file. Table 3-4 describes these properties.
Table 3-4 Properties in the acf2.properties File
| Property | Description |
|---|---|
|
agentPort |
Enter the number of the port on the LDAP Gateway host computer from which the Reconciliation Agent sends messages. |
|
_configAttrs_ |
If you create a custom attribute on the target system, then add the name of that attribute to the value of the _configAttrs_ property. These attributes assume NAME (VALUE) format. This step is mentioned in the following sections: Section 5.1, "Adding New Attributes for Target Resource Reconciliation" |
|
defaultDelete |
Enter one of the following as the value of this property:
For example:
# DEFAULT ACTION WHEN DELETE FUNCTION USED
_defaultDelete_=delete
|
|
host |
Set the host name or IP address of the mainframe as the value of this property. |
|
_uidNumberBefore_ |
Set this to "true" if using standard ACF2 header definition that has the UID NUMBER located before the NAME field. (true|false) |
|
_uidNumberLength_ |
The length of the UID NUMBER. Default is 8 (LOGIN ID). |
|
_customListFormat_ |
Used only for custom header attributes that have no attribute name and located after the NAME. |
|
_customListSpaces_ |
Does custom header attribute contain spaces between value (true|false). |
|
_stcID_ |
Set this to the Pioneer STC: This will allow to ignoreEvents that were already sent from Oracle Identity Manager. |
|
port |
Enter the number of the port on the mainframe that you are going to reserve for the provisioning agent. The LDAP Gateway will send provisioning messages to this port. |
|
_internalEnt_ |
Enter one of the following as the value of this property:
|
Save and close the acf2.properties file.
Open the LDAP_INSTALL_DIR/etc/VOYAGER_ID.properties file and set a value for the following property:
_itResource_
Enter the name of the IT resource that you define by performing the procedure described in Section 3.5, "Configuring the IT Resource."
_xlAdminId_
Use the xlAdminId property to specify the user ID of a user belonging to the SYSTEM ADMINISTRATORS group.
_xlAdminPwd_
Use the xlAdminPwd property to specify the password of the user whose user ID you specify as the value of the xlAdminId property. This property is used only on Oracle Identity Manager Release 11.1.1. If required, you can encrypt the password for security purposes. You can use the propertyEncrypt script to encrypt passwords. This script is in the scripts directory on the installation media. The procedure to use the script is given in Step 6. After you run the script, copy the encrypted password as the value of the xlAdminPwd property.
_xlAdminPwdEncrypt_
Enter true as the value of the xlAdminPwdEncrypt property if you have set an encrypted password as the value of the xlAdminPwd property. Otherwise, enter false. This property is used only on Oracle Identity Manager Release 11.1.1.
_xlJndiUrl_
This property is used only on Oracle Identity Manager Release 11.1.1.
To determine the JNDI URL:
In a text editor, open the following file:
OIM_DC_HOME/xlclient/Config/xlconfig.xml
Here, OIM_DC_HOME is the name and full path of the directory in which you install the Oracle Identity Manager Design Console.
Copy the value of the java.naming.provider.url element.
Set the value for the xlJndiUrl property.
Sample value: t3://localhost:14000/oim
_xlJndiFactory_
The default value is weblogic.jndi.WLInitialContextFactory. Do not change this default value. This property is used only on Oracle Identity Manager Release 11.1.1.
From the LDAP_INSTALL_DIR/dist/idfserver.jar file, extract the beans.xml file, open it in an editor, and set values for the following:
LDAP Gateway user credentials
You use the beans.xml file to store the credentials of the account used by Oracle Identity Manager to connect to the LDAP Gateway. You also enter these credentials as parameters of the IT resource. During provisioning and reconciliation, credentials passed through the IT resource are authenticated against the credentials stored in the beans.xml file. The LDAP Gateway exchanges data with the other connector components only after this authentication succeeds.
Note:
In these lines, the values that you can change are highlighted in bold font. The values that you enter in the beans.xml file must be the same as values that you specify in the IT resource parameters.You enter the credentials of the LDAP Gateway user in the following lines of the beans.xml file:
<property name="adminUserDN" value="cn=idfAcf2Admin,dc=acf2,dc=com"/> <property name="adminUserPassword" value="idfAcf2Pwd"/>
In the first line, replace the sample value cn=idfAcf2Admin,dc=acf2,dc=com with the value that you set for the idfPrincipalDn parameter of the IT resource. In the second line, replace the sample value idfAcf2Pwd with the value that you set for the idfPrincipalPwd parameter of the IT resource. Table 3-2, "IT Resource Parameters" describes both parameters. If you want to encrypt the password before you enter it in the beans.xml file, then:
Note:
It is optional to encrypt the password that you set in the beans.xml file. However, it is recommended that you encrypt the password for security reasons.You must enter the unencrypted password as the value of the idfPrincipalPwd IT resource parameter. This is regardless of whether you enter the encrypted password in the beans.xml file.
In a text editor, copy one of the following script files from the installation media into a temporary directory and then open the script file in a text editor:
For Microsoft Windows:
/scripts/propertyEncrypt.bat
For UNIX:
/scripts/propertyEncrypt.sh
Specify values for the following properties in the file:
SET CLASSPATH=DIRECTORY_LOCATION\idfserver.jar
Replace DIRECTORY_LOCATION with the full path of the directory into which you copied the idfserver.jar file while deploying the connector.
For example:
SET CLASSPATH=C:\software\ldapgateway\dist\idfserver.jar
%JAVACMD% %JVM_OPTS% -cp %CLASSPATH% com.identityforge.idfserver.util.AESCipherUtil PLAINTEXT_PASSWORD
Replace PLAINTEXT_PASSWORD with the password that you want to encrypt.
For example:
%JAVACMD% %JVM_OPTS% -cp %CLASSPATH% com.identityforge.idfserver.util.AESCipherUtil idfAcf2Pwd
Save the changes made to the propertyEncrypt.bat or propertyEncrypt.sh script.
Run the script.
The script encrypts the password that you provide and displays it in the command window.
In the beans.xml file, search for the following string:
<property name="adminUserPassword"
Replace the value of this property with the encrypted password.
For example:
<property name="adminUserPassword" value="468018DD1CDBE82E515EBF78A41C428E"/>
Port used for communication between the LDAP Gateway and the mainframe LPAR on which you install the Reconciliation and Provisioning Agents
Note:
The procedure to install the Reconciliation and Provisioning Agents is described in the next chapter.As shown in the following line, the default value of the port property is 5389 in the beans.xml file. You can change this default value to any port of your choice.
<property name="port" value="5389"/>
Note:
The port number must be the same as the port number that you specify as the value of the idfServerPort IT resource parameter. See Table 3-2, "IT Resource Parameters" for more information.To enable logging for the LDAP Gateway:
Copy the log4j JAR file from the application server directory in which it is placed to the LDAP_INSTALL_DIR/lib directory.
Extract the log4j.properties file from the LDAP_INSTALL_DIR/dist/idfserver.jar file.
Enter a log level as the value of the log4j.rootLogger variable. For example:
log4j.rootLogger=ERROR, A1
Save and close the file.
When you use the connector, the following log files are generated in the LDAP_INSTALL_DIR/logs directory:
idfserver.log.0: This is the main log file.
acf2-agent-recon.log: This is the real-time, incremental reconciliation log file that stores Oracle Identity Manager reconciliation messages.
To configure the SSL in the LDAP Gateway:
Edit the /ldapgateway/idfserver.jar beans.xml directory for the following:
<bean id="sslChannelFactory" class="com.identityforge.idfserver.nio.ssl.SSLChannelFactory"> <constructor-arg><value>false</value></constructor-arg> <constructor-arg><value>./conf/idf.jks</value></constructor-arg> <constructor-arg><value>abc123</value></constructor-arg> <constructor-arg><value>false</value></constructor-arg> </bean>
The first argument indicates we are not in client mode.
Note:
Do not change this argument.The second argument is the path to the keystore. Either change this path to your keystore or add your certificate to this keystore.
The third argument is the keystore password that you used to generate your keystore.
Edit a listener using the SSLChannelFactory for only "port", which is the only item you can change in the listener:
<bean id="sslListener" class="com.identityforge.idfserver.nio.Listener"> constructor-arg><ref bean="bus"/></constructor-arg> <constructor-arg><ref bean="sslChannelFactory"/></constructor-arg> <property name="admin"><value>false</value></property> <property name="config"><value>./conf/listener.xml</value></property> <property name="port" value="7389"/> <property name="threadName" value="SSLLDAPListener"/> </bean>
Add the listener to the server by uncommenting the following line:
<bean id="server" class="com.identityforge.idfserver.Server"> <property name="tasks"> <list> <ref bean="bus"/> <ref bean="decoder"/> <ref bean="listener"/> <!-- <ref bean="sslListener"/> ? <!-- added here --> <ref bean="client"/> <ref bean="protocol"/> <ref bean="encoder"/> <ref bean="output"/> </list> </property> <property name="nexus" ref="nexus"/> <property name="logPath" value="../logs/idfserver.log"/> </bean>
Save the changes made to the beans.xml file, and then re-create the idfserver.jar file.
To configure the LDAP Gateway for the application server that Oracle Identity Manager is running on:
In a text editor, open the run script from the LDAP_INSTALL_DIR/bin directory.
In the run script, uncomment the lines related to the application server that you are using. In addition, change the paths to reflect the actual location of the application server directory.
The following are the contents of the run.sh file:
Note:
The instructions given in this step apply to Oracle Identity Manager Release 9.1.0.x. For Oracle Identity Manager Release 11.1.1, follow the instructions given in the run script itself. Remove un-needed # commented lines in the file and make sure .sh file CP is contained in double quotes " "SET CLASSPATH VARIABLES ##### SET ENVIRONMENT VARIABLES ####### APP_HOME=/opt/ldapgateway TMPDIR=/opt/ldapgateway/temp OIM_HOME=/opt/OIM/xellerate OIM_CLIENT_LIB=/opt/OIM/client/xlclient/lib ##### SET JBOSS HOME ################## # APPSERVER_HOME=/opt/ldapgateway/lib/jboss-4.0.2 ##### SET WEBSPHERE HOME ################## #APPSERVER_HOME=/opt/WebSphere/AppServer/lib ##### SET WEBLOGIC HOME ################## # APPSERVER_HOME=/opt/bea/ ##### SET OC4J HOME ################## #APPSERVER_HOME=/opt/oracle/oc4j
In the run.sh file, the lines starting with a number sign (#) are comments. To uncomment the line, remove the number sign. For example, to enable the connector to work with JBoss Application Server, uncomment the line for that application server as follows:
##### SET JBOSS HOME ################## APPSERVER_HOME=/opt/ldapgateway/lib/jboss-4.0.2
If you are using IBM WebSphere Application Server 6.1, then add the com.ibm.ws.wccm_6.1.0.jar file to the CLASSPATH variable in the run and run_initial_recon_provisioning scripts as follows:
rem
rem SET WEBSPHERE APPLICATION SERVER REQUIRED LIBRARIES
rem
set CLASSPATH=%CLASSPATH%;"%APPSERVER_HOME%"\lib\com.ibm.ws.wccm_6.1.0.jar
In the run script, set the JAVA_HOME property as follows:
JAVA_HOME=DIRECTORY_LOCATION\jdk1.5.0_22
Replace DIRECTORY_LOCATION with the full path of the directory.
Save and close the run script.
Starting and Stopping the LDAP Gateway
To start the LDAP Gateway on UNIX, run the following command:
bin> ./run.sh
To stop the LDAP Gateway on UNIX, run the following command:
bin> ./stop_idf.sh
To start the LDAP Gateway on Microsoft Windows, run the run.bat file.
To stop the LDAP Gateway on Microsoft Windows, close the command window in which the gateway is running.