Package org.sourceid.saml20.adapter

Class AuthnAdapterDescriptor

java.lang.Object

com.pingidentity.sdk.PluginDescriptor

org.sourceid.saml20.adapter.AuthnAdapterDescriptor

Direct Known Subclasses:

IdpAuthnAdapterDescriptor

public class AuthnAdapterDescriptor
extends PluginDescriptor

This class is used to describe an adapter implementation to the PingFederate server.

See Also:

ConfigurableAuthnAdapter.getAdapterDescriptor()

Field Summary

Fields inherited from class com.pingidentity.sdk.PluginDescriptor

UNDEFINED

Constructor Summary

Constructors

Constructor	Description
AuthnAdapterDescriptor(ConfigurableAuthnAdapter adapter, String type, Set<String> contract, boolean supportsExtendedContract)	Creates a new AuthnAdapterDescriptor with no custom GUI configuration screen.
AuthnAdapterDescriptor(ConfigurableAuthnAdapter adapter, String type, Set<String> contract, boolean supportsExtendedContract, AdapterConfigurationGuiDescriptor adapterConfigurationGuiDesc)	Creates a new AuthnAdapterDescriptor with a custom GUI configuration screen.
AuthnAdapterDescriptor(ConfigurableAuthnAdapter adapter, String type, Set<String> contract, boolean supportsExtendedContract, AdapterConfigurationGuiDescriptor adapterConfigurationGuiDesc, String versionNumber)	Creates a new AuthnAdapterDescriptor with a custom GUI configuration screen.

Method Summary

Modifier and Type	Method	Description
String	getAdapterClassName()	Gets the classname of AdapterConfigurationGuiDescriptor.
AdapterConfigurationGuiDescriptor	getConfigurationGuiDescriptor()	Gets the AdapterConfigurationGuiDescriptor for the adapter that this object describes.

Methods inherited from class com.pingidentity.sdk.PluginDescriptor

equals, getAttributeContractSet, getGuiConfigDescriptor, getGuiConfigDescriptorBuilder, getMetadata, getPluginClassName, getType, getVersion, hashCode, isSupportsExtendedContract, setAttributeContactSet, setAttributeContractSet, setMetadata, setSupportsExtendedContract

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthnAdapterDescriptor

public AuthnAdapterDescriptor(ConfigurableAuthnAdapter adapter,
                              String type,
                              Set<String> contract,
                              boolean supportsExtendedContract)

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. In the case of an IdpAuthenticationAdapter this is the set of attributes that it will return to the PingFederate system when looking up authentication information. In the case of a SpAuthenticationAdapter this is the set of attributes that the adapter expects in order to create a security context.

supportsExtendedContract - indicates whether this adapter supports additional attributes beyond those specified in its attribute contract

AuthnAdapterDescriptor

public AuthnAdapterDescriptor(ConfigurableAuthnAdapter adapter,
                              String type,
                              Set<String> contract,
                              boolean supportsExtendedContract,
                              AdapterConfigurationGuiDescriptor adapterConfigurationGuiDesc)

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. In the case of an IdpAuthenticationAdapter this is the set of attributes that it will return to the PingFederate system when looking up authentication information. In the case of a SpAuthenticationAdapter this is the set of attributes that the adapter expects in order to create a security context.

supportsExtendedContract - indicates whether this adapter supports additional attributes beyond those specified in its attribute contract

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.

AuthnAdapterDescriptor

public AuthnAdapterDescriptor(ConfigurableAuthnAdapter adapter,
                              String type,
                              Set<String> contract,
                              boolean supportsExtendedContract,
                              AdapterConfigurationGuiDescriptor adapterConfigurationGuiDesc,
                              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. In the case of an IdpAuthenticationAdapter this is the set of attributes that it will return to the PingFederate system when looking up authentication information. In the case of a SpAuthenticationAdapter this is the set of attributes that the adapter expects in order to create a security context.

supportsExtendedContract - indicates whether this adapter supports additional attributes beyond those specified in its attribute contract

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.

versionNumber - defines the adapter's version number.

Method Detail

getAdapterClassName

public String getAdapterClassName()

Gets the classname of AdapterConfigurationGuiDescriptor.

Returns:

the classname as a String.

getConfigurationGuiDescriptor

public AdapterConfigurationGuiDescriptor getConfigurationGuiDescriptor()

Gets the AdapterConfigurationGuiDescriptor for the adapter that this object describes.

Returns:

the GUI descriptor of the adapter that this object describes.