Custom plugin extending UserNameGenerationPolicy for OIM

Oracle provides yet another plug-in point to generate userName for identities as per the Organization standards.
The plug-in point for this is  : oracle.iam.identity.usermgmt.api.UserNameGenerationPolicy

By default the Common Name Generation Policy used in OIM is "oracle.iam.identity.usermgmt.impl.plugins.DefaultComboPolicy".
If we want to use our own policy for example creating the user ID from the user's first name, and last naem, appending it with a random number so that it's unique, here is how it can be achieved.

The steps would be to  :

1. Write our own logic which will extend the "UserNameGenerationPolicy" , and return the userName , after processing the inputs from the orchestration data.

The plugin Class :


<?xml version="1.0" encoding="UTF-8"?> package iam.demo.pluginpoints; import oracle.iam.identity.exception.UserNameGenerationException; import oracle.iam.identity.usermgmt.api.UserManager; import oracle.iam.identity.usermgmt.api.UserNameGenerationPolicy; import oracle.iam.identity.usermgmt.utils.UserNameGenerationUtil; import oracle.iam.platform.Platform; import oracle.iam.platform.entitymgr.vo.SearchCriteria; import oracle.iam.provisioning.api.ProvisioningService; import oracle.iam.identity.usermgmt.vo.User; import java.util.*; public class UserNamePolicy implements UserNameGenerationPolicy { @Override public String getDescription(Locale arg0) { // TODO Auto-generated method stub return null; } @Override public String getUserNameFromPolicy(Map<String, String> orchData) throws UserNameGenerationException { // TODO Auto-generated method stub String uName = new String(); String firstName = orchData.get("First Name").substring(0, 2); //get the FirstName String lastName = orchData.get("Last Name").substring(0, 3); //get the LastName boolean uNameGen = false; while(!uNameGen){ Random random = new Random(); int x = random.ints(100,(500+1)).findFirst().getAsInt(); // generate a random Number to append uName = firstName.concat(lastName).concat(String.valueOf(x)); if(!UserNameGenerationUtil.isUserNameExistingOrReserved(uName)){ // Check if the userName already exists uNameGen = true; } } return uName; } @Override public boolean isUserNameValid(String arg0, Map<String, String> arg1) { // TODO Auto-generated method stub return false; } @Override public String getUserName(Map<String, Object> arg0) throws UserNameGenerationException { // TODO Auto-generated method stub return null; } @Override public boolean isGivenUserNameValid(String arg0, Map<String, Object> arg1) { // TODO Auto-generated method stub return false; } }

2. Jar the above file and keep it in the plug-in zip file under lib/ folder.
3. Configure the plugin.xml for registering the plug-in using ant

The plugin.xml :

<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?> <oimplugins xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <plugins pluginpoint="oracle.iam.identity.usermgmt.api.UserNamePolicy"> <plugin name="UserNamePolicy" version="1.0" pluginclass="iam.demo.pluginpoints.UserNamePolicy"> </plugin> </plugins> </oimplugins>

4. Keep the plugin-name.zip file under OIM_HOME/server/plugins folder.
5. If the auto-plugin-registration property is set up, it would be automatically registered (you can read about it here - plugin auto-registration )  , if not  :

•    Navigate to OIM_HOME/server/pluggin_utiltiy
•    run ant -f pluginregistration.xml register
•    provide user name, password, and full location of the zip file (OIM_HOME/server/plugins/UserNamePolicy.zip)
•    check if the plug-in properly registered from DB :
•    select * from plugins where ID like ('iam.demo.pluginpoints.UserNamePolicy')

6. Change in the system configuration property "Default policy for username generation"

• Log-into http://oim_hostname:port/sysadmin console.
• Open "System Configuration"
• Search for the property 'Default policy for username generation' .
• This property name can be different in different set up, but notice the keyword will be same as  : "XL.DefaultUserNamePolicyImpl"
• Change the value from 'oracle.iam.identity.usermgmt.impl.plugins.DefaultComboPolicy' to our full class name 'iam.demo.pluginpoints.UserNamePolicy'.

Do a purge cache and take an admin+managed server restart of your environmet :

• Navigate to $OIM_HOME/bin directory, locate PurgeCache.sh file
• run  ./PurgeCache.sh ALL
• Provide system admin login : XELSYSADM
• Provide system admin password : ******
• Provide managed servers URLs : t3://oim_hostname:port (run once for each managed server in case of cluster set up)

Now, try to create an user to see the username getting generated.

As always, thanks for reading !