org.apache.jackrabbit.oak.security.authentication.ldap.impl

Class LdapProviderConfig.Identity

java.lang.Object

org.apache.jackrabbit.oak.security.authentication.ldap.impl.LdapProviderConfig.Identity

Enclosing class:

LdapProviderConfig

public class LdapProviderConfig.Identity
extends Object

Defines the configuration of an identity (user or group).

Constructor Summary

Constructors

Constructor and Description
LdapProviderConfig.Identity()

Method Summary

Methods

Modifier and Type	Method and Description
String	getBaseDN() Configures the base DN for searches of this kind of identity
String	getExtraFilter() Configures the extra LDAP filter that is appended to the internally computed filter when searching for identities.
String	getIdAttribute() Configures the attribute that is used to identify this identity by id.
String[]	getObjectClasses() Configures the object classes of this kind of identity.
String	getSearchFilter(String id) Returns the LDAP filter that is used when searching this type of identity.
boolean	makeDnPath() Configures if the identities DN should be used to generate a portion of the authorizables intermediate path.
LdapProviderConfig.Identity	setBaseDN(String baseDN) Sets the base DN for search of this kind of identity.
LdapProviderConfig.Identity	setExtraFilter(String extraFilter) Sets the extra search filter.
LdapProviderConfig.Identity	setIdAttribute(String idAttribute) Sets the id attribute.
LdapProviderConfig.Identity	setMakeDnPath(boolean makeDnPath) Sets the intermediate path flag.
LdapProviderConfig.Identity	setObjectClasses(String... objectClasses) Sets the object classes.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LdapProviderConfig.Identity

public LdapProviderConfig.Identity()

Method Detail

getBaseDN

@Nonnull
public String getBaseDN()

Configures the base DN for searches of this kind of identity

Returns:

the base DN

setBaseDN

@Nonnull
public LdapProviderConfig.Identity setBaseDN(@Nonnull
                                            String baseDN)

Sets the base DN for search of this kind of identity.

Parameters:

baseDN - the DN as string.

Returns:

this

See Also:

getBaseDN()

getObjectClasses

@Nonnull
public String[] getObjectClasses()

Configures the object classes of this kind of identity.

Returns:

an array of object classes

See Also:

for more detail about searching and filtering

setObjectClasses

@Nonnull
public LdapProviderConfig.Identity setObjectClasses(@Nonnull
                                                   String... objectClasses)

Sets the object classes.

Parameters:

objectClasses - the object classes

Returns:

this

See Also:

getObjectClasses()

getIdAttribute

@Nonnull
public String getIdAttribute()

Configures the attribute that is used to identify this identity by id. For users this is the attribute that holds the user id, for groups this is the attribute that holds the group name.

Returns:

the id attribute name

See Also:

for more detail about searching and filtering

setIdAttribute

@Nonnull
public LdapProviderConfig.Identity setIdAttribute(@Nonnull
                                                 String idAttribute)

Sets the id attribute.

Parameters:

idAttribute - the id attribute name

Returns:

this

See Also:

getIdAttribute()

getExtraFilter

@CheckForNull
public String getExtraFilter()

Configures the extra LDAP filter that is appended to the internally computed filter when searching for identities.

Returns:

the extra filter

setExtraFilter

@Nonnull
public LdapProviderConfig.Identity setExtraFilter(@Nullable
                                                 String extraFilter)

Sets the extra search filter.

Parameters:

extraFilter - the filter

Returns:

this

See Also:

getExtraFilter()

makeDnPath

public boolean makeDnPath()

Configures if the identities DN should be used to generate a portion of the authorizables intermediate path.

Returns:

true if the DN is used a intermediate path.

setMakeDnPath

@Nonnull
public LdapProviderConfig.Identity setMakeDnPath(boolean makeDnPath)

Sets the intermediate path flag.

Parameters:

makeDnPath - true to use the DN as intermediate path

Returns:

this

See Also:

makeDnPath()

getSearchFilter

@Nonnull
public String getSearchFilter(@Nonnull
                             String id)

Returns the LDAP filter that is used when searching this type of identity. The filter is based on the configuration and has the following format:

     (&(${idAttr}=${id})(objectclass=${objectclass})${extraFilter})
 

Note that the objectclass part is repeated according to the specified objectclasses in getObjectClasses().

Parameters:

id - the id value

Returns:

the search filter

toString

public String toString()

Overrides:

toString in class Object