org.pac4j.sql.profile.service

Class DbProfileService

java.lang.Object

org.pac4j.core.util.InitializableWebObject

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

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

org.pac4j.sql.profile.service.DbProfileService

All Implemented Interfaces:

Authenticator<UsernamePasswordCredentials>, ProfileService<DbProfile>

Direct Known Subclasses:

DbAuthenticator

public class DbProfileService
extends AbstractProfileService<DbProfile>

The DB profile service (which supersedes the DB authenticator).

Since:

2.0.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
protected org.skife.jdbi.v2.DBI	dbi

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

attributeNames, ID, LINKEDID, logger, SERIALIZED_PROFILE

Constructor Summary

Constructors

Constructor and Description
DbProfileService()
DbProfileService(DataSource dataSource)
DbProfileService(DataSource dataSource, PasswordEncoder passwordEncoder)
DbProfileService(DataSource dataSource, String attributes)
DbProfileService(DataSource dataSource, String attributes, PasswordEncoder passwordEncoder)

Method Summary

Modifier and Type	Method and Description
protected String	buildAttributesList(List<String> names)
protected void	deleteById(String id) Delete a profile by its identifier in the storage.
protected void	execute(String query, Object... args)
DataSource	getDataSource()
org.skife.jdbi.v2.DBI	getDbi()
String	getUsersTable()
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>>	query(String query, String key, String value)
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	setDataSource(DataSource dataSource)
void	setUsersTable(String usersTable)
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.InitializableWebObject

init, reinit

Methods inherited from class java.lang.Object

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

Field Detail

dbi

protected org.skife.jdbi.v2.DBI dbi

Constructor Detail

DbProfileService

public DbProfileService()

DbProfileService

public DbProfileService(DataSource dataSource)

DbProfileService

public DbProfileService(DataSource dataSource,
                        String attributes)

DbProfileService

public DbProfileService(DataSource dataSource,
                        String attributes,
                        PasswordEncoder passwordEncoder)

DbProfileService

public DbProfileService(DataSource dataSource,
                        PasswordEncoder passwordEncoder)

Method Detail

internalInit

protected void internalInit(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Overrides:

internalInit in class AbstractProfileService<DbProfile>

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

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

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

Parameters:

id - the identifier

execute

protected void execute(String query,
                       Object... args)

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

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

query

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

buildAttributesList

protected String buildAttributesList(List<String> names)

getDataSource

public DataSource getDataSource()

setDataSource

public void setDataSource(DataSource dataSource)

getUsersTable

public String getUsersTable()

setUsersTable

public void setUsersTable(String usersTable)

getDbi

public org.skife.jdbi.v2.DBI getDbi()

toString

public String toString()

Overrides:

toString in class Object