org.sourceid.saml20.adapter.gui
Class AdapterConfigurationGuiDescriptor

java.lang.Object
  org.sourceid.saml20.adapter.gui.AdapterConfigurationGuiDescriptor

All Implemented Interfaces:

java.io.Serializable

public class AdapterConfigurationGuiDescriptor
extends java.lang.Object
implements java.io.Serializable

A class that describes to the PingFederate server the way a GUI configuration screen should be rendered for an adapter.

Author:

Brian Campbell

See Also:

AuthnAdapterDescriptor.getConfigurationGuiDescriptor(), ConfigurableAuthnAdapter.getAdapterDescriptor(), TableDescriptor, ConfigurationValidator, ActionDescriptor, FieldDescriptor, Serialized Form

Constructor Summary

AdapterConfigurationGuiDescriptor()
Create a new AdapterConfigurationGuiDescriptor (that is basically empty)

AdapterConfigurationGuiDescriptor(java.lang.String description)
Create a new AdapterConfigurationGuiDescriptor with a description.

Method Summary

void	addAction(ActionDescriptor action) Add an action to this AdapterConfigurationGuiDescriptor;
void	addAdvancedField(FieldDescriptor fieldDescriptor) Add a an 'advanced' user entry field to this GUI configuration descriptor.
void	addField(FieldDescriptor fieldDescriptor) Add a user entry field to this GUI configuration descriptor.
void	addTable(TableDescriptor table) Add a table to the ordered list of Tables in this AdapterConfigurationGuiDescriptor.
void	addValidator(ConfigurationValidator configurationValidator) Add a ConfigurationValidator to the ordered list of ConfigurationValidators for this AdapterConfigurationGuiDescriptor.
java.util.List<ActionDescriptor>	getActions() Gets the list of ActionDescriptors.
java.util.List<FieldDescriptor>	getAdvancedFields() Gets the ordered list of 'advanced' FieldDescriptors.
java.lang.String	getDescription() Gets the description.
java.util.List<FieldDescriptor>	getFields() Gets the ordered list of FieldDescriptors.
java.util.List<TableDescriptor>	getTables() Gets the ordered list of Tables.
java.util.List<ConfigurationValidator>	getValidationChain() Gets the ordered list of ConfigurationValidators.
boolean	hasActions()
void	setDescription(java.lang.String description) Set the description that will be displayed at the top of the GUI configuration page.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AdapterConfigurationGuiDescriptor

public AdapterConfigurationGuiDescriptor()

Create a new AdapterConfigurationGuiDescriptor (that is basically empty)

AdapterConfigurationGuiDescriptor

public AdapterConfigurationGuiDescriptor(java.lang.String description)

Create a new AdapterConfigurationGuiDescriptor with a description.

Parameters:

description - the description that will be displayed at the top of the GUI configuration page.

Method Detail

addField

public void addField(FieldDescriptor fieldDescriptor)

Add a user entry field to this GUI configuration descriptor. The field will be rendered on the GUI page in the order that they were added.

Please note that FieldDescriptor names must be unique per AdapterConfigurationGuiDescriptor.

Parameters:

fieldDescriptor - the field to add.

getFields

public java.util.List<FieldDescriptor> getFields()

Gets the ordered list of FieldDescriptors.

Returns:

a List of FieldDescriptors.

addAdvancedField

public void addAdvancedField(FieldDescriptor fieldDescriptor)

Add a an 'advanced' user entry field to this GUI configuration descriptor. The field will be rendered on the GUI page in the order that they were added.

'Advanced' fields do not show up on the GUI page initially - the user has to select to see and manipulate the advanced fields. Care should be used with advanced fields - they should be used for configuration options that will rarely need to be changed and default values that won't cause validation errors should be provided.

Please note that FieldDescriptor names must be unique per AdapterConfigurationGuiDescriptor.

Parameters:

fieldDescriptor - the field to add.

getAdvancedFields

public java.util.List<FieldDescriptor> getAdvancedFields()

Gets the ordered list of 'advanced' FieldDescriptors.

Returns:

a List of FieldDescriptors.

addTable

public void addTable(TableDescriptor table)

Add a table to the ordered list of Tables in this AdapterConfigurationGuiDescriptor.

Please note that TableDescriptor names must be unique per AdapterConfigurationGuiDescriptor.

Parameters:

table - the Table to add.

getTables

public java.util.List<TableDescriptor> getTables()

Gets the ordered list of Tables.

Returns:

a List of Tables.

addValidator

public void addValidator(ConfigurationValidator configurationValidator)

Add a ConfigurationValidator to the ordered list of ConfigurationValidators for this AdapterConfigurationGuiDescriptor.

Parameters:

configurationValidator -

getValidationChain

public java.util.List<ConfigurationValidator> getValidationChain()

Gets the ordered list of ConfigurationValidators.

Returns:

a List of ConfigurationValidators.

addAction

public void addAction(ActionDescriptor action)

Add an action to this AdapterConfigurationGuiDescriptor;

Parameters:

action - the ActionDescriptor to add.

getActions

public java.util.List<ActionDescriptor> getActions()

Gets the list of ActionDescriptors.

Returns:

a List of ActionDescriptors.

hasActions

public boolean hasActions()

Returns:

true when actions exist.

getDescription

public java.lang.String getDescription()

Gets the description.

Returns:

the description.

setDescription

public void setDescription(java.lang.String description)

Set the description that will be displayed at the top of the GUI configuration page.

Parameters:

description - the new description.