org.picketlink.idm.config

Class LDAPMappingConfigurationBuilder

java.lang.Object

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

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

org.picketlink.idm.config.LDAPMappingConfigurationBuilder

All Implemented Interfaces:

IdentityConfigurationChildBuilder

public class LDAPMappingConfigurationBuilder
extends AbstractIdentityConfigurationChildBuilder<LDAPMappingConfiguration>

Author:

Pedro Igor

Constructor Summary

Constructors

Constructor and Description
LDAPMappingConfigurationBuilder(Class<? extends AttributedType> attributedType, LDAPStoreConfigurationBuilder builder)

Method Summary

Methods

Modifier and Type	Method and Description
LDAPMappingConfigurationBuilder	attribute(String propertyName, String ldapAttributeName) Maps a type property to a specific LDAP attribute.
LDAPMappingConfigurationBuilder	attribute(String propertyName, String ldapAttributeName, boolean identifier) Maps a type property to a specific LDAP attribute and mark it as an identifier.
LDAPMappingConfigurationBuilder	baseDN(String baseDN) <>Sets the base DN for this type.
LDAPMappingConfigurationBuilder	bindingAttribute(String propertyName, String ldapAttributeName) Maps a type property to a specific LDAP attribute.
protected LDAPMappingConfiguration	create() Creates a new configuration.
LDAPMappingConfigurationBuilder	forMapping(Class<? extends AttributedType> attributedType) Associates the given type to a mapped type.
LDAPMappingConfigurationBuilder	hierarchySearchDepth(int hierarchySearchDepth) Sets the the search depth level when retrieving the hierarchy (usually the parents) for a type.
LDAPMappingConfigurationBuilder	mapping(Class<? extends AttributedType> attributedType) Maps a specific AttributedType.
LDAPMappingConfigurationBuilder	objectClasses(String... objectClasses) Defines the object classes for this type.
LDAPMappingConfigurationBuilder	parentMapping(String parentId, String baseDN) Defines a alternative Base DN in the cases when this type is a child of a parent entry with the given identifier.
LDAPMappingConfigurationBuilder	parentMembershipAttributeName(String parentMembershipAttributeName) Defines the LDAP attribute name used to create parent-child relationships.
protected Builder<LDAPMappingConfiguration>	readFrom(LDAPMappingConfiguration fromConfiguration) Reads a pre-created configuration.
LDAPMappingConfigurationBuilder	readOnlyAttribute(String propertyName, String ldapAttributeName) Maps a type property to a specific read-only LDAP attribute.
protected void	validate() Validates the internal state.

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

Constructor Detail

LDAPMappingConfigurationBuilder

public LDAPMappingConfigurationBuilder(Class<? extends AttributedType> attributedType,
                               LDAPStoreConfigurationBuilder builder)

Method Detail

create

protected LDAPMappingConfiguration create()

Description copied from class: Builder

Creates a new configuration.

Specified by:

create in class Builder<LDAPMappingConfiguration>

Returns:

validate

protected void validate()

Description copied from class: Builder

Validates the internal state.

Specified by:

validate in class Builder<LDAPMappingConfiguration>

readFrom

protected Builder<LDAPMappingConfiguration> readFrom(LDAPMappingConfiguration fromConfiguration)

Description copied from class: Builder

Reads a pre-created configuration.

Specified by:

readFrom in class Builder<LDAPMappingConfiguration>

Returns:

objectClasses

public LDAPMappingConfigurationBuilder objectClasses(String... objectClasses)

Defines the object classes for this type.

Parameters:

objectClasses -

Returns:

attribute

public LDAPMappingConfigurationBuilder attribute(@ParameterConfigID(name="propertyName")
                                        String propertyName,
                                        @ParameterConfigID(name="ldapAttributeName")
                                        String ldapAttributeName)

Maps a type property to a specific LDAP attribute.

Parameters:

propertyName -

ldapAttributeName -

Returns:

bindingAttribute

public LDAPMappingConfigurationBuilder bindingAttribute(@ParameterConfigID(name="propertyName")
                                               String propertyName,
                                               @ParameterConfigID(name="ldapAttributeName")
                                               String ldapAttributeName)

Maps a type property to a specific LDAP attribute. The given LDAP attribute will be used to construct the distinguished name of entries.

Parameters:

propertyName -

ldapAttributeName -

Returns:

readOnlyAttribute

public LDAPMappingConfigurationBuilder readOnlyAttribute(@ParameterConfigID(name="propertyName")
                                                String propertyName,
                                                @ParameterConfigID(name="ldapAttributeName")
                                                String ldapAttributeName)

Maps a type property to a specific read-only LDAP attribute.

Parameters:

propertyName -

ldapAttributeName -

Returns:

attribute

public LDAPMappingConfigurationBuilder attribute(@ParameterConfigID(name="propertyName")
                                        String propertyName,
                                        @ParameterConfigID(name="ldapAttributeName")
                                        String ldapAttributeName,
                                        @ParameterConfigID(name="identifier")
                                        boolean identifier)

Maps a type property to a specific LDAP attribute and mark it as an identifier.

Parameters:

propertyName -

ldapAttributeName -

identifier -

Returns:

hierarchySearchDepth

public LDAPMappingConfigurationBuilder hierarchySearchDepth(int hierarchySearchDepth)

Sets the the search depth level when retrieving the hierarchy (usually the parents) for a type.

Parameters:

hierarchySearchDepth - An int value representing the search depth.

Returns:

mapping

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

Maps a specific AttributedType.

Parameters:

attributedType -

Returns:

baseDN

public LDAPMappingConfigurationBuilder baseDN(String baseDN)

<>Sets the base DN for this type.

Parameters:

baseDN -

Returns:

forMapping

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

Associates the given type to a mapped type. This is usually used when configuration relationship types.

Parameters:

attributedType -

Returns:

parentMembershipAttributeName

public LDAPMappingConfigurationBuilder parentMembershipAttributeName(String parentMembershipAttributeName)

Defines the LDAP attribute name used to create parent-child relationships.

Parameters:

parentMembershipAttributeName -

Returns:

parentMapping

public LDAPMappingConfigurationBuilder parentMapping(String parentId,
                                            String baseDN)

Defines a alternative Base DN in the cases when this type is a child of a parent entry with the given identifier.

Parameters:

parentId -

baseDN -

Returns: