com.pingidentity.pa.sdk.ui

Class ConfigurationBuilder

java.lang.Object

com.pingidentity.pa.sdk.ui.ConfigurationBuilder

public class ConfigurationBuilder
extends Object

Creates an ordered set of ConfigurationField. Usually used in the implementation of DescribesUIConfigurable, specifically the getConfigurationFields method.

For example:

 
  @Override
 public Set<ConfigurationField> getConfigurationFields() {
     return new ConfigurationBuilder()
         .configurationField(PARAM_TYPE_NAME, PARAM_TYPE_LABEL, ConfigurationType.SELECT)
         .option(PARAM_TYPE_QUERYSTRING_OPTION_NAME, PARAM_TYPE_QUERYSTRING_OPTION_LABEL)
         .option(PARAM_TYPE_COOKIE_OPTION_NAME, PARAM_TYPE_COOKIE_OPTION_LABEL)
         .helpContent("This allows the user to choose a source for variables to validate.")
         .helpTitle(PARAM_TYPE_LABEL + " to control access with.")
         .helpURL("http://en.wikipedia.org/wiki/Query_string")
         .configurationField(PARAM_TABLE_NAME, PARAM_TABLE_LABEL, ConfigurationType.TABLE)
         .subFields(
             new ConfigurationBuilder()
             .configurationField(PARAM_NAME_NAME, PARAM_NAME_LABEL, ConfigurationType.TEXT)
             .required()
             .configurationField(PARAM_VALUE_NAME, PARAM_VALUE_LABEL, ConfigurationType.TEXT)
             .required()
             .toConfigurationFields())
         .toConfigurationFields();
 }
 
 

You must provide a configurationField to perform operations upon. Ex. Calling required() before calling configurationField(...) will cause an NPE.

Does not null check.

Constructor Summary

Constructors

Constructor and Description
ConfigurationBuilder() Constructor for the ConfigurationBuilder.
ConfigurationBuilder(Set<ConfigurationField> fields) Constructor for the ConfigurationBuilder.

Method Summary

Modifier and Type	Method and Description
ConfigurationBuilder	addAll(Collection<ConfigurationField> fieldsToAdd) Adds a collection of ConfigurationFields
ConfigurationBuilder	advanced() Sets the advanced flag on the last set ConfigurationField to true
ConfigurationBuilder	advanced(boolean advanced) Sets the advanced flag on the last set ConfigurationField
ConfigurationBuilder	buttonGroup(String buttonGroup) Sets the button group on the last ConfigurationField
ConfigurationBuilder	clear() Clears the content of the ConfigurationBuilder
ConfigurationBuilder	configurationField(ConfigurationField field) Adds an individual ConfigurationField
ConfigurationBuilder	configurationField(String fieldName, String fieldLabel, ConfigurationType fieldType) Adds an individual ConfigurationField
ConfigurationBuilder	configurationField(String fieldName, String fieldLabel, ConfigurationType fieldType, Set<ConfigurationOption> configurationOptions) Adds an individual ConfigurationField (used for multivalued fieldTypes, as it provides configuration options)
ConfigurationBuilder	defaultValue(String theDefault) Sets the defaultValue on the last set ConfigurationField.
ConfigurationBuilder	deselectable() Allows a radio button to be deselected for the last ConfigurationField
ConfigurationBuilder	deselectable(boolean deselectable) Allows or denies a radio button from being deselected for the last ConfigurationField
ConfigurationBuilder	dynamicOptions(Class<? extends ConfigurationModelAccessor> clazz) Replaces the last ConfigurationField with a DynamicOptionsConfigurationField and applies the provided ConfigurationModelAccessor class to be used by the DynamicOptionsConfigurationField.
static ConfigurationBuilder	from(Class clazz) Factory method that builds a ConfigurationBuilder from a class by parsing the UIElement annotations.
ConfigurationBuilder	help() Creates Help on the last ConfigurationField.
ConfigurationBuilder	helpContent(String content) Sets the content on the last ConfigurationField's Help.
ConfigurationBuilder	helpTitle(String title) Sets the title on the last ConfigurationField's Help.
ConfigurationBuilder	helpURL(String url) Sets the URL on the last ConfigurationField's Help.
ConfigurationBuilder	label(String label) Sets the label on the last ConfigurationField
ConfigurationBuilder	name(String name) Sets the name on the last ConfigurationField
ConfigurationBuilder	option(ConfigurationOption option) Adds an option to the last ConfigurationField
ConfigurationBuilder	option(String value, String label) Adds an option to the last ConfigurationField
ConfigurationBuilder	options(Set<ConfigurationOption> options) Sets the options on the last ConfigurationField
ConfigurationBuilder	parentField(ConfigurationParentField configurationParentField) Sets the ConfigurationParentField on the last set ConfigurationField.
ConfigurationBuilder	privateKeysConfigurationField(String fieldName, String fieldLabel) Defines a ConfigurationField of type ConfigurationType.SELECT and applies KeyPairAccessor as the DynamicOptions
ConfigurationBuilder	required() Adds the Required flag on the last ConfigurationField and sets it to true
ConfigurationBuilder	required(boolean required) Adds the Required flag to the last ConfigurationField and sets it to the specified value
ConfigurationBuilder	subField(String fieldName, String fieldLabel, ConfigurationType fieldType) Adds an individual subfield to the last ConfigurationField
ConfigurationBuilder	subField(String fieldName, String fieldLabel, ConfigurationType fieldType, Set<ConfigurationOption> configurationOptions) Add an individual subfield to the last Configuration field
ConfigurationBuilder	subFields(List<ConfigurationField> theFields) Sets the subfields on the last set ConfigurationField.
List<ConfigurationField>	toConfigurationFields() Returns a list of ConfigurationFields for this ConfigurationBuilder
ConfigurationField	toFirstField() Returns the first defined ConfigurationField
ConfigurationBuilder	trustedCertificatesConfigurationField(String fieldName, String fieldLabel) Defines a ConfigurationField of type ConfigurationType.SELECT and applies TrustedCertificateGroupAccessor as the DynamicOptions
ConfigurationBuilder	type(ConfigurationType type) Sets the Type value on the last ConfigurationField

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationBuilder

