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

Class LdapIdentityProvider

java.lang.Object

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

All Implemented Interfaces:

org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityProvider

@Service
public class LdapIdentityProvider
extends Object
implements org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityProvider

LdapIdentityProvider implements an external identity provider that reads users and groups from an ldap source. Please refer to LdapProviderConfig for configuration options.

Constructor Summary

Constructors

Constructor and Description
LdapIdentityProvider() Default constructor for OSGi
LdapIdentityProvider(LdapProviderConfig config) Constructor for non-OSGi cases.

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalUser	authenticate(Credentials credentials)
void	close() Closes this provider and releases the internal pool.
String	createDNPath(org.apache.directory.api.ldap.model.name.Dn dn) Makes the intermediate path of an DN by splitting along the RDNs
Map<String,org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityRef>	getDeclaredGroupRefs(org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityRef ref) Collects the declared (direct) groups of an identity
Map<String,org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityRef>	getDeclaredMemberRefs(org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityRef ref) Collects the declared (direct) members of a group
org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalGroup	getGroup(String name)
org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentity	getIdentity(org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityRef ref)
String	getName()
org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalUser	getUser(String userId)
Iterator<org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalGroup>	listGroups()
Iterator<org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalUser>	listUsers()

Methods inherited from class java.lang.Object

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

Constructor Detail

LdapIdentityProvider

public LdapIdentityProvider()

Default constructor for OSGi

LdapIdentityProvider

public LdapIdentityProvider(LdapProviderConfig config)

Constructor for non-OSGi cases.

Parameters:

config - the configuration

Method Detail

close

public void close()

Closes this provider and releases the internal pool. This should be called by Non-OSGi users of this provider.

getName

@Nonnull
public String getName()

Specified by:

getName in interface org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityProvider

getIdentity

public org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentity getIdentity(@Nonnull
                                                                                          org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityRef ref)
                                                                                            throws org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityException

Specified by:

getIdentity in interface org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityProvider

Throws:

org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityException

getUser

public org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalUser getUser(@Nonnull
                                                                                  String userId)
                                                                                    throws org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityException

Specified by:

getUser in interface org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityProvider

Throws:

org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityException

getGroup

public org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalGroup getGroup(@Nonnull
                                                                                    String name)
                                                                                      throws org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityException

Specified by:

getGroup in interface org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityProvider

Throws:

org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityException

listUsers

public Iterator<org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalUser> listUsers()
                                                                                                throws org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityException

Specified by:

listUsers in interface org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityProvider

Throws:

org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityException

listGroups

public Iterator<org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalGroup> listGroups()
                                                                                                  throws org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityException

Specified by:

listGroups in interface org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityProvider

Throws:

org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityException

authenticate

public org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalUser authenticate(@Nonnull
                                                                                       Credentials credentials)
                                                                                         throws org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityException,
                                                                                                LoginException

Specified by:

authenticate in interface org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityProvider

Throws:

org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityException

LoginException

getDeclaredGroupRefs

public Map<String,org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityRef> getDeclaredGroupRefs(org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityRef ref)
                                                                                                                    throws org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityException

Collects the declared (direct) groups of an identity

Parameters:

ref - reference to the identity

Returns:

map of identities where the key is the DN of the LDAP entity

Throws:

org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityException

getDeclaredMemberRefs

public Map<String,org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityRef> getDeclaredMemberRefs(org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityRef ref)
                                                                                                                     throws org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityException

Collects the declared (direct) members of a group

Parameters:

ref - the reference to the group

Returns:

map of identity refers

Throws:

org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityException - if an error occurs

createDNPath

public String createDNPath(org.apache.directory.api.ldap.model.name.Dn dn)

Makes the intermediate path of an DN by splitting along the RDNs

Parameters:

dn - the dn of the identity

Returns:

the intermediate path or null if disabled by config