org.picketlink.idm.config

Class LDAPStoreConfigurationBuilder

java.lang.Object

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

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

org.picketlink.idm.config.IdentityStoreConfigurationBuilder<LDAPIdentityStoreConfiguration,LDAPStoreConfigurationBuilder>

org.picketlink.idm.config.LDAPStoreConfigurationBuilder

All Implemented Interfaces:

IdentityConfigurationChildBuilder, IdentityStoreConfigurationChildBuilder

public class LDAPStoreConfigurationBuilder
extends IdentityStoreConfigurationBuilder<LDAPIdentityStoreConfiguration,LDAPStoreConfigurationBuilder>

IdentityStoreConfigurationBuilder implementation which knows how to build a LDAPIdentityStoreConfiguration.

Author:

Pedro Igor

Constructor Summary

Constructors

Constructor and Description
LDAPStoreConfigurationBuilder(IdentityStoresConfigurationBuilder builder)

Method Summary

Modifier and Type	Method and Description
LDAPStoreConfigurationBuilder	activeDirectory(boolean activeDirectory) Indicates if the underlying server is a Microsft Activde Directory.
LDAPStoreConfigurationBuilder	baseDN(String baseDN) Sets the base DN.
LDAPStoreConfigurationBuilder	bindCredential(String bindCredential) Sets the credential for the bindDN used to connect to the LDAP server.
LDAPStoreConfigurationBuilder	bindDN(String bindDN) Sets the DN used to connect to the LDAP server.
LDAPStoreConfigurationBuilder	connectionProperties(Properties connectionProperties) Set additional connection properties.
protected LDAPIdentityStoreConfiguration	create() Creates a new configuration.
LDAPMappingConfigurationBuilder	mapping(Class<? extends AttributedType> attributedType) Maps a specific AttributedType.
LDAPStoreConfigurationBuilder	pagination(boolean pagination) Indicates if pagination will be used for searching identity objects.
protected LDAPStoreConfigurationBuilder	readFrom(LDAPIdentityStoreConfiguration configuration) Reads a pre-created configuration.
LDAPStoreConfigurationBuilder	uniqueIdentifierAttributeName(String uniqueIdentifierAttributeName) Name of unique identifier attribute (ID) which may differ in various LDAP servers.
LDAPStoreConfigurationBuilder	url(String url) Configures the URL of the LDAP server.
protected void	validate() Validates the internal state.

Methods inherited from class org.picketlink.idm.config.IdentityStoreConfigurationBuilder

add, addContextInitializer, addCredentialHandler, file, getContextInitializers, getCredentialHandlerProperties, getCredentialHandlers, getGlobalRelationshipTypes, getSelfRelationshipTypes, getSupportedTypes, getUnsupportedTypes, isSupportAttributes, isSupportCredentials, isSupportPermissions, jpa, ldap, setCredentialHandlerProperty, supportAllFeatures, supportAttributes, supportCredentials, supportGlobalRelationship, supportPermissions, supportSelfRelationship, supportType, token, unsupportType

Methods inherited from class org.picketlink.idm.config.AbstractIdentityConfigurationChildBuilder

build, buildAll, named

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

LDAPStoreConfigurationBuilder

public LDAPStoreConfigurationBuilder(IdentityStoresConfigurationBuilder builder)

Method Detail

url

public LDAPStoreConfigurationBuilder url(String url)

Configures the URL of the LDAP server. The URL should be in the format ldap://ldapserver.com:389.

Parameters:

url -

Returns:

baseDN

public LDAPStoreConfigurationBuilder baseDN(String baseDN)

Sets the base DN.

Parameters:

baseDN -

Returns:

bindDN

public LDAPStoreConfigurationBuilder bindDN(String bindDN)

Sets the DN used to connect to the LDAP server.

Parameters:

bindDN -

Returns:

bindCredential

public LDAPStoreConfigurationBuilder bindCredential(String bindCredential)

Sets the credential for the bindDN used to connect to the LDAP server.

Parameters:

bindCredential -

Returns:

activeDirectory

public LDAPStoreConfigurationBuilder activeDirectory(boolean activeDirectory)

Indicates if the underlying server is a Microsft Activde Directory.

Parameters:

activeDirectory -

Returns:

pagination

public LDAPStoreConfigurationBuilder pagination(boolean pagination)

Indicates if pagination will be used for searching identity objects. Needs that LDAP server supports PagedResultsControl

Parameters:

pagination -

Returns:

uniqueIdentifierAttributeName

public LDAPStoreConfigurationBuilder uniqueIdentifierAttributeName(String uniqueIdentifierAttributeName)

Name of unique identifier attribute (ID) which may differ in various LDAP servers. Will use default value LDAPConstants.ENTRY_UUID or LDAPConstants.OBJECT_GUID for Active Directory if not provided in configuration

Parameters:

uniqueIdentifierAttributeName -

Returns:

mapping

public LDAPMappingConfigurationBuilder mapping(Class<? extends AttributedType> attributedType)

Maps a specific AttributedType.

Parameters:

attributedType -

Returns:

connectionProperties

public LDAPStoreConfigurationBuilder connectionProperties(Properties connectionProperties)

Set additional connection properties.

Returns:

create

protected LDAPIdentityStoreConfiguration create()

Description copied from class: Builder

Creates a new configuration.

Specified by:

create in class Builder<LDAPIdentityStoreConfiguration>

Returns:

validate

protected void validate()

Description copied from class: Builder

Validates the internal state.

Overrides:

validate in class IdentityStoreConfigurationBuilder<LDAPIdentityStoreConfiguration,LDAPStoreConfigurationBuilder>

readFrom

protected LDAPStoreConfigurationBuilder readFrom(LDAPIdentityStoreConfiguration configuration)

Description copied from class: Builder

Reads a pre-created configuration.

Overrides:

readFrom in class IdentityStoreConfigurationBuilder<LDAPIdentityStoreConfiguration,LDAPStoreConfigurationBuilder>

Returns: