Package org.springframework.ldap.core

Interface LdapClient.AuthenticateSpec

Enclosing interface:

LdapClient

public static interface LdapClient.AuthenticateSpec

The specifications for the LdapClient.authenticate() request.

Method Summary

Modifier and Type	Method	Description
void	execute()	Authenticate the query against the provided password
<T> T	execute(AuthenticatedLdapEntryContextMapper<T> mapper)	Authenticate the query against the provided password.
LdapClient.AuthenticateSpec	password(String password)	The password to use
LdapClient.AuthenticateSpec	query(LdapQuery query)	The query to authenticate

Method Details

query

LdapClient.AuthenticateSpec query(LdapQuery query)

The query to authenticate

Parameters:

query - the query to authenticate

Returns:

the LdapClient.AuthenticateSpec for further configuration

password

LdapClient.AuthenticateSpec password(String password)

The password to use

Parameters:

password - the password to use

Returns:

the LdapClient.AuthenticateSpec for further configuration

execute

void execute()

Authenticate the query against the provided password

Throws:

AuthenticationException - if authentication fails or the query returns no results

execute

<T> T execute(AuthenticatedLdapEntryContextMapper<T> mapper)

Authenticate the query against the provided password.

Parameters:

mapper - a strategy for mapping the query results against another datasource

Throws:

AuthenticationException - if authentication fails or the query returns no results