Package 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:

ExternalIdentityProvider, PrincipalNameResolver

public class LdapIdentityProvider
extends Object
implements ExternalIdentityProvider, PrincipalNameResolver

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	Description
LdapIdentityProvider()	Default constructor for OSGi
LdapIdentityProvider(@NotNull LdapProviderConfig config)	Constructor for non-OSGi cases.

Method Summary

Modifier and Type	Method	Description
ExternalUser	authenticate(@NotNull Credentials credentials)	Authenticates the user represented by the given credentials and returns it.
void	close()	Closes this provider and releases the internal pool.
@NotNull String	fromExternalIdentityRef(@NotNull ExternalIdentityRef externalIdentityRef)	Deduce the name of the Principal associated with the ExternalIdentity represented by the given ExternalIdentityRef.
ExternalGroup	getGroup(@NotNull String name)	Returns the group for the given (local) group name.
ExternalIdentity	getIdentity(@NotNull ExternalIdentityRef ref)	Returns the identity for the given reference or null if it does not exist.
@NotNull String	getName()	Returns the name of this provider.
ExternalUser	getUser(@NotNull String userId)	Returns the user for the given (local) id.
@NotNull Iterator<ExternalGroup>	listGroups()	List all external groups.
@NotNull Iterator<ExternalUser>	listUsers()	List all external users.

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(@NotNull
                            @NotNull 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.

fromExternalIdentityRef

@NotNull
public @NotNull String fromExternalIdentityRef(@NotNull
                                               @NotNull ExternalIdentityRef externalIdentityRef)
                                        throws ExternalIdentityException

Description copied from interface: PrincipalNameResolver

Deduce the name of the Principal associated with the ExternalIdentity represented by the given ExternalIdentityRef.

Specified by:

fromExternalIdentityRef in interface PrincipalNameResolver

Parameters:

externalIdentityRef - A valid ExternalIdentityRef to an existing ExternalIdentity

Returns:

The name of the Principal associated with the external identity referenced by the given externalIdentityRef.

Throws:

ExternalIdentityException - If the reference is not valid or another error occurs.

getName

@NotNull
public @NotNull String getName()

Description copied from interface: ExternalIdentityProvider

Returns the name of this provider.

Specified by:

getName in interface ExternalIdentityProvider

Returns:

the provider name.

getIdentity

public ExternalIdentity getIdentity(@NotNull
                                    @NotNull ExternalIdentityRef ref)
                             throws ExternalIdentityException

Description copied from interface: ExternalIdentityProvider

Returns the identity for the given reference or null if it does not exist. The provider should check if the provider name matches his own name or is null and should not return a foreign identity.

Specified by:

getIdentity in interface ExternalIdentityProvider

Parameters:

ref - the reference

Returns:

an identity or null

Throws:

ExternalIdentityException - if an error occurs.

getUser

public ExternalUser getUser(@NotNull
                            @NotNull String userId)
                     throws ExternalIdentityException

Description copied from interface: ExternalIdentityProvider

Returns the user for the given (local) id. if the user does not exist null is returned.

Specified by:

getUser in interface ExternalIdentityProvider

Parameters:

userId - the user id.

Returns:

the user or null

Throws:

ExternalIdentityException - if an error occurs.

getGroup

public ExternalGroup getGroup(@NotNull
                              @NotNull String name)
                       throws ExternalIdentityException

Description copied from interface: ExternalIdentityProvider

Returns the group for the given (local) group name. if the group does not exist null is returned.

Specified by:

getGroup in interface ExternalIdentityProvider

Parameters:

name - the group name

Returns:

the group or null

Throws:

ExternalIdentityException - if an error occurs.

listUsers

@NotNull
public @NotNull Iterator<ExternalUser> listUsers()
                                          throws ExternalIdentityException

Description copied from interface: ExternalIdentityProvider

List all external users.

Specified by:

listUsers in interface ExternalIdentityProvider

Returns:

an iterator over all external users

Throws:

ExternalIdentityException - if an error occurs.

listGroups

@NotNull
public @NotNull Iterator<ExternalGroup> listGroups()
                                            throws ExternalIdentityException

Description copied from interface: ExternalIdentityProvider

List all external groups.

Specified by:

listGroups in interface ExternalIdentityProvider

Returns:

an iterator over all external groups

Throws:

ExternalIdentityException - if an error occurs.

authenticate

public ExternalUser authenticate(@NotNull
                                 @NotNull Credentials credentials)
                          throws ExternalIdentityException,
                                 LoginException

Description copied from interface: ExternalIdentityProvider

Authenticates the user represented by the given credentials and returns it. If the user does not exist in this provider, null is returned. If the authentication fails, a LoginException is thrown.

Specified by:

authenticate in interface ExternalIdentityProvider

Parameters:

credentials - the credentials

Returns:

the user or null

Throws:

ExternalIdentityException - if an error occurs

LoginException - if the user could not be authenticated