DbProfileService.java

package org.pac4j.sql.profile.service;

import org.pac4j.core.context.WebContext;
import org.pac4j.core.credentials.password.PasswordEncoder;
import org.pac4j.core.profile.definition.CommonProfileDefinition;
import org.pac4j.core.profile.service.AbstractProfileService;
import org.pac4j.core.util.CommonHelper;
import org.pac4j.sql.profile.DbProfile;
import org.skife.jdbi.v2.DBI;
import org.skife.jdbi.v2.Handle;

import javax.sql.DataSource;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

/**
 * The DB profile service (which supersedes the DB authenticator).
 *
 * @author Jerome Leleu
 * @since 2.0.0
 */
public class DbProfileService extends AbstractProfileService<DbProfile> {

    protected DBI dbi;

    private String usersTable = "users";

    private DataSource dataSource;

    public DbProfileService() {}

    public DbProfileService(final DataSource dataSource) {
        this.dataSource = dataSource;
    }

    public DbProfileService(final DataSource dataSource, final String attributes) {
        this.dataSource = dataSource;
        setAttributes(attributes);
    }

    public DbProfileService(final DataSource dataSource, final String attributes, final PasswordEncoder passwordEncoder) {
        this.dataSource = dataSource;
        setAttributes(attributes);
        setPasswordEncoder(passwordEncoder);
    }

    public DbProfileService(final DataSource dataSource, final PasswordEncoder passwordEncoder) {
        this.dataSource = dataSource;
        setPasswordEncoder(passwordEncoder);
    }

    @Override
    protected void internalInit(final WebContext context) {
        CommonHelper.assertNotNull("passwordEncoder", getPasswordEncoder());
        defaultProfileDefinition(new CommonProfileDefinition<>(x -> new DbProfile()));
        CommonHelper.assertNotNull("dataSource", this.dataSource);
        this.dbi = new DBI(this.dataSource);

        super.internalInit(context);
    }

    @Override
    protected void insert(final Map<String, Object> attributes) {
        final List<String> names = new ArrayList<>();
        final List<String> questionMarks = new ArrayList<>();
        final List values = new ArrayList();
        for (final Map.Entry<String, Object> entry : attributes.entrySet()) {
            names.add(entry.getKey());
            questionMarks.add("?");
            values.add(entry.getValue());
        }

        final String query = "insert into " + usersTable + " (" + buildAttributesList(names) + ") values (" + buildAttributesList(questionMarks) + ")";
        execute(query, values.toArray());
    }

    @Override
    protected void update(final Map<String, Object> attributes) {
        final StringBuffer attributesList = new StringBuffer();
        String id = null;
        final List values = new ArrayList();
        int i = 0;
        for (final Map.Entry<String, Object> entry : attributes.entrySet()) {
            final String name = entry.getKey();
            final Object value = entry.getValue();
            if (ID.equals(name)) {
                id = (String) value;
            } else {
                if (i > 0) {
                    attributesList.append(",");
                }
                attributesList.append(name);
                attributesList.append("= :");
                attributesList.append(name);
                values.add(value);
                i++;
            }
        }

        CommonHelper.assertNotNull(ID, id);
        values.add(id);
        final String query = "update " + usersTable + " set " + attributesList.toString() + " where id = :id";
        execute(query, values.toArray());
    }

    @Override
    protected void deleteById(final String id) {
        final String query = "delete from " + usersTable + " where id = :id";
        execute(query, id);
    }

    protected void execute(final String query, final Object... args) {
        Handle h = null;
        try {
            h = dbi.open();
            logger.debug("Execute query: {} and values: {}", query, args);
            h.execute(query, args);
        } finally {
            if (h != null) {
                h.close();
            }
        }
    }

    @Override
    protected List<Map<String, Object>> read(final List<String> names, final String key, final String value) {
        final String attributesList = buildAttributesList(names);

        final String query = "select " + attributesList + " from " + usersTable + " where " + key + " = :" + key;
        return query(query, key, value);
    }

    protected List<Map<String, Object>> query(final String query, final String key, final String value) {
        Handle h = null;
        try {
            h = dbi.open();
            logger.debug("Query: {} for key/value: {} / {}", query, key, value);
            return h.createQuery(query).bind(key, value).list(2);
        } finally {
            if (h != null) {
                h.close();
            }
        }
    }

    protected String buildAttributesList(final List<String> names) {
        final StringBuffer sb = new StringBuffer();
        boolean firstOne = true;
        for (final String name : names) {
            if (!firstOne) {
                sb.append(",");
            }
            sb.append(name);
            firstOne = false;
        }
        return sb.toString();
    }

    public DataSource getDataSource() {
        return dataSource;
    }

    public void setDataSource(final DataSource dataSource) {
        this.dataSource = dataSource;
    }

    public String getUsersTable() {
        return usersTable;
    }

    public void setUsersTable(final String usersTable) {
        CommonHelper.assertNotBlank("usersTable", usersTable);
        this.usersTable = usersTable;
    }

    public DBI getDbi() {
        return dbi;
    }

    @Override
    public String toString() {
        return CommonHelper.toString(this.getClass(), "dataSource", dataSource, "passwordEncoder", getPasswordEncoder(),
                "attributes", getAttributes(), "profileDefinition", getProfileDefinition(), "usersTable", usersTable,
                "idAttribute", getIdAttribute(), "usernameAttribute", getUsernameAttribute(), "passwordAttribute", getPasswordAttribute());
    }
}