public ConfigurationBuilder()

Constructor for the ConfigurationBuilder.

ConfigurationBuilder

public ConfigurationBuilder(Set<ConfigurationField> fields)

Constructor for the ConfigurationBuilder.

Parameters:

fields - the ConfigurationFields for this ConfigurationBuilder

Method Detail

from

public static ConfigurationBuilder from(Class clazz)

Factory method that builds a ConfigurationBuilder from a class by parsing the UIElement annotations.

If the type of a field annotated with UIElement is an Enum and the UIElement does not set UIElement.options(), then this method will derive the associated ConfigurationOption instances for the field from the Enum values, using the Enum.name() for the ConfigurationOption.getValue() value and Enum.toString() for the ConfigurationOption.getLabel() value.

Parameters:

clazz - class to parse

Returns:

A new ConfigurationBuilder

clear

public ConfigurationBuilder clear()

Clears the content of the ConfigurationBuilder

Returns:

this

configurationField

public ConfigurationBuilder configurationField(String fieldName,
                                               String fieldLabel,
                                               ConfigurationType fieldType,
                                               Set<ConfigurationOption> configurationOptions)

Adds an individual ConfigurationField (used for multivalued fieldTypes, as it provides configuration options)

Parameters:

fieldName - Name of the ConfigurationField

fieldLabel - Label for the ConfigurationField

fieldType - Type for the ConfigurationField

configurationOptions - Options to be provided for the ConfigurationField

Returns:

this

configurationField

public ConfigurationBuilder configurationField(String fieldName,
                                               String fieldLabel,
                                               ConfigurationType fieldType)

Adds an individual ConfigurationField

Parameters:

fieldName - Name of the ConfigurationField

fieldLabel - Label for the ConfigurationField

fieldType - Type for the ConfigurationField

Returns:

this

configurationField

public ConfigurationBuilder configurationField(ConfigurationField field)

Adds an individual ConfigurationField

Parameters:

field - the ConfigurationField to add

Returns:

this

addAll

public ConfigurationBuilder addAll(Collection<ConfigurationField> fieldsToAdd)

Adds a collection of ConfigurationFields

Parameters:

fieldsToAdd - a collection of ConfigurationFields to add

Returns:

this

advanced

public ConfigurationBuilder advanced()

Sets the advanced flag on the last set ConfigurationField to true

Returns:

this

advanced

public ConfigurationBuilder advanced(boolean advanced)

Sets the advanced flag on the last set ConfigurationField

Parameters:

advanced - true if the last set ConfigurationField is advanced

Returns:

this

defaultValue

public ConfigurationBuilder defaultValue(String theDefault)

Sets the defaultValue on the last set ConfigurationField.

Parameters:

theDefault - the default value of the last set ConfigurationField

Returns:

this

subFields

public ConfigurationBuilder subFields(List<ConfigurationField> theFields)

Sets the subfields on the last set ConfigurationField. Assumes the last ConfigurationField is a ConfigurationType.TABLE or ConfigurationType.COMPOSITE. Only one level is supported.

Parameters:

theFields - a List of ConfigurationFields to set as subfields on the last set ConfigurationField

Returns:

this

subField

public ConfigurationBuilder subField(String fieldName,
                                     String fieldLabel,
                                     ConfigurationType fieldType,
                                     Set<ConfigurationOption> configurationOptions)

Add an individual subfield to the last Configuration field

Parameters:

fieldName - Name of the ConfigurationField

fieldLabel - Label for the ConfigurationField

