org.picketlink.idm.config

Class IdentityStoresConfigurationBuilder

java.lang.Object

org.picketlink.idm.config.Builder<T>

org.picketlink.idm.config.AbstractIdentityConfigurationChildBuilder<List<? extends IdentityStoreConfiguration>>

org.picketlink.idm.config.IdentityStoresConfigurationBuilder

All Implemented Interfaces:

IdentityConfigurationChildBuilder, IdentityStoreConfigurationChildBuilder

public class IdentityStoresConfigurationBuilder
extends AbstractIdentityConfigurationChildBuilder<List<? extends IdentityStoreConfiguration>>
implements IdentityStoreConfigurationChildBuilder

A class used to build the configuration for identity stores. Only a single configuration can exists for a given identity store.

Author:

Pedro Igor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IdentityStoresConfigurationBuilder(NamedIdentityConfigurationBuilder builder)

Method Summary

Methods

Modifier and Type	Method and Description
<T extends IdentityStoreConfigurationBuilder<?,?>> T	add(Class<? extends IdentityStoreConfiguration> identityStoreConfiguration, Class<T> builder) Adds support for a custom IdentityStore.
protected List<? extends IdentityStoreConfiguration>	create() Creates a new configuration.
FileStoreConfigurationBuilder	file() Configures a file-based identity store for this configuration.
protected Set<Class<? extends Relationship>>	getGlobalRelationships()
List<IdentityStoreConfigurationBuilder<?,?>>	getIdentityStoresConfigurationBuilder()
protected Set<Class<? extends Relationship>>	getSelfRelationships()
JDBCStoreConfigurationBuilder	jdbc() Configures a JDBC based Identity Store
JPAStoreConfigurationBuilder	jpa() Configures a jpa-based identity store for this configuration.
LDAPStoreConfigurationBuilder	ldap() Configures a ldap-based identity store for this configuration.
protected IdentityStoresConfigurationBuilder	readFrom(List<? extends IdentityStoreConfiguration> fromConfiguration) Reads a pre-created configuration.
TokenStoreConfigurationBuilder	token() Configures a token-based identity store for this configuration.
protected void	validate() Validates the internal state.

Methods inherited from class org.picketlink.idm.config.AbstractIdentityConfigurationChildBuilder

build, buildAll, named

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.picketlink.idm.config.IdentityConfigurationChildBuilder

build, buildAll, named

Constructor Detail

IdentityStoresConfigurationBuilder

protected IdentityStoresConfigurationBuilder(NamedIdentityConfigurationBuilder builder)

Method Detail

file

public FileStoreConfigurationBuilder file()

Configures a file-based identity store for this configuration.

Specified by:

file in interface IdentityStoreConfigurationChildBuilder

Returns:

jdbc

public JDBCStoreConfigurationBuilder jdbc()

Configures a JDBC based Identity Store

Returns:

jpa

public JPAStoreConfigurationBuilder jpa()

Configures a jpa-based identity store for this configuration.

Specified by:

jpa in interface IdentityStoreConfigurationChildBuilder

Returns:

ldap

public LDAPStoreConfigurationBuilder ldap()

Configures a ldap-based identity store for this configuration.

Specified by:

ldap in interface IdentityStoreConfigurationChildBuilder

Returns:

token

public TokenStoreConfigurationBuilder token()

Configures a token-based identity store for this configuration.

This identity store does not persist data, but only extracts information from tokens in order to perform some basic identity management operations. In this case, a token acts as a temporary identity store from where all identity data will be retrieved.

Usually, tokens are a self-contained repository for the identities or claims for a particular subject.

Specified by:

token in interface IdentityStoreConfigurationChildBuilder

Returns:

add

@MethodConfigID(name="customIdentityStore")
public <T extends IdentityStoreConfigurationBuilder<?,?>> T add(@ParameterConfigID(name="identityStoreConfigurationClass")
                                                                          Class<? extends IdentityStoreConfiguration> identityStoreConfiguration,
                                                                          @ParameterConfigID(name="builderClass")
                                                                          Class<T> builder)

Adds support for a custom IdentityStore.

Specified by:

add in interface IdentityStoreConfigurationChildBuilder

Parameters:

identityStoreConfiguration -

builder -

Returns:

getIdentityStoresConfigurationBuilder

public List<IdentityStoreConfigurationBuilder<?,?>> getIdentityStoresConfigurationBuilder()

create

protected List<? extends IdentityStoreConfiguration> create()

Description copied from class: Builder

Creates a new configuration.

Specified by:

create in class Builder<List<? extends IdentityStoreConfiguration>>

Returns:

validate

protected void validate()

Description copied from class: Builder

Validates the internal state.

Specified by:

validate in class Builder<List<? extends IdentityStoreConfiguration>>

readFrom

protected IdentityStoresConfigurationBuilder readFrom(List<? extends IdentityStoreConfiguration> fromConfiguration)

Description copied from class: Builder

Reads a pre-created configuration.

Specified by:

readFrom in class Builder<List<? extends IdentityStoreConfiguration>>

Returns:

getGlobalRelationships

protected Set<Class<? extends Relationship>> getGlobalRelationships()

getSelfRelationships

protected Set<Class<? extends Relationship>> getSelfRelationships()