com.haulmont.cuba.web.security.ldap

Class LdapLoginProvider

java.lang.Object

com.haulmont.cuba.web.security.ldap.LdapLoginProvider

All Implemented Interfaces:

LoginProvider, org.springframework.core.Ordered

@Component(value="cuba_LdapLoginProvider")
public class LdapLoginProvider
extends java.lang.Object
implements LoginProvider, org.springframework.core.Ordered

Login provider that uses LDAP as authentication service.

See Also:

WebLdapConfig

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthenticationService	authenticationService
protected org.springframework.ldap.core.support.LdapContextSource	ldapContextSource
protected org.springframework.ldap.core.LdapTemplate	ldapTemplate
protected Messages	messages
protected WebAuthConfig	webAuthConfig
protected WebLdapConfig	webLdapConfig

Fields inherited from interface com.haulmont.cuba.web.security.LoginProvider

HIGHEST_PLATFORM_PRECEDENCE, LOWEST_PLATFORM_PRECEDENCE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
LdapLoginProvider()

Method Summary

Modifier and Type	Method and Description
protected boolean	authenticateInLdap(LoginPasswordCredentials credentials)
protected java.lang.String	buildPersonFilter(java.lang.String login)
protected void	checkRequiredConfigProperties(WebLdapConfig webLdapConfig)
int	getOrder()
protected void	init()
AuthenticationDetails	login(Credentials credentials) Authenticates a user and provides authentication details.
protected AuthenticationDetails	loginMiddleware(Credentials credentials)
boolean	supports(java.lang.Class<?> credentialsClass) Checks if this provider supports passed credentials class or not.

Methods inherited from class java.lang.Object

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

Field Detail

authenticationService

@Inject
protected AuthenticationService authenticationService

webLdapConfig

@Inject
protected WebLdapConfig webLdapConfig

webAuthConfig

@Inject
protected WebAuthConfig webAuthConfig

messages

@Inject
protected Messages messages

ldapContextSource

protected org.springframework.ldap.core.support.LdapContextSource ldapContextSource

ldapTemplate

protected org.springframework.ldap.core.LdapTemplate ldapTemplate

Constructor Detail

LdapLoginProvider

public LdapLoginProvider()

Method Detail

login

@Nullable
public AuthenticationDetails login(Credentials credentials)
                                      throws LoginException

Description copied from interface: LoginProvider

Authenticates a user and provides authentication details. Starts session on middleware.

Specified by:

login in interface LoginProvider

Parameters:

credentials - credentials

Returns:

authentication details or null if passed credentials object cannot be processed

Throws:

LoginException - if authentication fails

loginMiddleware

protected AuthenticationDetails loginMiddleware(Credentials credentials)
                                         throws LoginException

Throws:

LoginException

authenticateInLdap

protected boolean authenticateInLdap(LoginPasswordCredentials credentials)
                              throws LoginException

Throws:

LoginException

supports

public boolean supports(java.lang.Class<?> credentialsClass)

Description copied from interface: LoginProvider

Checks if this provider supports passed credentials class or not.

Specified by:

supports in interface LoginProvider

Parameters:

credentialsClass - credentials class

Returns:

true if this provider supports the indicated Credentials object.

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

buildPersonFilter

protected java.lang.String buildPersonFilter(java.lang.String login)

checkRequiredConfigProperties

protected void checkRequiredConfigProperties(WebLdapConfig webLdapConfig)

init

@PostConstruct
protected void init()