org.pac4j.ldap.profile.service

Class LdapProfileService

java.lang.Object

org.pac4j.core.util.InitializableWebObject

org.pac4j.core.profile.definition.ProfileDefinitionAware<U>

org.pac4j.core.profile.service.AbstractProfileService<LdapProfile>

org.pac4j.ldap.profile.service.LdapProfileService

All Implemented Interfaces:

Authenticator<UsernamePasswordCredentials>, ProfileService<LdapProfile>

Direct Known Subclasses:

LdapAuthenticator

public class LdapProfileService
extends AbstractProfileService<LdapProfile>

The LDAP profile service (which supersedes the LDAP authenticator). Notice that binary attributes are not supported.

Since:

2.0.0

Author:

Jerome Leleu

Field Summary

Fields inherited from class org.pac4j.core.profile.service.AbstractProfileService

attributeNames, ID, LINKEDID, logger, SERIALIZED_PROFILE

Constructor Summary

Constructors

Constructor and Description
LdapProfileService()
LdapProfileService(org.ldaptive.auth.Authenticator ldapAuthenticator)
LdapProfileService(org.ldaptive.auth.Authenticator ldapAuthenticator, String attributes)
LdapProfileService(org.ldaptive.ConnectionFactory connectionFactory, org.ldaptive.auth.Authenticator ldapAuthenticator, String usersDn)
LdapProfileService(org.ldaptive.ConnectionFactory connectionFactory, org.ldaptive.auth.Authenticator ldapAuthenticator, String attributes, String usersDn)

Method Summary

Modifier and Type	Method and Description
protected void	deleteById(String id) Delete a profile by its identifier in the storage.
protected Map<String,Object>	getAttributesFromEntry(org.ldaptive.LdapEntry entry)
org.ldaptive.ConnectionFactory	getConnectionFactory()
protected String	getEntryId(Map<String,Object> attributes)
protected List<org.ldaptive.LdapAttribute>	getLdapAttributes(Map<String,Object> attributes)
org.ldaptive.auth.Authenticator	getLdapAuthenticator()
String	getUsersDn()
protected void	insert(Map<String,Object> attributes) Insert the attributes in the storage.
protected void	internalInit(WebContext context) Internal initialization of the object.
protected List<Map<String,Object>>	read(List<String> names, String key, String value) Read the list of defined attributes in the storage for key=value query.
void	setConnectionFactory(org.ldaptive.ConnectionFactory connectionFactory)
void	setLdapAuthenticator(org.ldaptive.auth.Authenticator ldapAuthenticator)
void	setUsersDn(String usersDn)
String	toString()
protected void	update(Map<String,Object> attributes) Update the attributes in the storage.
void	validate(UsernamePasswordCredentials credentials, WebContext context) Validate the credentials.

Methods inherited from class org.pac4j.core.profile.service.AbstractProfileService

convertAttributesToProfile, convertProfileAndPasswordToAttributes, create, defineAttributesToRead, findById, findByLinkedId, getAttributes, getIdAttribute, getJavaSerializationHelper, getPasswordAttribute, getPasswordEncoder, getUsernameAttribute, isLegacyMode, remove, removeById, setAttributes, setIdAttribute, setJavaSerializationHelper, setPasswordAttribute, setPasswordEncoder, setUsernameAttribute, update

Methods inherited from class org.pac4j.core.profile.definition.ProfileDefinitionAware

defaultProfileDefinition, getProfileDefinition, setProfileDefinition

Methods inherited from class org.pac4j.core.util.InitializableWebObject

init, reinit

Methods inherited from class java.lang.Object

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

Constructor Detail

LdapProfileService

public LdapProfileService()

LdapProfileService

public LdapProfileService(org.ldaptive.auth.Authenticator ldapAuthenticator)

LdapProfileService

public LdapProfileService(org.ldaptive.auth.Authenticator ldapAuthenticator,
                          String attributes)

LdapProfileService

public LdapProfileService(org.ldaptive.ConnectionFactory connectionFactory,
                          org.ldaptive.auth.Authenticator ldapAuthenticator,
                          String usersDn)

LdapProfileService

public LdapProfileService(org.ldaptive.ConnectionFactory connectionFactory,
                          org.ldaptive.auth.Authenticator ldapAuthenticator,
                          String attributes,
                          String usersDn)

Method Detail

internalInit

protected void internalInit(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Overrides:

internalInit in class AbstractProfileService<LdapProfile>

Parameters:

context - the web context

insert

protected void insert(Map<String,Object> attributes)

Description copied from class: AbstractProfileService

Insert the attributes in the storage.

Specified by:

insert in class AbstractProfileService<LdapProfile>

Parameters:

attributes - the attributes

getEntryId

protected String getEntryId(Map<String,Object> attributes)

getLdapAttributes

protected List<org.ldaptive.LdapAttribute> getLdapAttributes(Map<String,Object> attributes)

update

protected void update(Map<String,Object> attributes)

Description copied from class: AbstractProfileService

Update the attributes in the storage.

Specified by:

update in class AbstractProfileService<LdapProfile>

Parameters:

attributes - the attributes

deleteById

protected void deleteById(String id)

Description copied from class: AbstractProfileService

Delete a profile by its identifier in the storage.

Specified by:

deleteById in class AbstractProfileService<LdapProfile>

Parameters:

id - the identifier

read

protected List<Map<String,Object>> read(List<String> names,
                                        String key,
                                        String value)

Description copied from class: AbstractProfileService

Read the list of defined attributes in the storage for key=value query.

Specified by:

read in class AbstractProfileService<LdapProfile>

Parameters:

names - the attribute names to read

key - the key for the query

value - the value for the query

Returns:

the list of map of attributes

getAttributesFromEntry

protected Map<String,Object> getAttributesFromEntry(org.ldaptive.LdapEntry entry)

validate

public void validate(UsernamePasswordCredentials credentials,
                     WebContext context)
              throws HttpAction,
                     CredentialsException

Description copied from interface: Authenticator

Validate the credentials. It should throw a CredentialsException in case of failure.

Specified by:

validate in interface Authenticator<UsernamePasswordCredentials>

Overrides:

validate in class AbstractProfileService<LdapProfile>

Parameters:

credentials - the given credentials

context - the web context

Throws:

HttpAction - requires a specific HTTP action if necessary

CredentialsException - the credentials are invalid

getConnectionFactory

public org.ldaptive.ConnectionFactory getConnectionFactory()

setConnectionFactory

public void setConnectionFactory(org.ldaptive.ConnectionFactory connectionFactory)

getUsersDn

public String getUsersDn()

setUsersDn

public void setUsersDn(String usersDn)

getLdapAuthenticator

public org.ldaptive.auth.Authenticator getLdapAuthenticator()

setLdapAuthenticator

public void setLdapAuthenticator(org.ldaptive.auth.Authenticator ldapAuthenticator)

toString

public String toString()

Overrides:

toString in class Object