org.bonitasoft.engine.authentication.GenericAuthenticationService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bonita-server Show documentation

There is a newer version: 10.2.0

/**
 * Copyright (C) 2015 BonitaSoft S.A.
 * BonitaSoft, 32 rue Gustave Eiffel - 38000 Grenoble
 * This library is free software; you can redistribute it and/or modify it under the terms
 * of the GNU Lesser General Public License as published by the Free Software Foundation
 * version 2.1 of the License.
 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License along with this
 * program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
 * Floor, Boston, MA 02110-1301, USA.
 **/
package org.bonitasoft.engine.authentication;

import java.io.Serializable;
import java.util.Map;

/**
 * @author Julien Reboul
 * @since 6.3
 */
public interface GenericAuthenticationService {

    /**
     * Check user credentials by give user name and passwordHash
     * 
     * @param credentials
     *        the credentials elements to use to authenticate
     * @return the username of the user authenticated.
     * @throws AuthenticationException
     *         Error thrown if either the password is invalid or the user is not found.
     */
    String checkUserCredentials(Map credentials) throws AuthenticationException;
}