org.sourceid.saml20.adapter
Class AuthnAdapterDescriptor

java.lang.Object
  extended by org.sourceid.saml20.adapter.AuthnAdapterDescriptor
Direct Known Subclasses:
IdpAuthnAdapterDescriptor

public class AuthnAdapterDescriptor
extends java.lang.Object

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

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

Constructor Summary
AuthnAdapterDescriptor(ConfigurableAuthnAdapter adapter, java.lang.String type, java.util.Set<java.lang.String> contract, boolean supportsExtendedContract)
          Creates a new AuthnAdapterDescriptor with no custom GUI configuration screen.
AuthnAdapterDescriptor(ConfigurableAuthnAdapter adapter, java.lang.String type, java.util.Set<java.lang.String> contract, boolean supportsExtendedContract, AdapterConfigurationGuiDescriptor adapterConfigurationGuiDesc)
          Creates a new AuthnAdapterDescriptor with a custom GUI configuration screen.
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.String getAdapterClassName()
          Gets the classname of AdapterConfigurationGuiDescriptor.
 java.util.Set<java.lang.String> getAttributeContractSet()
          Gets the attribute contract of the adapter that this object describes.
 AdapterConfigurationGuiDescriptor getConfigurationGuiDescriptor()
          Gets the AdapterConfigurationGuiDescriptor for the adapter that this object describes.
 java.lang.String getType()
          Gets the the type (or name) of the adapter that this object describes.
 int hashCode()
           
 boolean isSupportsExtendedContract()
          Does the adapter that this object describes allow for attributes in addition to those in its contract?
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AuthnAdapterDescriptor

public AuthnAdapterDescriptor(ConfigurableAuthnAdapter adapter,
                              java.lang.String type,
                              java.util.Set<java.lang.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 if this adapter supports additional attributes beyond those specified in its attribute contract

AuthnAdapterDescriptor

public AuthnAdapterDescriptor(ConfigurableAuthnAdapter adapter,
                              java.lang.String type,
                              java.util.Set<java.lang.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 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.
Method Detail

getType

public java.lang.String getType()
Gets the the type (or name) of the adapter that this object describes.

Returns:
the type as a String.

getAdapterClassName

public java.lang.String getAdapterClassName()
Gets the classname of AdapterConfigurationGuiDescriptor.

Returns:
the classname as a String.

getAttributeContractSet

public java.util.Set<java.lang.String> getAttributeContractSet()
Gets the attribute contract of the adapter that this object describes.

Returns:
the adapter attribute contract as a Set of Strings.

isSupportsExtendedContract

public boolean isSupportsExtendedContract()
Does the adapter that this object describes allow for attributes in addition to those in its contract?

Returns:
true if yes, false otherwise/

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.

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object


Copyright 2007 Ping Identity Corp. All rights reserved.