org.picketlink.idm.config
public class LDAPMappingConfigurationBuilder extends AbstractIdentityConfigurationChildBuilder<LDAPMappingConfiguration>
Constructor and Description |
---|
LDAPMappingConfigurationBuilder(Class<? extends AttributedType> attributedType,
LDAPStoreConfigurationBuilder builder) |
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.>
|
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.
|
build, buildAll, named
public LDAPMappingConfigurationBuilder(Class<? extends AttributedType> attributedType, LDAPStoreConfigurationBuilder builder)
protected LDAPMappingConfiguration create()
Builder
Creates a new configuration.
create
in class Builder<LDAPMappingConfiguration>
protected void validate()
Builder
Validates the internal state.
validate
in class Builder<LDAPMappingConfiguration>
protected Builder<LDAPMappingConfiguration> readFrom(LDAPMappingConfiguration fromConfiguration)
Builder
Reads a pre-created configuration.
readFrom
in class Builder<LDAPMappingConfiguration>
public LDAPMappingConfigurationBuilder objectClasses(String... objectClasses)
Defines the object classes for this type.
objectClasses
- public LDAPMappingConfigurationBuilder attribute(@ParameterConfigID(name="propertyName") String propertyName, @ParameterConfigID(name="ldapAttributeName") String ldapAttributeName)
Maps a type property to a specific LDAP attribute.
propertyName
- ldapAttributeName
- public LDAPMappingConfigurationBuilder readOnlyAttribute(@ParameterConfigID(name="propertyName") String propertyName, @ParameterConfigID(name="ldapAttributeName") String ldapAttributeName)
Maps a type property to a specific read-only LDAP attribute.
propertyName
- ldapAttributeName
- 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.
propertyName
- ldapAttributeName
- identifier
- public LDAPMappingConfigurationBuilder hierarchySearchDepth(int hierarchySearchDepth)
Sets the the search depth level when retrieving the hierarchy (usually the parents) for a type.
hierarchySearchDepth
- An int value representing the search depth.public LDAPMappingConfigurationBuilder mapping(Class<? extends AttributedType> attributedType)
Maps a specific AttributedType
.
attributedType
- public LDAPMappingConfigurationBuilder baseDN(String baseDN)
baseDN
- public LDAPMappingConfigurationBuilder forMapping(Class<? extends AttributedType> attributedType)
Associates the given type to a mapped type. This is usually used when configuration relationship types.
attributedType
- public LDAPMappingConfigurationBuilder parentMembershipAttributeName(String parentMembershipAttributeName)
Defines the LDAP attribute name used to create parent-child relationships.
parentMembershipAttributeName
- 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.
parentId
- baseDN
- Copyright © 2015 JBoss by Red Hat. All Rights Reserved.