org.sourceid.saml20.adapter.gui

Class TableDescriptor

java.lang.Object

org.sourceid.saml20.adapter.gui.TableDescriptor

public class TableDescriptor
extends Object

A class that describes to the PingFederate server the way a table of fields should be rendered.

See Also:

GuiConfigDescriptor.addTable(TableDescriptor), FieldDescriptor, RowValidator

Constructor Summary

Constructors

Constructor and Description
TableDescriptor(String name, String description) Create a TableDescriptor with a name and description.
TableDescriptor(String name, String description, boolean requireDefaultRow) Create a TableDescriptor with a name, description and default row is required.
TableDescriptor(String name, String description, List<FieldDescriptor> row) Create a TableDescriptor with a name, description and a list of fields that comprise a row in the table.

Method Summary

Modifier and Type	Method and Description
void	addRowField(FieldDescriptor fieldDescriptor) Add a FieldDescriptor to the list of fields that make up a row in this table.
void	addValidator(RowValidator validator) Add a RowValidator to the ordered list of RowValidator for this table.
String	getDescription() Gets the description of this table.
String	getLabel() Gets the label of this table that will be rendered in the administrative console configuration pages.
String	getName() Gets the name of this table.
boolean	getRequireDefaultRow()
List<FieldDescriptor>	getRowFields() Gets the List of FieldDescriptors that make up a row in this table.
List<RowValidator>	getValidationChain() Gets the list of RowValidators for this table
void	setLabel(String label) Sets the label of this table that will be rendered in the administrative console configuration pages.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableDescriptor

public TableDescriptor(String name,
                       String description)

Create a TableDescriptor with a name and description. The name and description will be displayed on the GUI configuration page.

Parameters:

name - The table name. To ensure configuration can be read in future releases of a plugin, it is recommended to not change the names - instead use a label to rename a table in the administrative console.

description - A helpful description of the table.

TableDescriptor

public TableDescriptor(String name,
                       String description,
                       boolean requireDefaultRow)

Create a TableDescriptor with a name, description and default row is required. The name and description will be displayed on the GUI configuration page.

Parameters:

name - The table name. To ensure configuration can be read in future releases of a plugin, it is recommended to not change the names - instead use a label to rename a table in the administrative console.

description - A helpful description of the table.

requireDefaultRow - Boolean to indicate if this table requires setting a default row

TableDescriptor

public TableDescriptor(String name,
                       String description,
                       List<FieldDescriptor> row)

Create a TableDescriptor with a name, description and a list of fields that comprise a row in the table. The name and description will be displayed on the GUI configuration page. And the Fields in the row will make up the entry fields in each row of the table in the GUI.

Parameters:

name - The table name. To ensure configuration can be read in future releases of a plugin, it is recommended to not change the names - instead use a label to rename a table in the administrative console.

description - A helpful description of the table.

row - A List of FieldDescriptors that describe a row in the table.

Method Detail

getDescription

public String getDescription()

Gets the description of this table.

Returns:

the description.

setLabel

public void setLabel(String label)

Sets the label of this table that will be rendered in the administrative console configuration pages. If set, the label will take precedence over the name for how the table is rendered in the administrative console. This is intended to be used as a strategy for renaming tables in future releases of a plugin, while preserving the handling of existing configuration.

Parameters:

label - The desired table label value.

Since:

9.0

getLabel

public String getLabel()

Gets the label of this table that will be rendered in the administrative console configuration pages. If it is not explicitly set, the name of the table will be returned as the label.

Returns:

the label of the table.

Since:

9.0

getName

public String getName()

Gets the name of this table.

Returns:

the name.

getRowFields

public List<FieldDescriptor> getRowFields()

Gets the List of FieldDescriptors that make up a row in this table.

Returns:

a List of FieldDescriptors.

addRowField

public void addRowField(FieldDescriptor fieldDescriptor)

Add a FieldDescriptor to the list of fields that make up a row in this table.

Parameters:

fieldDescriptor - the field to add as the last field in the row.

addValidator

public void addValidator(RowValidator validator)

Add a RowValidator to the ordered list of RowValidator for this table.

Parameters:

validator - the validator

getValidationChain

public List<RowValidator> getValidationChain()

Gets the list of RowValidators for this table

Returns:

a list of RowValidators.

getRequireDefaultRow

public boolean getRequireDefaultRow()