Package org.sourceid.saml20.adapter.idp.authn

Class IdpAuthnAdapterDescriptor

java.lang.Object
com.pingidentity.sdk.PluginDescriptor
org.sourceid.saml20.adapter.AuthnAdapterDescriptor
org.sourceid.saml20.adapter.idp.authn.IdpAuthnAdapterDescriptor
public class IdpAuthnAdapterDescriptor extends AuthnAdapterDescriptor
This class is used to describe an IdP adapter implementation to the PingFederate server.
See Also:

  • Constructor Details

    • IdpAuthnAdapterDescriptor

      public IdpAuthnAdapterDescriptor(ConfigurableAuthnAdapter adapter, String type, Set<String> contract, boolean supportsExtendedContract, boolean allowConfigurableAuthnCtx)
      Creates a new AuthnAdapterDescriptor with no custom GUI configuration screen.
      Parameters:
      adapter - the adapter implementation this descriptor describes.
      type - the type of the adapter is the 'friendly' name that will show up in the PF GUI - usually in the context of selecting from a number of available adapters. A relatively descriptive and unique name should be used.
      contract - the names of the attributes that define this adapter's attribute contract. The contract is the set of attributes that the IdpAuthenticationAdapter will return to the PingFederate system when looking up authentication information.
      supportsExtendedContract - Deprecated. IdP adapters will always support extended contracts.
      allowConfigurableAuthnCtx - indicates whether the GUI presents and entry field for setting an authentication context class reference for it. See IdpAuthenticationAdapter.AUTHN_CTX_ATTRIBUTE_NAME.

    • IdpAuthnAdapterDescriptor

      public IdpAuthnAdapterDescriptor(ConfigurableAuthnAdapter adapter, String type, Set<String> contract, boolean supportsExtendedContract, AdapterConfigurationGuiDescriptor adapterConfigurationGuiDesc, boolean allowConfigurableAuthnCtx)
      Creates a new AuthnAdapterDescriptor with a custom GUI configuration screen.
      Parameters:
      adapter - the adapter implementation this descriptor describes.
      type - the type of the adapter is the 'friendly' name that will show up in the PF GUI - usually in the context of selecting from a number of available adapters. A relatively descriptive and unique name should be used.
      contract - the names of the attributes that define this adapter's attribute contract. The contract is the set of attributes that the IdpAuthenticationAdapter will return to the PingFederate system when looking up authentication information.
      supportsExtendedContract - Deprecated. IdP adapters will always support extended contracts.
      adapterConfigurationGuiDesc - a descriptor object that tells PingFederate how to render the configuration screen(s) for the adapter this object describes as well as how to validate the input from the front end.
      allowConfigurableAuthnCtx - indicates whether the GUI presents and entry field for setting an authentication context class reference for it. See IdpAuthenticationAdapter.AUTHN_CTX_ATTRIBUTE_NAME.

    • IdpAuthnAdapterDescriptor

      public IdpAuthnAdapterDescriptor(ConfigurableAuthnAdapter adapter, String type, Set<String> contract, boolean supportsExtendedContract, AdapterConfigurationGuiDescriptor adapterConfigurationGuiDesc, boolean allowConfigurableAuthnCtx, String versionNumber)
      Creates a new AuthnAdapterDescriptor with a custom GUI configuration screen.
      Parameters:
      adapter - the adapter implementation this descriptor describes.
      type - the type of the adapter is the 'friendly' name that will show up in the PF GUI - usually in the context of selecting from a number of available adapters. A relatively descriptive and unique name should be used.
      contract - the names of the attributes that define this adapter's attribute contract. The contract is the set of attributes that the IdpAuthenticationAdapter will return to the PingFederate system when looking up authentication information.
      supportsExtendedContract - Deprecated. IdP adapters will always support extended contracts.
      adapterConfigurationGuiDesc - a descriptor object that tells PingFederate how to render the configuration screen(s) for the adapter this object describes as well as how to validate the input from the front end.
      allowConfigurableAuthnCtx - indicates whether the GUI presents and entry field for setting an authentication context class reference for it. See IdpAuthenticationAdapter.AUTHN_CTX_ATTRIBUTE_NAME.
      versionNumber - defines the adapter's version number.

  • Method Details

    • allowConfigurableAuthnCtx

      public boolean allowConfigurableAuthnCtx()
      Does this adapter allow the admin to set a value for the AuthnContextClassRef via the UI. If false, the adapter must set the value at runtime or unspecified will be used. See IdpAuthenticationAdapter.AUTHN_CTX_ATTRIBUTE_NAME.
      Returns:
      true if the UI should present an option to set the AuthnContextClassRef value, false otherwise.

    • isSupportsExtendedContract

      public boolean isSupportsExtendedContract()
      Description copied from class: PluginDescriptor
      Returns whether or not the implementing plugin allows for attributes in addition to those in its contract.
      Overrides:
      isSupportsExtendedContract in class PluginDescriptor
      Returns:
      Returns true if the implementing plugin allows for attributes in addition to those in its contract, false otherwise.