org.picketlink.idm.config

Class IdentityConfigurationBuilder

java.lang.Object

org.picketlink.idm.config.Builder<List<IdentityConfiguration>>

org.picketlink.idm.config.IdentityConfigurationBuilder

All Implemented Interfaces:

IdentityConfigurationChildBuilder

public class IdentityConfigurationBuilder
extends Builder<List<IdentityConfiguration>>
implements IdentityConfigurationChildBuilder

A class used to build IdentityConfiguration instances, providing a fluent API with some meaningful methods.

It can be initialized in two ways:

• Using the default constructor. In this case all the configuration must be done before invoking one of the build methods.
• Passing a List of IdentityConfiguration. In this case the builder will be initialized with all the configuration read from the provided configurations.

Multiple configurations are supported and each one must have a unique name. At least one configuration must be provided, otherwise the build methods will fail when invoked.

Author:

Pedro Igor

Constructor Summary

Constructors

Constructor and Description
IdentityConfigurationBuilder()
IdentityConfigurationBuilder(List<IdentityConfiguration> configurations) Creates a new instance reading all the configuration from a previously created list of IdentityConfiguration.

Method Summary

Modifier and Type	Method and Description
IdentityConfiguration	build() Builds a single IdentityConfiguration.
List<IdentityConfiguration>	buildAll() Builds a List of IdentityConfiguration.
protected List<IdentityConfiguration>	create() Creates a new configuration.
Collection<NamedIdentityConfigurationBuilder>	getNamedIdentityConfigurationBuilders() Returns all NamedIdentityConfigurationBuilder.
boolean	isConfigured() Indicates if any configuration was already provided for this instance.
NamedIdentityConfigurationBuilder	named(String configurationName) Creates a new configuration.
protected Builder<List<IdentityConfiguration>>	readFrom(List<IdentityConfiguration> fromConfiguration) Reads a pre-created configuration.
protected void	validate() Validates the internal state.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityConfigurationBuilder

public IdentityConfigurationBuilder()

IdentityConfigurationBuilder

public IdentityConfigurationBuilder(List<IdentityConfiguration> configurations)
                             throws SecurityConfigurationException

Creates a new instance reading all the configuration from a previously created list of IdentityConfiguration.

Parameters:

configurations -

Throws:

SecurityConfigurationException - if any error occurs or for any invalid configuration

Method Detail

named

public NamedIdentityConfigurationBuilder named(String configurationName)

Creates a new configuration.

If a configuration with the given configurationName already exists, this method will return the same instance instead of creating a new one.

Specified by:

named in interface IdentityConfigurationChildBuilder

Parameters:

configurationName -

Returns:

build

public IdentityConfiguration build()
                            throws SecurityConfigurationException

Builds a single IdentityConfiguration.

This method should be called when only a single configuration was provided. Otherwise an exception will be thrown.

For building multiple configurations use the buildAll method instead.

Specified by:

build in interface IdentityConfigurationChildBuilder

Returns:

Throws:

SecurityConfigurationException - if multiple configurations was defined, or if any validation check fails or if any error occurs when building the configuration.

buildAll

public List<IdentityConfiguration> buildAll()
                                     throws SecurityConfigurationException

Builds a List of IdentityConfiguration.

This method should be used when multiple configurations exists.

Specified by:

buildAll in interface IdentityConfigurationChildBuilder

Returns:

Throws:

SecurityConfigurationException - if any validation check fails or if any error occurs when building the configuration.

isConfigured

public boolean isConfigured()

Indicates if any configuration was already provided for this instance.

Returns:

getNamedIdentityConfigurationBuilders

public Collection<NamedIdentityConfigurationBuilder> getNamedIdentityConfigurationBuilders()

Returns all NamedIdentityConfigurationBuilder.

Returns:

validate

protected void validate()
                 throws SecurityConfigurationException

Description copied from class: Builder

Validates the internal state.

Specified by:

validate in class Builder<List<IdentityConfiguration>>

Throws:

SecurityConfigurationException - if any error occurs or for any invalid configuration

create

protected List<IdentityConfiguration> create()
                                      throws SecurityConfigurationException

Description copied from class: Builder

Creates a new configuration.

Specified by:

create in class Builder<List<IdentityConfiguration>>

Returns:

Throws:

SecurityConfigurationException - if any error occurs or for any invalid configuration

readFrom

protected Builder<List<IdentityConfiguration>> readFrom(List<IdentityConfiguration> fromConfiguration)
                                                 throws SecurityConfigurationException

Description copied from class: Builder

Reads a pre-created configuration.

Specified by:

readFrom in class Builder<List<IdentityConfiguration>>

Returns:

Throws:

SecurityConfigurationException - if any error occurs or for any invalid configuration