org.picketlink.idm.config

Interface IdentityStoreConfiguration

All Known Implementing Classes:

AbstractIdentityStoreConfiguration, FileIdentityStoreConfiguration, JPAIdentityStoreConfiguration, LDAPIdentityStoreConfiguration

public interface IdentityStoreConfiguration

Represents a configuration for a specific IdentityStore.

Since:

Sep 6, 2012

Author:

Anil Saldhana, Shane Bryzak

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IdentityStoreConfiguration.IdentityOperation Supported operations for @{AttributedType} types.

Method Summary

Methods

Modifier and Type	Method and Description
void	addContextInitializer(ContextInitializer contextInitializer) Adds a ContextInitializer instance which will be used to initialize IdentityContexts for this configuration.
List<ContextInitializer>	getContextInitializers()
Map<String,Object>	getCredentialHandlerProperties() Allows credential handler behaviour to be customized via a set of property values
List<Class<? extends CredentialHandler>>	getCredentialHandlers() Returns a List of the CredentialHandler types configured.
Class<? extends IdentityStore>	getIdentityStoreType() Returns the IdentityStore type associated with this configuration.
Map<Class<? extends AttributedType>,Set<IdentityStoreConfiguration.IdentityOperation>>	getSupportedTypes()
Map<Class<? extends AttributedType>,Set<IdentityStoreConfiguration.IdentityOperation>>	getUnsupportedTypes()
void	init() Initializes the store configuration with the specified FeatureSet.
void	initializeContext(IdentityContext context, IdentityStore<?> store) Initialize the specified IdentityContext
boolean	supportsPartition() Indicates if this configuration supports partition storage.
boolean	supportsType(Class<? extends AttributedType> type, IdentityStoreConfiguration.IdentityOperation operation) Checks if the configuration supports the given AttributedType and IdentityStoreConfiguration.IdentityOperation.

Method Detail

getContextInitializers

List<ContextInitializer> getContextInitializers()

getUnsupportedTypes

Map<Class<? extends AttributedType>,Set<IdentityStoreConfiguration.IdentityOperation>> getUnsupportedTypes()

getSupportedTypes

Map<Class<? extends AttributedType>,Set<IdentityStoreConfiguration.IdentityOperation>> getSupportedTypes()

init

void init()
          throws SecurityConfigurationException

Initializes the store configuration with the specified FeatureSet.

Throws:

SecurityConfigurationException

addContextInitializer

void addContextInitializer(ContextInitializer contextInitializer)

Adds a ContextInitializer instance which will be used to initialize IdentityContexts for this configuration.

initializeContext

void initializeContext(IdentityContext context,
                     IdentityStore<?> store)

Initialize the specified IdentityContext

Parameters:

context - The IdentityContext to initialize

getCredentialHandlers

List<Class<? extends CredentialHandler>> getCredentialHandlers()

Returns a List of the CredentialHandler types configured.

Returns:

getCredentialHandlerProperties

Map<String,Object> getCredentialHandlerProperties()

Allows credential handler behaviour to be customized via a set of property values

Returns:

supportsType

boolean supportsType(Class<? extends AttributedType> type,
                   IdentityStoreConfiguration.IdentityOperation operation)

Checks if the configuration supports the given AttributedType and IdentityStoreConfiguration.IdentityOperation.

Parameters:

type -

operation -

Returns:

supportsPartition

boolean supportsPartition()

Indicates if this configuration supports partition storage.

Returns:

getIdentityStoreType

Class<? extends IdentityStore> getIdentityStoreType()

Returns the IdentityStore type associated with this configuration.

Returns: