Federation Guides › Partnership Federation Guide › Assertion Configuration at the Asserting Party › Customize Assertion Content › Enable the Assertion Generator Plug-in

Enable the Assertion Generator Plug-in

After writing an assertion generator plug-in and compiling it, you enable the plug-in by configuring settings in the CA SiteMinder® Federation UI. The UI parameters let CA SiteMinder® Federation know where to find the plug-in.

Do not configure the plug-in settings until you deploy the plug-in.

To enable the Assertion Generator plug-in

1. Log on to the Administrative UI.
2. Navigate to the Assertion Configuration step of the Partnership wizard for the partnership you want to modify.
3. Enter values for the Assertion Generator Plug-in settings that follow:

   Plug-in Class

   Specifies the Java class name of the plug-in. Enter a name. This plug-in is invoked at run time.

   Example: com.mycompany.assertiongenerator.AssertionSample

   The plug-in class can parse and modify the assertion, and then return the result to CA SiteMinder® Federation for final processing. Specify an Assertion Generator plug-in for each relying party. A compiled sample plug-in is included in the SDK. You can view complied sample assertion plug-ins in the directory federation_sdk_home/jar.

   Note: You can also view the source code for the CA SiteMinder® Federation sample plug-ins in the directory federation_sdk_home\sample\com\ca\federation\sdk\plugin\sample.

   Plug-in Parameter

   (Optional). Specifies the string that CA SiteMinder® Federation passes to the plug-in as a parameter at run time. The string can contain any value; there is no specific syntax to follow.

   The plug-in interprets the parameters that it receives. For example, the parameter could be the name of an attribute or the string can contain an integer that instructs the plug-in to do something.

Reference information (method signatures, parameters, return values, data types), and the constructor for UserContext class and the APIContext class, are in the Javadoc Reference. Refer to the AssertionGeneratorPlugin interface in the Javadoc.