Package com.pingidentity.sdk

Top level package for the PingFederate SDK.

Interface Summary

Interface	Description
AdapterSelector	Deprecated. Please use the AuthenticationSelector interface instead.
AuthenticationSelector	This interface defines the methods that the PingFederate server calls when performing IdP Authentication Selection.
ConfigurablePlugin	Interface which provides a plugin the ability to be configured.
DescribablePlugin	Implementations of the DescribablePlugin interface can return a PluginDescriptor.
GuiConfigDescriptorBuilder	An interface that builds a GuiConfigDescriptor for a plugin descriptor.
IdpAuthenticationAdapterV2	This interface defines the methods that the PingFederate IdP server calls to authenticate a user or logout a user session.
Plugin	Interface for plugin implementations.
PostRegistrationSessionAwareAdapter	An interface that allows an IdP adapter to authenticate a user after that user is registered via a Local Identity Profile
SessionAwareAuthenticationAdapter	An interface that allows an IdP adapter to decide whether or not an existing authentication session should be used.
TransactionAwareAuthenticationAdapter	An IdP adapter may implement TransactionAwareAuthenticationAdapter interface to define post-processing behaviours upon success or failure of the SSO transaction.

Class Summary

Class	Description
AdapterSelectorContext	Deprecated. Use AuthenticationSelectorContext instead.
AdapterSelectorDescriptor	Deprecated. Use AuthenticationSelectorDescriptor instead.
AuthenticationSelectorContext	This class contains context data resulting from the Authentication Selection process.
AuthenticationSelectorDescriptor	This class is used to describe an Authentication Selector implementation to the PingFederate server.
AuthenticationSession	A class containing information about an existing PingFederate authentication session.
AuthenticationSourceKey	The authentication source key identifies an entity that can perform a browser based SSO authentication.
AuthnAdapterResponse	This class defines a response from an IdP adapter.
CIDROperations	Provided as a helper class for CIDR operations.
CIDRUtils	A utility class that provides address evaluation (network and broadcast) and in-range functionality for a given IP Address from a CIDR specification.
GuiConfigDescriptor	This class is used to describe user interface components of a plugin implementation to the PingFederate server.
IdentityStoreProvisionerDescriptor	This class is used to describe an Identity Store Provisioner implementation to the PingFederate server.
PingFederateProperties	Provides an API that exposes properties of the PingFederate instance.
PluginDescriptor	This class is used to describe plugin implementation to the PingFederate server.
PluginMetadataKeys	Defines metadata keys that may be returned from a plugin descriptor's getMetadata() method.
PluginServiceAssociation	An object representing the association between a PingFederate plugin and a list of PingOne services.
SDKConstants
SearchCriteria	SearchCriteria object to hold all the relevant data for searching.
SearchCriteria.Builder	A helper to create SearchCriteria instances
SearchCriteria.FilterItem	Class to hold filterable name, value pairs to further narrow down the search results
SearchCriteria.OrderByItem	Class to hold the sortFieldName to order by and the direction of the order
SimpleGuiConfigDescriptorBuilder	A simple GUI configuration descriptor builder that returns the same GUI descriptor for all the build methods.

Enum Summary

Enum	Description
AdapterSelectorContext.ResultType
AuthenticationSelectorContext.ResultType
AuthenticationSourceKey.Type	The type of authentication source key.
AuthnAdapterResponse.AUTHN_STATUS
DeviceSharingType	An enum used to indicate whether the user's device is shared or private.
PluginFipsStatus	An enum representing the FIPS-compliance status of a plugin.
SearchCriteria.Order	Indicator of order direction