org.pac4j.couch.profile.service

Class CouchProfileService

java.lang.Object

org.pac4j.core.util.InitializableObject

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

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

org.pac4j.couch.profile.service.CouchProfileService

All Implemented Interfaces:

Authenticator<UsernamePasswordCredentials>, ProfileService<CouchProfile>

public class CouchProfileService
extends AbstractProfileService<CouchProfile>

The CouchDB profile service.

Since:

2.0.0

Author:

Elie Roux

Field Summary

Fields

Modifier and Type	Field and Description
static String	COUCH_ID

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

attributeNames, ID, LINKEDID, logger, SERIALIZED_PROFILE

Constructor Summary

Constructors

Constructor and Description
CouchProfileService()
CouchProfileService(org.ektorp.CouchDbConnector couchDbConnector)
CouchProfileService(org.ektorp.CouchDbConnector couchDbConnector, PasswordEncoder passwordEncoder)
CouchProfileService(org.ektorp.CouchDbConnector couchDbConnector, String attributes)
CouchProfileService(org.ektorp.CouchDbConnector couchDbConnector, 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.
org.ektorp.CouchDbConnector	getCouchDbConnector()
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
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	setCouchDbConnector(org.ektorp.CouchDbConnector couchDbConnector)
void	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
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

Field Detail

COUCH_ID

public static final String COUCH_ID

See Also:

Constant Field Values

Constructor Detail

CouchProfileService

public CouchProfileService(org.ektorp.CouchDbConnector couchDbConnector,
                           String attributes,
                           PasswordEncoder passwordEncoder)

CouchProfileService

public CouchProfileService()

CouchProfileService

public CouchProfileService(org.ektorp.CouchDbConnector couchDbConnector)

CouchProfileService

public CouchProfileService(org.ektorp.CouchDbConnector couchDbConnector,
                           String attributes)

CouchProfileService

public CouchProfileService(org.ektorp.CouchDbConnector couchDbConnector,
                           PasswordEncoder passwordEncoder)

Method Detail

internalInit

protected void internalInit()

Description copied from class: InitializableObject

Internal initialization of the object.

Overrides:

internalInit in class AbstractProfileService<CouchProfile>

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

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

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

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

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

getCouchDbConnector

public org.ektorp.CouchDbConnector getCouchDbConnector()

setCouchDbConnector

public void setCouchDbConnector(org.ektorp.CouchDbConnector couchDbConnector)

getObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

setObjectMapper

public void setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

toString

public String toString()

Overrides:

toString in class Object