Using custom solutions for client storage - PingFederate - 10.2

PingFederate Server

PingFederate Server
PingFederate 10.2

Use the PingFederate SDK to implement a custom solution for client storage.


PingFederate does not migrate client records from one storage medium to another. You must recreate your clients after updating the client storage configuration. If you need only a few clients, you can recreate them using the administrative console.

If you need a large number of clients, use the administrative API to retrieve your client records before updating the client storage. Update the client storage configuration and recreate your clients using the administrative API based on the retrieved records. For more information, see PingFederate administrative API.

  1. Implement the ClientStorageManagerV2 interface.
    This interface includes a search() method, allowing developers to provide efficient implementations of the pagination and search functions exposed in the administrative console.

    For more information, see the Javadoc for the ClientStorageManagerV2 interface, the file for a sample implementation, and the SDK Developer's Guide for build and deployment information.


    The Javadoc for PingFederate and the sample implementation are in the <pf_install>/pingfederate/sdk directory.

  2. Edit the <pf_install>/pingfederate/server/default/conf/META-INF/hivemodule.xml file.
    1. Locate the ClientStorageManager service point.
      <!-- Service for storing OAuth client configuration. -->
      <service-point id="ClientManager" interface="org.sourceid.oauth20.domain.ClientManager">
              Supported classes are
              org.sourceid.oauth20.domain.ClientManagerXmlFileImpl ...
              org.sourceid.oauth20.domain.ClientManagerJdbcImpl    ...
              org.sourceid.oauth20.domain.ClientManagerLdapImpl    ...
              org.sourceid.oauth20.domain.ClientManagerGenericImpl ...
              <construct class="org.sourceid.oauth20.domain.ClientManagerXmlFileImpl"/>
    2. Update the class attribute value with the name of the class implementing the ClientStorageManagerV2 interface.
    3. Save the file.

    For a clustered PingFederate environment, you must edit the hivemodule.xml file on each node manually as cluster replication cannot replicate this change to other nodes.

  3. Start or restart PingFederate.

    For a clustered PingFederate environment, replicate this new configuration to other engine nodes on System > Server > Cluster Management. Start or restart the PingFederate service on each engine node to activate the change.