org.sourceid.saml20.adapter.idp.authn
Class IdpAuthnAdapterDescriptor

java.lang.Object
  extended by org.sourceid.saml20.adapter.AuthnAdapterDescriptor
      extended by 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.

Author:
Brian Campbell
See Also:
IdpAuthenticationAdapter.getAdapterDescriptor()

Constructor Summary
IdpAuthnAdapterDescriptor(ConfigurableAuthnAdapter adapter, java.lang.String type, java.util.Set<java.lang.String> contract, boolean supportsExtendedContract, AdapterConfigurationGuiDescriptor adapterConfigurationGuiDesc, boolean allowConfigurableAuthnCtx)
          Creates a new AuthnAdapterDescriptor with a custom GUI configuration screen.
IdpAuthnAdapterDescriptor(ConfigurableAuthnAdapter adapter, java.lang.String type, java.util.Set<java.lang.String> contract, boolean supportsExtendedContract, boolean allowConfigurableAuthnCtx)
          Creates a new AuthnAdapterDescriptor with no custom GUI configuration screen.
 
Method Summary
 boolean allowConfigurableAuthnCtx()
          Does this adapter allow the admin to set a value for the AuthnContextClassRef via the UI.
 
Methods inherited from class org.sourceid.saml20.adapter.AuthnAdapterDescriptor
equals, getAdapterClassName, getAttributeContractSet, getConfigurationGuiDescriptor, getType, hashCode, isSupportsExtendedContract
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IdpAuthnAdapterDescriptor

public IdpAuthnAdapterDescriptor(ConfigurableAuthnAdapter adapter,
                                 java.lang.String type,
                                 java.util.Set<java.lang.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 - indicates if this adapter supports additional attributes beyond those specified in its attribute contract.
allowConfigurableAuthnCtx - does this adapter's want to allow the GUI to set an authentication context class reference for it. See IdpAuthenticationAdapter.AUTHN_CTX_ATTRIBUTE_NAME.

IdpAuthnAdapterDescriptor

public IdpAuthnAdapterDescriptor(ConfigurableAuthnAdapter adapter,
                                 java.lang.String type,
                                 java.util.Set<java.lang.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 - indicates if 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.
allowConfigurableAuthnCtx - does this adapter's want to allow the GUI to set an authentication context class reference for it. See IdpAuthenticationAdapter.AUTHN_CTX_ATTRIBUTE_NAME.
Method Detail

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.


Copyright 2007 Ping Identity Corp. All rights reserved.