org.picketlink.idm.config

Class IdentityStoreConfigurationBuilder<T extends IdentityStoreConfiguration,S extends IdentityStoreConfigurationBuilder<T,S>>

java.lang.Object

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

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

org.picketlink.idm.config.IdentityStoreConfigurationBuilder<T,S>

All Implemented Interfaces:

IdentityConfigurationChildBuilder, IdentityStoreConfigurationChildBuilder

Direct Known Subclasses:

FileStoreConfigurationBuilder, JPAStoreConfigurationBuilder, LDAPStoreConfigurationBuilder

public abstract class IdentityStoreConfigurationBuilder<T extends IdentityStoreConfiguration,S extends IdentityStoreConfigurationBuilder<T,S>>
extends AbstractIdentityConfigurationChildBuilder<T>
implements IdentityStoreConfigurationChildBuilder

Base class for IdentityStoreConfigurationBuilder implementations.

Author:

Pedro Igor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IdentityStoreConfigurationBuilder(IdentityStoresConfigurationBuilder builder)

Method Summary

Methods

Modifier and Type	Method and Description
<U extends IdentityStoreConfigurationBuilder<?,?>> U	add(Class<? extends IdentityStoreConfiguration> identityStoreConfiguration, Class<U> builder)
S	addContextInitializer(ContextInitializer contextInitializer) Adds a ContextInitializer.
S	addCredentialHandler(Class<? extends CredentialHandler> credentialHandler) Adds a custom .
FileStoreConfigurationBuilder	file()
protected List<ContextInitializer>	getContextInitializers()
protected Map<String,Object>	getCredentialHandlerProperties()
protected Set<Class<? extends CredentialHandler>>	getCredentialHandlers()
protected Set<Class<? extends Relationship>>	getGlobalRelationshipTypes()
protected Set<Class<? extends Relationship>>	getSelfRelationshipTypes()
protected Map<Class<? extends AttributedType>,Set<IdentityStoreConfiguration.IdentityOperation>>	getSupportedTypes()
protected Map<Class<? extends AttributedType>,Set<IdentityStoreConfiguration.IdentityOperation>>	getUnsupportedTypes()
protected boolean	isSupportAttributes()
protected boolean	isSupportCredentials()
JPAStoreConfigurationBuilder	jpa()
LDAPStoreConfigurationBuilder	ldap()
protected Builder<T>	readFrom(T configuration) Reads a pre-created configuration.
S	setCredentialHandlerProperty(String propertyName, Object value) Sets a configuration property for a CredentialHandler.
S	supportAllFeatures() Enables the default feature set for this configuration.
S	supportAttributes(boolean supportAttributes) Enable/Disable attribute support
S	supportCredentials(boolean supportCredentials) Enable/Disable credentials support
S	supportGlobalRelationship(Class<? extends Relationship>... types) Defines which types should be supported by this configuration.
S	supportSelfRelationship(Class<? extends Relationship>... types) Defines which types should be supported by this configuration.
S	supportType(Class<? extends AttributedType>... attributedTypes) Defines which types should be supported by this configuration.
S	unsupportType(Class<? extends AttributedType> type, IdentityStoreConfiguration.IdentityOperation... operations) Defines which type should not be supported by 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 org.picketlink.idm.config.Builder

create

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

IdentityStoreConfigurationBuilder

protected IdentityStoreConfigurationBuilder(IdentityStoresConfigurationBuilder builder)

Method Detail

file

public FileStoreConfigurationBuilder file()

Specified by:

file in interface IdentityStoreConfigurationChildBuilder

jpa

public JPAStoreConfigurationBuilder jpa()

Specified by:

jpa in interface IdentityStoreConfigurationChildBuilder

ldap

public LDAPStoreConfigurationBuilder ldap()

Specified by:

ldap in interface IdentityStoreConfigurationChildBuilder

supportType

public S supportType(Class<? extends AttributedType>... attributedTypes)

Defines which types should be supported by this configuration.

Parameters:

types -

Returns:

unsupportType

public S unsupportType(Class<? extends AttributedType> type,
              IdentityStoreConfiguration.IdentityOperation... operations)

Defines which type should not be supported by this configuration.

If the operation was not provided, the type should be completely removed from the supported types. Otherwise, only the provided operations should not be supported.

Parameters:

type -

operation -

Returns:

supportGlobalRelationship

public S supportGlobalRelationship(Class<? extends Relationship>... types)

Defines which types should be supported by this configuration.

Parameters:

types -

Returns:

supportSelfRelationship

public S supportSelfRelationship(Class<? extends Relationship>... types)

Defines which types should be supported by this configuration.

Parameters:

types -

Returns:

supportAllFeatures

public S supportAllFeatures()

Enables the default feature set for this configuration.

Returns:

addContextInitializer

public S addContextInitializer(ContextInitializer contextInitializer)

Adds a ContextInitializer.

Parameters:

contextInitializer -

Returns:

setCredentialHandlerProperty

public S setCredentialHandlerProperty(String propertyName,
                             Object value)

Sets a configuration property for a CredentialHandler.

Parameters:

propertyName -

value -

Returns:

addCredentialHandler

public S addCredentialHandler(Class<? extends CredentialHandler> credentialHandler)

Adds a custom .

Parameters:

credentialHandler -

Returns:

supportCredentials

public S supportCredentials(boolean supportCredentials)

Enable/Disable credentials support

Parameters:

supportCredentials -

Returns:

supportAttributes

public S supportAttributes(boolean supportAttributes)

Enable/Disable attribute support

Parameters:

supportAttributes -

Returns:

validate

protected void validate()

Description copied from class: Builder

Validates the internal state.

Specified by:

validate in class Builder<T extends IdentityStoreConfiguration>

readFrom

protected Builder<T> readFrom(T configuration)

Description copied from class: Builder

Reads a pre-created configuration.

Specified by:

readFrom in class Builder<T extends IdentityStoreConfiguration>

Returns:

getContextInitializers

protected List<ContextInitializer> getContextInitializers()

getCredentialHandlerProperties

protected Map<String,Object> getCredentialHandlerProperties()

getCredentialHandlers

protected Set<Class<? extends CredentialHandler>> getCredentialHandlers()

getSupportedTypes

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

getUnsupportedTypes

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

getGlobalRelationshipTypes

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

getSelfRelationshipTypes

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

isSupportAttributes

protected boolean isSupportAttributes()

isSupportCredentials

protected boolean isSupportCredentials()

add

public <U extends IdentityStoreConfigurationBuilder<?,?>> U add(Class<? extends IdentityStoreConfiguration> identityStoreConfiguration,
                                                       Class<U> builder)

Specified by:

add in interface IdentityStoreConfigurationChildBuilder