fieldType - Type for the ConfigurationField

configurationOptions - Options to be provided for the ConfigurationField

Returns:

this

subField

public ConfigurationBuilder subField(String fieldName,
                                     String fieldLabel,
                                     ConfigurationType fieldType)

Adds an individual subfield to the last ConfigurationField

Parameters:

fieldName - Name of the ConfigurationField

fieldLabel - Label for the ConfigurationField

fieldType - Type for the ConfigurationField

Returns:

this

dynamicOptions

public ConfigurationBuilder dynamicOptions(Class<? extends ConfigurationModelAccessor> clazz)

Replaces the last ConfigurationField with a DynamicOptionsConfigurationField and applies the provided ConfigurationModelAccessor class to be used by the DynamicOptionsConfigurationField.

Parameters:

clazz - the ConfigurationModelAccessor class

Returns:

this

parentField

public ConfigurationBuilder parentField(ConfigurationParentField configurationParentField)

Sets the ConfigurationParentField on the last set ConfigurationField.

Parameters:

configurationParentField - array of ConfigurationParentField

Returns:

this

label

public ConfigurationBuilder label(String label)

Sets the label on the last ConfigurationField

Parameters:

label - the label on the last ConfigurationField

Returns:

this

name

public ConfigurationBuilder name(String name)

Sets the name on the last ConfigurationField

Parameters:

name - the name on the last ConfigurationField

Returns:

this

options

public ConfigurationBuilder options(Set<ConfigurationOption> options)

Sets the options on the last ConfigurationField

Parameters:

options - the options on the last ConfigurationField

Returns:

this

option

public ConfigurationBuilder option(String value,
                                   String label)

Adds an option to the last ConfigurationField

Parameters:

value - the value of the ConfigurationOption

label - the label of the ConfigurationOption

Returns:

this

option

public ConfigurationBuilder option(ConfigurationOption option)

Adds an option to the last ConfigurationField

Parameters:

option - the ConfigurationOption

Returns:

this

required

public ConfigurationBuilder required()

Adds the Required flag on the last ConfigurationField and sets it to true

Returns:

this

required

public ConfigurationBuilder required(boolean required)

Adds the Required flag to the last ConfigurationField and sets it to the specified value

Parameters:

required - true if the last ConfigurationField is required

Returns:

this

buttonGroup

public ConfigurationBuilder buttonGroup(String buttonGroup)

Sets the button group on the last ConfigurationField

Parameters:

buttonGroup - the button group of the last ConfigurationField

Returns:

this

deselectable

public ConfigurationBuilder deselectable()

Allows a radio button to be deselected for the last ConfigurationField

Returns:

this

deselectable

public ConfigurationBuilder deselectable(boolean deselectable)

Allows or denies a radio button from being deselected for the last ConfigurationField

Parameters:

deselectable - true if the last ConfigurationField is deselectable

Returns:

this

type

public ConfigurationBuilder type(ConfigurationType type)

Sets the Type value on the last ConfigurationField

Parameters:

type - the ConfigurationType of the last ConfigurationField

Returns:

this

helpContent

public ConfigurationBuilder helpContent(String content)

Sets the content on the last ConfigurationField's Help. Creates Help if one does not exist.

Parameters:

content - the content on the last ConfigurationField's help

Returns:

this

helpTitle

public ConfigurationBuilder helpTitle(String title)

Sets the title on the last ConfigurationField's Help. Creates Help if one does not exist.

Parameters:

title - the title on the last ConfigurationField's help

Returns:

this

helpURL

public ConfigurationBuilder helpURL(String url)

Sets the URL on the last ConfigurationField's Help. Creates Help if one does not exist.

Parameters:

url - the URL on the last ConfigurationField's help

Returns:

this

help

public ConfigurationBuilder help()

Creates Help on the last ConfigurationField.

Returns:

this

privateKeysConfigurationField

public ConfigurationBuilder privateKeysConfigurationField(String fieldName,
                                                          String fieldLabel)

Defines a ConfigurationField of type ConfigurationType.SELECT and applies KeyPairAccessor as the DynamicOptions

Parameters:

fieldName - the field name

fieldLabel - the field label

Returns:

this

trustedCertificatesConfigurationField

public ConfigurationBuilder trustedCertificatesConfigurationField(String fieldName,
                                                                  String fieldLabel)

Defines a ConfigurationField of type ConfigurationType.SELECT and applies TrustedCertificateGroupAccessor as the DynamicOptions

Parameters:

fieldName - the field name

fieldLabel - the field label

Returns:

this

toConfigurationFields

public List<ConfigurationField> toConfigurationFields()

Returns a list of ConfigurationFields for this ConfigurationBuilder

Returns:

a list of ConfigurationFields for this ConfigurationBuilder

toFirstField

public ConfigurationField toFirstField()

Returns the first defined ConfigurationField

Returns:

the first defined ConfigurationField