001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2016 ForgeRock AS.
015 */
016package org.forgerock.opendj.rest2ldap.authz;
017
018import org.forgerock.opendj.ldap.LdapException;
019import org.forgerock.services.context.Context;
020import org.forgerock.services.context.SecurityContext;
021import org.forgerock.util.promise.Promise;
022
023/** Authenticate a user and create a {@link SecurityContext} as a result. */
024public interface AuthenticationStrategy {
025    /**
026     * Authenticate a user.
027     *
028     * @param username
029     *            User to authenticate.
030     * @param password
031     *            Password used to perform the authentication.
032     * @param parentContext
033     *            Context to use as parent for the created {@link SecurityContext}
034     * @return A {@link Context} if the authentication succeed or an {@link LdapException} otherwise.
035     */
036    Promise<SecurityContext, LdapException> authenticate(String username, String password, Context parentContext);
037}