Package com.pingidentity.sdk

Class PluginMetadataKeys

java.lang.Object
com.pingidentity.sdk.PluginMetadataKeys
public class PluginMetadataKeys extends Object
Defines metadata keys that may be returned from a plugin descriptor's getMetadata() method.
Since:
10.2

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CLIENT_SIDE_AUTHENTICATION_CLASS
    The key for specifying the fully qualified class name of the client-side authentication implementation.
    static final String
    EARLY_CREATE_AND_CONFIGURE
    If this key is included in a plugin descriptor's metadata and set to true, it indicates plugin instances can be created and their configure() method called early in the configuration reload process, before the new set of managers has become active for runtime requests.
    static final String
    FIPS_STATUS
    This key indicates whether a plugin has been assessed and determined to be FIPS 140-2 compliant in its usage of cryptographic algorithms.
    static final String
    PING_ONE_SERVICE_ASSOCIATION
    The key for a PluginServiceAssociation object included in the plugin descriptor's metadata.
    static final String
    SUPPORTS_CLIENT_SIDE_AUTHENTICATION
    If this key is included in a plugin's metadata and set to true, it indicates that the plugin supports client-side authentication mechanisms, allowing an adapter, like the HTML Form Adapter to delegate login to this plugin when client side authentication is used.
    static final String
    TRY_LOOKUP_AUTHN
    If this key is included in an IdP adapter's metadata and set to true, it indicates that an API-capable adapter supports the ability to immediately satisfy the authentication request, avoiding a redirect to the authentication application.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PluginMetadataKeys()
     

  • Method Summary

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • EARLY_CREATE_AND_CONFIGURE

      public static final String EARLY_CREATE_AND_CONFIGURE
      If this key is included in a plugin descriptor's metadata and set to true, it indicates plugin instances can be created and their configure() method called early in the configuration reload process, before the new set of managers has become active for runtime requests. Including this key ensures that runtime requests are not blocked while instances of the plugin are being created and configured.

      Care must be taken if the configure() method modifies objects that are accessible to runtime requests before the configuration reload process completes. For example, clearing a lazy-loaded configuration cache in the configure() method could result in the cache being repopulated by runtime requests with the previous configuration data rather than the new data received through replication.

      Since:
      10.2
      See Also:

    • PING_ONE_SERVICE_ASSOCIATION

      public static final String PING_ONE_SERVICE_ASSOCIATION
      The key for a PluginServiceAssociation object included in the plugin descriptor's metadata. This object defines the set of PingOne services used by the plugin. This information is used to populate a view in the administrative console where the administrator can quickly determine which PingOne services are currently consumed by the PingFederate deployment.
      Since:
      10.2
      See Also:

    • FIPS_STATUS

      public static final String FIPS_STATUS
      This key indicates whether a plugin has been assessed and determined to be FIPS 140-2 compliant in its usage of cryptographic algorithms. If the key is present and set to PluginFipsStatus.COMPLIANT, the plugin has been assessed as compliant. If the key is present and set to PluginFipsStatus.NOT_COMPLIANT, the plugin has been assessed as not compliant. If the key is not present or set to PluginFipsStatus.NOT_ASSESSED, the plugin has not been assessed. Note that the metadata value may be one of the PluginFipsStatus enum values or the string returned by calling the name() method on one of those values.
      Since:
      10.3
      See Also:

    • TRY_LOOKUP_AUTHN

      public static final String TRY_LOOKUP_AUTHN
      If this key is included in an IdP adapter's metadata and set to true, it indicates that an API-capable adapter supports the ability to immediately satisfy the authentication request, avoiding a redirect to the authentication application. Before redirecting to the authentication application, PingFederate will invoke the adapter's lookupAuthN method with the IdpAuthenticationAdapterV2.IN_PARAMETER_TRY_LOOKUP_AUTHN input parameter set to true.
      Since:
      12.0
      See Also:

    • SUPPORTS_CLIENT_SIDE_AUTHENTICATION

      public static final String SUPPORTS_CLIENT_SIDE_AUTHENTICATION
      If this key is included in a plugin's metadata and set to true, it indicates that the plugin supports client-side authentication mechanisms, allowing an adapter, like the HTML Form Adapter to delegate login to this plugin when client side authentication is used.
      Since:
      13.0
      See Also:

    • CLIENT_SIDE_AUTHENTICATION_CLASS

      public static final String CLIENT_SIDE_AUTHENTICATION_CLASS
      The key for specifying the fully qualified class name of the client-side authentication implementation. This class should implement ClientSideAuthenticator and handle authentication logic that executes on the client side, like passkeys or FIDO.
      Since:
      13.0
      See Also:

  • Constructor Details

    • PluginMetadataKeys

      public PluginMetadataKeys()