org.sourceid.saml20.adapter.conf
Class Configuration

java.lang.Object
  extended by org.sourceid.saml20.adapter.conf.FieldList
      extended by org.sourceid.saml20.adapter.conf.Configuration
All Implemented Interfaces:
java.io.Serializable

public class Configuration
extends FieldList
implements java.io.Serializable

A Configuration object contains all the configuration values entered by the user via the GUI. The PingFederate server 'configures' an adapter by passing an instance of a Configuration object into its configure method. A custom configuration GUI page is rendered in the PingFederate administration console by examining the AdapterConfigurationGuiDescriptor of the adapter's AuthnAdapterDescriptor. The values entered by the user are used along with the AdapterConfigurationGuiDescriptor to build a Configuration object. That Configuration object is then used to propagate the configuration to the adapter.

Author:
Brian Campbell
See Also:
ConfigurableAuthnAdapter.configure(Configuration), ConfigurableAuthnAdapter.getAdapterDescriptor(), AuthnAdapterDescriptor.getConfigurationGuiDescriptor(), AdapterConfigurationGuiDescriptor, Serialized Form

Constructor Summary
Configuration()
           
Configuration(java.util.List<Field> fields, java.util.List<Table> tables, java.util.List<Field> advancedFields)
           
 
Method Summary
 FieldList getAdvancedFields()
          Gets the values of the 'advanced' configuration fields.
 java.util.Set<java.lang.String> getMaskedAttrNames()
           
 Table getTable(java.lang.String tableName)
          Gets a Table by name.
 java.util.List<Table> getTables()
          Gets the List of Tables available on this Configuration.
 void setMaskedAttrNames(java.util.Set<java.lang.String> maskedAttrNames)
           
 java.lang.String toString()
           
 
Methods inherited from class org.sourceid.saml20.adapter.conf.FieldList
getBooleanFieldValue, getDoubleFieldValue, getField, getFields, getFieldValue, getFileFieldValueAsByteArray, getFileFiledValueAsString, getFloatFieldValue, getIntFieldValue, getLongFieldValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Configuration

public Configuration()

Configuration

public Configuration(java.util.List<Field> fields,
                     java.util.List<Table> tables,
                     java.util.List<Field> advancedFields)
Method Detail

getTables

public java.util.List<Table> getTables()
Gets the List of Tables available on this Configuration.

Returns:
a List of Tables.

getTable

public Table getTable(java.lang.String tableName)
Gets a Table by name.

Parameters:
tableName - the name of the Table you want.
Returns:
the named table or null, if there is no Table by that name.

getAdvancedFields

public FieldList getAdvancedFields()
Gets the values of the 'advanced' configuration fields.

Returns:
a FiledList containing the advanced fields.
See Also:
AdapterConfigurationGuiDescriptor.addAdvancedField(org.sourceid.saml20.adapter.gui.FieldDescriptor)

getMaskedAttrNames

public java.util.Set<java.lang.String> getMaskedAttrNames()

setMaskedAttrNames

public void setMaskedAttrNames(java.util.Set<java.lang.String> maskedAttrNames)

toString

public java.lang.String toString()
Overrides:
toString in class FieldList


Copyright 2007 Ping Identity Corp. All rights reserved.