org.picketlink.idm.config

Class BaseAbstractStoreConfiguration<C extends BaseAbstractStoreConfiguration<?>>

java.lang.Object

org.picketlink.idm.config.BaseAbstractStoreConfiguration<C>

All Implemented Interfaces:

IdentityStoreConfiguration

Direct Known Subclasses:

FileIdentityStoreConfiguration, JPAIdentityStoreConfiguration, LDAPIdentityStoreConfiguration

public abstract class BaseAbstractStoreConfiguration<C extends BaseAbstractStoreConfiguration<?>>
extends Object
implements IdentityStoreConfiguration

The base class for store configurations

Author:

Shane Bryzak

Constructor Summary

Constructors

Constructor and Description
BaseAbstractStoreConfiguration(Map<FeatureSet.FeatureGroup,Set<FeatureSet.FeatureOperation>> supportedFeatures, Map<Class<? extends Relationship>,Set<FeatureSet.FeatureOperation>> supportedRelationships, Set<String> realms, Set<String> tiers, List<ContextInitializer> contextInitializers, Map<String,Object> credentialHandlerProperties, List<Class<? extends CredentialHandler>> credentialHandlers)

Method Summary

Methods

Modifier and Type	Method and Description
List<ContextInitializer>	getContextInitializers() Returns all ContextInitializer instances configured for a specific identity store.
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.
Set<String>	getRealms() Returns all configured realms.
Map<FeatureSet.FeatureGroup,Set<FeatureSet.FeatureOperation>>	getSupportedFeatures()
Map<Class<? extends Relationship>,Set<FeatureSet.FeatureOperation>>	getSupportedRelationships()
Set<String>	getTiers()
void	init() Initializes the store configuration with the specified FeatureSet.
protected abstract void	initConfig()
protected void	removeFeature(FeatureSet.FeatureGroup feature) Removes the given FeatureSet.FeatureGroup and all supported FeatureSet.FeatureOperation from the features set.
boolean	supportsFeature(FeatureSet.FeatureGroup feature, FeatureSet.FeatureOperation operation) Check if the FeatureSet.FeatureGroup is supported.
boolean	supportsRelationship(Class<? extends Relationship> relationshipType, FeatureSet.FeatureOperation operation) Check if the given Relationship type is supported.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseAbstractStoreConfiguration

public BaseAbstractStoreConfiguration(Map<FeatureSet.FeatureGroup,Set<FeatureSet.FeatureOperation>> supportedFeatures,
                              Map<Class<? extends Relationship>,Set<FeatureSet.FeatureOperation>> supportedRelationships,
                              Set<String> realms,
                              Set<String> tiers,
                              List<ContextInitializer> contextInitializers,
                              Map<String,Object> credentialHandlerProperties,
                              List<Class<? extends CredentialHandler>> credentialHandlers)

Method Detail

init

public final void init()
                throws SecurityConfigurationException

Description copied from interface: IdentityStoreConfiguration

Initializes the store configuration with the specified FeatureSet.

Specified by:

init in interface IdentityStoreConfiguration

Throws:

SecurityConfigurationException

initConfig

protected abstract void initConfig()

getContextInitializers

public List<ContextInitializer> getContextInitializers()

Description copied from interface: IdentityStoreConfiguration

Returns all ContextInitializer instances configured for a specific identity store.

Specified by:

getContextInitializers in interface IdentityStoreConfiguration

Returns:

getCredentialHandlers

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

Description copied from interface: IdentityStoreConfiguration

Returns a List of the CredentialHandler types configured.

Specified by:

getCredentialHandlers in interface IdentityStoreConfiguration

Returns:

getCredentialHandlerProperties

public Map<String,Object> getCredentialHandlerProperties()

Description copied from interface: IdentityStoreConfiguration

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

Specified by:

getCredentialHandlerProperties in interface IdentityStoreConfiguration

Returns:

supportsFeature

public boolean supportsFeature(FeatureSet.FeatureGroup feature,
                      FeatureSet.FeatureOperation operation)

Check if the FeatureSet.FeatureGroup is supported.

Specified by:

supportsFeature in interface IdentityStoreConfiguration

Parameters:

feature -

operation -

Returns:

supportsRelationship

public boolean supportsRelationship(Class<? extends Relationship> relationshipType,
                           FeatureSet.FeatureOperation operation)

Check if the given Relationship type is supported.

Specified by:

supportsRelationship in interface IdentityStoreConfiguration

Parameters:

feature -

operation -

Returns:

getRealms

public Set<String> getRealms()

Description copied from interface: IdentityStoreConfiguration

Returns all configured realms.

Specified by:

getRealms in interface IdentityStoreConfiguration

Returns:

getTiers

public Set<String> getTiers()

Specified by:

getTiers in interface IdentityStoreConfiguration

Returns:

getSupportedFeatures

public Map<FeatureSet.FeatureGroup,Set<FeatureSet.FeatureOperation>> getSupportedFeatures()

Specified by:

getSupportedFeatures in interface IdentityStoreConfiguration

getSupportedRelationships

public Map<Class<? extends Relationship>,Set<FeatureSet.FeatureOperation>> getSupportedRelationships()

Specified by:

getSupportedRelationships in interface IdentityStoreConfiguration

removeFeature

protected void removeFeature(FeatureSet.FeatureGroup feature)
                      throws SecurityConfigurationException

Removes the given FeatureSet.FeatureGroup and all supported FeatureSet.FeatureOperation from the features set.

Parameters:

feature -

Throws:

SecurityConfigurationException - If this instance is locked and changes are no more allowed.