Package org.sourceid.saml20.adapter.gui

Provides classes that enable an adapter to describe to PingFederate the way its GUI configuration screen should look.

See: Description

Interface Summary

Interface	Description
ActionDescriptor.Action	The action to perform.

Class Summary

Class	Description
AbstractSelectionFieldDescriptor	An abstract base type for describing GUI fields that have multiple options the user can select from.
AbstractSelectionFieldDescriptor.OptionValue	A class representing an option value.
AbstractTextFieldDescriptor	An abstract field descriptor that will render a text field on the GUI configuration screen.
ActionDescriptor	An ActionDescriptor can be used to invoke arbitrary actions on an adapter via the GUI.
AdapterConfigurationGuiDescriptor	A class that describes to the PingFederate server the way a GUI configuration screen should be rendered for an adapter.
AuthnSourceSelectionFieldDescriptor	A filterable dropdown control that enables the selection of an Authentication Source in a way that's user friendly and scalable.
CertificateSelectionFieldDescriptor	A field descriptor that will render (in GUI configuration screen) a drop down selection of certificates
CheckBoxFieldDescriptor	A field descriptor that will render a check box on the GUI configuration screen.
ClientCertKeypairFieldDescriptor	A field descriptor that will render (in GUI configuration screen) a drop down selection of all the key pairs in the PingFederate system configured for client certificate authentication.
ConnectionSelectionFieldDescriptor	A filterable dropdown control that enables the selection of an IdP or SP connection in a way that's user friendly and scalable.
CustomSourceFieldDescriptor	A field descriptor that will render (in GUI configuration screen) a drop down selection of all the configured Custom Source data stores.
DsigKeypairFieldDescriptor	A field descriptor that will render (in GUI configuration screen) a drop down selection of all the key pairs in the PingFederate system configured for digital signing.
EncryptionCertificateFieldDescriptor	A field descriptor that will render (in GUI configuration screen) a drop down selection of all the certificates in the PingFederate system configured for encryption by token generators.
ExtendedPropertiesFileDescriptor
FieldDescriptor	An abstract base type for describing GUI fields to be rendered in the PingFederate administration console.
FilterableSelectionFieldDescriptor	An abstract base type for describing PingFederate administration console GUI fields that show a dropdown that can be filtered with user input.
FilterableSelectionFieldDescriptor.FilterableSelectionFieldDefaultValidator
FilterableSelectionFieldDescriptor.QueryParam	Admin API query string to be added to the corresponding Admin API call as defined in SearchableType.
FilterableSelectionFieldDescriptor.SearchableTypeConfig	Wrapper object of SearchableType (for specifying Admin API end-point) and list of QueryParam (for specifying query strings)
HashedTextFieldDescriptor	A field descriptor that will render a password text field on the GUI configuration screen.
JdbcDatastoreFieldDescriptor	A field descriptor that will render (in GUI configuration screen) a drop down selection of all the configured JDBC data stores.
LdapAuthenticationErrorFieldDescriptor	A field descriptor that will render (in GUI configuration screen) a drop down selection of the LDAP authentication error codes.
LdapDatastoreFieldDescriptor	A field descriptor that will render (in GUI configuration screen) a drop down selection of all the configured LDAP data stores.
LinkDescriptor	A read only descriptor that will render (in GUI screens) a clickable link.
NotificationSenderFieldDescriptor
OAuthClientSelectionFieldDescriptor	A filterable dropdown control that enables the selection of an OAuth client in a way that's user friendly and scalable.
PasswordCredentialValidatorFieldDescriptor	A field descriptor that will render (in GUI configuration screen) a drop down selection of all the configured Password Credential Validators.
PolicyContractFieldDescriptor
RadioGroupFieldDescriptor	A field descriptor that will render a group of radio buttons on the GUI configuration screen.
ReadOnlyDescriptor	An abstract base type for describing read only GUI fields to be rendered in the PingFederate administration console.
SelectFieldDescriptor	A field descriptor that will render a select (drop down) field on the GUI configuration screen.
TableDescriptor	A class that describes to the PingFederate server the way a table of fields should be rendered.
TextAreaFieldDescriptor	A field descriptor that will render a text area on the GUI configuration screen.
TextFieldDescriptor	A field descriptor that will render a text field on the GUI configuration screen.
TrustedCAFieldDescriptor	A field descriptor that will render (in GUI configuration screen) a drop down selection of all the trusted CA certificates configured in the PingFederate.
UploadFileFieldDescriptor	A field descriptor that will render a file upload field on the GUI configuration screen.

Enum Summary

Enum	Description
ConnectionSelectionFieldDescriptor.ConnectionType	ConnectionType configures the data source (i.e.
FilterableSelectionFieldDescriptor.SearchableType	A SearchableType enum defines the Admin API attributes and end-point used to query data.
OAuthClientSelectionFieldDescriptor.GrantType	Used in the constructor of OAuthClientSelectionFieldDescriptor to specify grant type requirement of OAuth clients that are searchable in the resulting filterable drop-down menu.

Exception Summary

Exception	Description
FilterableSelectionFieldDescriptor.SearchableType.SearchableTypeNotFound	Thrown when an unknown tab title is specified.

Package org.sourceid.saml20.adapter.gui Description

Provides classes that enable an adapter to describe to PingFederate the way its GUI configuration screen should look.

By implementing the ConfigurableAuthnAdapter.getAdapterDescriptor() method an adapter can tell the PingFederate server about itself. This package is about describing an adapter's GUI configuration page to PF and an AdapterConfigurationGuiDescriptor is the primary class for that purpose. An org.sourceid.saml20.adapter.AuthnAdapterDescriptor is created with an AdapterConfigurationGuiDescriptor using the appropriate constructor.

Generally an adapter developer will create a AdapterConfigurationGuiDescriptor and add fields and tables to it in order to expose the necessary configuration points for the adapter.