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

This class should be used as the start point to build an IdentityConfiguration instance.

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

Methods

Modifier and Type	Method and Description
IdentityConfiguration	build() Builds a single IdentityConfiguration.
List<IdentityConfiguration>	buildAll() Builds all named configurations.
protected List<IdentityConfiguration>	create() Creates a new configuration.
boolean	isConfigured() Indicates if any configuration was already provided for this instance.
NamedIdentityConfigurationBuilder	named(String configurationName) Creates a named 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 named configuration.

Specified by:

named in interface IdentityConfigurationChildBuilder

Parameters:

configurationName -

Returns:

build

public IdentityConfiguration build()
                            throws SecurityConfigurationException

Description copied from interface: IdentityConfigurationChildBuilder

Builds a single IdentityConfiguration. This method should be used when there is only a single configuration.

For multiple configurations see buildAll.

Specified by:

build in interface IdentityConfigurationChildBuilder

Returns:

Throws:

SecurityConfigurationException - if any error occurs or for any invalid configuration

buildAll

public List<IdentityConfiguration> buildAll()
                                     throws SecurityConfigurationException

Description copied from interface: IdentityConfigurationChildBuilder

Builds all named configurations.

Specified by:

buildAll in interface IdentityConfigurationChildBuilder

Returns:

Throws:

SecurityConfigurationException - if any error occurs or for any invalid configuration

isConfigured

public boolean isConfigured()

Indicates if any configuration was already provided for this instance.

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