org.pac4j.mongo.profile.service

Class MongoProfileService

java.lang.Object

org.pac4j.core.util.InitializableObject

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

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

org.pac4j.mongo.profile.service.MongoProfileService

All Implemented Interfaces:

Authenticator<UsernamePasswordCredentials>, ProfileService<MongoProfile>

public class MongoProfileService
extends AbstractProfileService<MongoProfile>

The MongoDB profile service (which supersedes the Mongo authenticator).

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
MongoProfileService()
MongoProfileService(com.mongodb.MongoClient mongoClient)
MongoProfileService(com.mongodb.MongoClient mongoClient, PasswordEncoder passwordEncoder)
MongoProfileService(com.mongodb.MongoClient mongoClient, String attributes)
MongoProfileService(com.mongodb.MongoClient mongoClient, String attributes, PasswordEncoder passwordEncoder)

Method Summary

Modifier and Type	Method and Description
protected void	deleteById(String id) Delete a profile by its identifier in the storage.
protected com.mongodb.client.MongoCollection<org.bson.Document>	getCollection()
com.mongodb.MongoClient	getMongoClient()
String	getUsersCollection()
String	getUsersDatabase()
protected void	insert(Map<String,Object> attributes) Insert the attributes in the storage.
protected void	internalInit() 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	setMongoClient(com.mongodb.MongoClient mongoClient)
void	setUsersCollection(String usersCollection)
void	setUsersDatabase(String usersDatabase)
String	toString()
protected void	update(Map<String,Object> attributes) Update the attributes in the storage.

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, validate

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

defaultProfileDefinition, getProfileDefinition, setProfileDefinition

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

init

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoProfileService

public MongoProfileService()

MongoProfileService

public MongoProfileService(com.mongodb.MongoClient mongoClient)

MongoProfileService

public MongoProfileService(com.mongodb.MongoClient mongoClient,
                           String attributes)

MongoProfileService

public MongoProfileService(com.mongodb.MongoClient mongoClient,
                           String attributes,
                           PasswordEncoder passwordEncoder)

MongoProfileService

public MongoProfileService(com.mongodb.MongoClient mongoClient,
                           PasswordEncoder passwordEncoder)

Method Detail

internalInit

protected void internalInit()

Description copied from class: InitializableObject

Internal initialization of the object.

Overrides:

internalInit in class AbstractProfileService<MongoProfile>

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<MongoProfile>

Parameters:

attributes - the 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<MongoProfile>

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<MongoProfile>

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<MongoProfile>

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

getCollection

protected com.mongodb.client.MongoCollection<org.bson.Document> getCollection()

getUsersDatabase

public String getUsersDatabase()

setUsersDatabase

public void setUsersDatabase(String usersDatabase)

getUsersCollection

public String getUsersCollection()

setUsersCollection

public void setUsersCollection(String usersCollection)

getMongoClient

public com.mongodb.MongoClient getMongoClient()

setMongoClient

public void setMongoClient(com.mongodb.MongoClient mongoClient)

toString

public String toString()

Overrides:

toString in class Object