Package com.pingidentity.sdk

Class PluginServiceAssociation

  • public class PluginServiceAssociation
extends Object
    An object representing the association between a PingFederate plugin and a list of PingOne services. 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. This object is added to the plugin descriptor's metadata using the setMetadata() method with the key PINGONE_SERVICE_ASSOCIATION.
    Since:
    10.2

    • Field Detail

      • DIRECTORY_SERVICE_DISPLAY_NAME

        public static final String DIRECTORY_SERVICE_DISPLAY_NAME
        The display name for the PingOne directory service.
        Since:
        10.2
        See Also:
        Constant Field Values

      • RISK_SERVICE_DISPLAY_NAME

        public static final String RISK_SERVICE_DISPLAY_NAME
        The display name for the PingOne risk service.
        Since:
        10.2
        See Also:
        Constant Field Values

      • PROTECT_SERVICE_DISPLAY_NAME

        public static final String PROTECT_SERVICE_DISPLAY_NAME
        The display name for the PingOne Protect service.
        Since:
        12.0
        See Also:
        Constant Field Values

      • MFA_SERVICE_DISPLAY_NAME

        public static final String MFA_SERVICE_DISPLAY_NAME
        The display name for the PingOne MFA service.
        Since:
        10.2
        See Also:
        Constant Field Values

      • VERIFY_SERVICE_DISPLAY_NAME

        public static final String VERIFY_SERVICE_DISPLAY_NAME
        The display name for the PingOne Verify service.
        Since:
        10.2
        See Also:
        Constant Field Values

    • Constructor Detail

      • PluginServiceAssociation

        public PluginServiceAssociation​(String pluginDisplayName,
                                String serviceDisplayName)
        Create an instance with the specified parameters.
        Parameters:
        pluginDisplayName - The display name of the plugin. This should be kept short and should not include the plugin version or any reference to PingOne (since this can be inferred from the context).
        serviceDisplayName - The PingOne service used by the plugin. Service names should be kept short and should omit any reference to PingOne (since this can be inferred from the context).

      • PluginServiceAssociation

        public PluginServiceAssociation​(String pluginDisplayName,
                                List<String> serviceDisplayNames)
        Create an instance with the specified parameters.
        Parameters:
        pluginDisplayName - The display name of the plugin. This should be kept short and should not include the plugin version or any reference to PingOne (since this can be inferred from the context).
        serviceDisplayNames - The list of services used by the plugin. Service names should be kept short and should omit any reference to PingOne (since this can be inferred from the context). Typically only the first service will be displayed, so this should be the primary service used by the plugin. There is currently no need to define more than one service.

    • Method Detail

      • getPluginDisplayName

        public String getPluginDisplayName()
        Returns the display name of the plugin.
        Returns:
        The plugin display name.

      • getServiceDisplayNames

        public List<String> getServiceDisplayNames()
        Returns the list of services used by the plugin. Typically only the first service returned will be displayed in the administrative console.
        Returns:
        The list of services used by the plugin.