Package org.sourceid.saml20.adapter.conf

Class Configuration

java.lang.Object

org.sourceid.saml20.adapter.conf.FieldList

org.sourceid.saml20.adapter.conf.Configuration

All Implemented Interfaces:

Serializable

public class Configuration
extends FieldList
implements 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.

See Also:

• ConfigurableAuthnAdapter.configure(Configuration)
• ConfigurableAuthnAdapter.getAdapterDescriptor()
• AuthnAdapterDescriptor.getConfigurationGuiDescriptor()
• AdapterConfigurationGuiDescriptor
• ConfigurablePlugin.configure(Configuration)
• DescribablePlugin.getPluginDescriptor()
• PluginDescriptor
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Configuration()
Configuration(List<Field> fields, List<Table> tables, List<Field> advancedFields)
Configuration(List<Field> fields, List<Table> tables, FieldList advancedFields)
Configuration(Configuration configuration)

Method Summary

Modifier and Type	Method	Description
Set<String>	getAdditionalAttrNames()	Gets the names of the additional attributes configured in the GUI for the given plugin.
FieldList	getAdvancedFields()	Gets the values of the 'advanced' configuration fields.
String	getId()	Gets the instance id of the plugin for which this configuration applies.
Set<String>	getMaskedAttrNames()	Gets the names of attributes that have been marked (via the UI) to be masked in the log file(s).
Set<String>	getMultiValuedAttributes()	Gets the names of the attributes whose values are to be returned as an array.
Table	getTable(String tableName)	Gets a Table by name.
List<Table>	getTables()	Gets the List of Tables available on this Configuration.
void	setAdditionalAttrNames(Set<String> additionalAttrNames)
void	setId(String id)	Sets the instance id
void	setMaskedAttrNames(Set<String> maskedAttrNames)	Sets the names of attributes that are to be masked in the log files.
void	setMultiValuedAttributes(Set<String> multiValuedAttributes)	Sets the names of the attributes whose values are to be returned as an array.
String	toString()

Methods inherited from class org.sourceid.saml20.adapter.conf.FieldList

addField, getBooleanFieldValue, getBooleanFieldValue, getDoubleFieldValue, getField, getFields, getFieldValue, getFileFieldValueAsByteArray, getFileFiledValueAsString, getFloatFieldValue, getIntFieldValue, getLongFieldValue, getReadOnlyFieldMap, isEmpty

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Configuration

public Configuration()

Configuration

public Configuration(List<Field> fields,
 List<Table> tables,
 List<Field> advancedFields)

Configuration

public Configuration(List<Field> fields,
 List<Table> tables,
 FieldList advancedFields)

Configuration

public Configuration(Configuration configuration)

Method Details

getTables

public List<Table> getTables()

Gets the List of Tables available on this Configuration.

Returns:

a List of Tables.

getTable

public Table getTable(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:

• GuiConfigDescriptor.addAdvancedField(org.sourceid.saml20.adapter.gui.FieldDescriptor)

getMaskedAttrNames

public Set<String> getMaskedAttrNames()

Gets the names of attributes that have been marked (via the UI) to be masked in the log file(s).

Returns:

a non null set containing the names of attributes that should be masked.

setMaskedAttrNames

public void setMaskedAttrNames(Set<String> maskedAttrNames)

Sets the names of attributes that are to be masked in the log files.

Parameters:

maskedAttrNames - A set of attribute names to be masked.

getId

public String getId()

Gets the instance id of the plugin for which this configuration applies. In the case of connection-based plugin overrides, this is the connection-based id rather than the parent plugin id.

Returns:

the instance id

Since:

6.6

setId

public void setId(String id)

Sets the instance id

Parameters:

id - the instance id

Since:

6.6

getAdditionalAttrNames

public Set<String> getAdditionalAttrNames()

Gets the names of the additional attributes configured in the GUI for the given plugin. For most plugins this is the Extended Contract from the GUI but some plugins use this data in somewhat different ways. For example, AuthenticationSelector uses these values as the Selector Result Values.

Returns:

a Set of names

Since:

6.6

setAdditionalAttrNames

public void setAdditionalAttrNames(Set<String> additionalAttrNames)

Since:

6.6

getMultiValuedAttributes

public Set<String> getMultiValuedAttributes()

Gets the names of the attributes whose values are to be returned as an array. This is currently only populated for Access Token Manager plugins.

Returns:

a Set of attribute names

Since:

11.0

setMultiValuedAttributes

public void setMultiValuedAttributes(Set<String> multiValuedAttributes)

Sets the names of the attributes whose values are to be returned as an array. This is currently only populated for Access Token Manager plugins.

Parameters:

multiValuedAttributes - a Set of attribute names

Since:

11.0

toString

public String toString()

Overrides:

toString in class FieldList