This documentation supports the 9.1 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

Creating a new plug-in to transform user IDs

Purpose

When you integrate BMC Remedy Single Sign-On with BMC applications by using new authentication methods, the new authentication methods might not provide the same user ID format that was available with previous authentication methods. Some authentication methods such as Security Assertion Markup Language (SAML) also return the user ID in a format that cannot be used directly. In such situations, in addition to the default options, you can add complex transformations to the Transformation list in BMC Remedy Single Sign-On by creating customized plug-ins.

Process

You must perform the following steps to transform user IDs by using customized plug-ins.

  1. Creating a new plug-in
  2. Installing the plug-in
  3. Accessing the new user id transformation

Creating a new plug-in

  1. Create a new Java class that implements the UserIdTransformation interface.
  2. Register your custom transformation in the provider configuration file located at META-INF/services/com.bmc.rsso.plugins.transformation.spi.UserIdTransformation.


    Note

     The provider configuration file contains fully qualified class names of your custom transformations, one name per line. The file must be UTF-8 encoded. Additionally, you can include comments in the file by beginning the comment line with the number sign (#).

    For example, if you create custom transformation plug-in named CustomTransformation in package com.mycompany, then your provider configuration file should contain one line:

    com.mycompany.CustomTransformation

  3.  Package your compiled Java class from step 1 with META-INF/services/com.bmc.rsso.plugins.transformation.spi.UserIdTransformation into a single JAR file.

    Note

    This is Java standard ServiceLoader mechanism.

    For more detailed information on using it, refer to this documentation: https://docs.oracle.com/javase/tutorial/ext/basics/spi.html.

    Example: The plug-in used for converting user IDs to uppercase.

    /**
     * Perform to lower case conversion
     * Created by roman.loyko on 9/24/2015.
     */
    public class ToLowerCaseUserIdTransformation implements UserIdTransformation {
        public String transform(String userId) {
            CommonsUtil.validateNotNull(userId, "userId");
            return userId.toLowerCase();
        }
        
    
    	/**     * Returns the string to be used within the dropdown in the realm editor. 
         *
         * @return Label for transformation
         */
    	
    	public String getStrategyName() {
            return "ToLowerCase";
        }
        public String getDescription() {
            return "Converts to lower case";
        }
    }
    
    

Installing the plug-in

  1. Copy the JAR file to the following directory: <installation-directory>/tomcat/webapps/rsso/WEB-INF/lib.

    Note

    If you need any additional libraries for the transformation plug-in, save the libraries in the following directory: <installation-directory>/tomcat/webapps/rsso/WEB-INF/lib.

  2. In BMC Remedy Single Sign-On, click the Realm tab.

    When you click the Realm tab, the plug-in loads automatically.

Note

If you have deployed BMC Remedy Single Sign-On in a High Availability (HA) environment, install the plug-in on all servers in the cluster before configuring the realm to use the new transformation.

Accessing the new user ID transformation

After you install the plug-in on the server, access BMC Remedy Single Sign-On and edit the realm for which you want to configure user ID transformation.

From the Realm tab, select the Authentication page. The new user ID transformation details are listed in the Transformation field.

Related topics

Was this page helpful? Yes No Submitting... Thank you

Comments