org.picketlink.idm.config

Class IdentityConfiguration

java.lang.Object

org.picketlink.idm.config.IdentityConfiguration

public class IdentityConfiguration
extends Object

Defines the runtime configuration for Identity Management.

You should use this class to provide all necessary configuration for the identity stores that should be supported by the IdentityManager.

Author:

Shane Bryzak

Constructor Summary

Constructors

Constructor and Description
IdentityConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
void	addConfig(IdentityStoreConfiguration config) Registers a IdentityStoreConfiguration.
IdentityManagerFactory	buildIdentityManagerFactory() Builds and returns a new IdentityManagerFactory instance considering all configurations provided.
IdentityConfiguration	contextFactory(SecurityContextFactory securityContextFactory) Sets the SecurityContextFactory that should be used.
FileIdentityStoreConfiguration	fileStore() Returns a FileIdentityStoreConfiguration instance with all configuration options for the file identity store.
List<IdentityStoreConfiguration>	getConfiguredStores() Returns all registered IdentityStoreConfiguration instances.
JPAIdentityStoreConfiguration	jpaStore() Returns a JPAIdentityStoreConfiguration instance with all configuration options for the JPA identity store.
LDAPIdentityStoreConfiguration	ldapStore() Returns a JPAIdentityStoreConfiguration instance with all configuration options for the JPA identity store.
IdentityConfiguration	storeFactory(StoreFactory storeFactory) Sets the StoreFactory that should be used.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityConfiguration

public IdentityConfiguration()

Method Detail

fileStore

public FileIdentityStoreConfiguration fileStore()

Returns a FileIdentityStoreConfiguration instance with all configuration options for the file identity store. For every invocation a new instance will be returned and added to the configuration.

Returns:

jpaStore

public JPAIdentityStoreConfiguration jpaStore()

Returns a JPAIdentityStoreConfiguration instance with all configuration options for the JPA identity store. For every invocation a new instance will be returned and added to the configuration.

Returns:

ldapStore

public LDAPIdentityStoreConfiguration ldapStore()

Returns a JPAIdentityStoreConfiguration instance with all configuration options for the JPA identity store. For every invocation a new instance will be returned and added to the configuration.

Returns:

contextFactory

public IdentityConfiguration contextFactory(SecurityContextFactory securityContextFactory)

Sets the SecurityContextFactory that should be used. If not specified, the implementation will use the default one.

Parameters:

securityContextFactory -

Returns:

storeFactory

public IdentityConfiguration storeFactory(StoreFactory storeFactory)

Sets the StoreFactory that should be used. If not specified, the implementation will use the default one.

Parameters:

storeFactory -

Returns:

getConfiguredStores

public List<IdentityStoreConfiguration> getConfiguredStores()

Returns all registered IdentityStoreConfiguration instances.

Returns:

addConfig

public void addConfig(IdentityStoreConfiguration config)

Registers a IdentityStoreConfiguration. This method can be used to provide other IdentityStoreConfiguration for identity stores that are not provided by default.

Parameters:

config -

buildIdentityManagerFactory

public IdentityManagerFactory buildIdentityManagerFactory()
                                                   throws SecurityConfigurationException

Builds and returns a new IdentityManagerFactory instance considering all configurations provided.

Returns:

Throws:

SecurityConfigurationException - if some error occurs when creating an IdentityManagerFactory instance.