Package org.sourceid.saml20.adapter

Interface ConfigurableAuthnAdapter

All Superinterfaces:
ConfigurablePlugin
All Known Subinterfaces:
IdpAuthenticationAdapter, IdpAuthenticationAdapterV2, SpAuthenticationAdapter
public interface ConfigurableAuthnAdapter extends ConfigurablePlugin
A base interface for common methods across the authentication adapters. This interface defines the method that the PingFederate server uses to discover metadata about an adapter implementation getAdapterDescriptor(). It also defines the method that the PingFederate server calls to push administrator entered GUI configuration values into the adapter configure(Configuration).
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    configure(Configuration configuration)
    This method is called by the PingFederate server to push configuration values entered by the administrator via the dynamically rendered GUI configuration screen in the PingFederate administration console.
    AuthnAdapterDescriptor
    getAdapterDescriptor()
    The PingFederate server will invoke this method on your adapter implementation to discover metadata about the implementation.

  • Method Details

    • getAdapterDescriptor

      AuthnAdapterDescriptor getAdapterDescriptor()
      The PingFederate server will invoke this method on your adapter implementation to discover metadata about the implementation. This included the adapter's attribute contract and a description of what configuration fields to render in the GUI.

      Your implementation of this method should return the same AuthnAdapterDescriptor object from call to call - behaviour of the system is undefined if this convention is not followed.
      Returns:
      an AuthnAdapterDescriptor object that describes this adapter implementation.

    • configure

      void configure(Configuration configuration)
      This method is called by the PingFederate server to push configuration values entered by the administrator via the dynamically rendered GUI configuration screen in the PingFederate administration console. Your implementation should use the Configuration parameter to configure its own internal state as needed. The tables and fields available in the Configuration object will correspond to the tables and fields defined on the AdapterConfigurationGuiDescriptor on the AuthnAdapterDescriptor returned by the getAdapterDescriptor() method of this class.

      Each time the PingFederate server creates a new instance of your adapter implementation this method will be invoked with the proper configuration. All concurrency issues are handled in the server so you don't need to worry about them here. The server doesn't allow access to your adapter implementation instance until after creation and configuration is completed.
      Specified by:
      configure in interface ConfigurablePlugin
      Parameters:
      configuration - the Configuration object constructed from the values entered by the user via the GUI.