org.picketlink.idm.config

Interface IdentityStoreConfiguration

All Known Implementing Classes:

AbstractIdentityStoreConfiguration, FileIdentityStoreConfiguration, JDBCIdentityStoreConfiguration, JPAIdentityStoreConfiguration, LDAPIdentityStoreConfiguration, TokenStoreConfiguration

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() Returns a List of the configured context initializers for this configuration.
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	initializeContext(IdentityContext context, IdentityStore<?> store) Initialize the specified IdentityContext
boolean	supportsAttribute() Indicates if ad-hoc attributes are supported.
boolean	supportsCredential() Indicates if credentials are supported.
boolean	supportsPartition() Indicates if this configuration supports partition storage.
boolean	supportsPermissions() Indicates whether this configuration supports the storing of resource permissions
boolean	supportsRelationship() Indicates if relationships are supported.
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()

Returns a List of the configured context initializers for this configuration. Each context initializer performs a specific initialization task for the IdentityContext before it is passed to the identity store, for example setting references to system resources (such as an EntityManager) required by the identity store to perform its identity operations.

Returns:

getUnsupportedTypes

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

getSupportedTypes

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

supportsAttribute

boolean supportsAttribute()

Indicates if ad-hoc attributes are supported.

Returns:

supportsCredential

boolean supportsCredential()

Indicates if credentials are supported.

Returns:

supportsRelationship

boolean supportsRelationship()

Indicates if relationships are supported.

Returns:

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:

supportsPermissions

boolean supportsPermissions()

Indicates whether this configuration supports the storing of resource permissions

Returns:

getIdentityStoreType

Class<? extends IdentityStore> getIdentityStoreType()

Returns the IdentityStore type associated with this configuration.

Returns: