001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bstefanescu
018 */
019package org.nuxeo.runtime.api.login;
020
021import java.security.Principal;
022
023/**
024 * Authenticate the given username against the given password.
025 * <p>
026 * This service should be exposed by a user manager framework implementation.
027 *
028 * @author <a href="mailto:[email protected]">Bogdan Stefanescu</a>
029 */
030public interface Authenticator {
031
032    /**
033     * Get a principal object for the given username if the username / password pair is valid, otherwise returns null.
034     * <p>
035     * This method is doing the authentication of the given username / password pair and returns the corresponding
036     * principal object if authentication succeeded otherwise returns null.
037     *
038     * @param name
039     * @param password
040     * @return the authenticated principal if authentication succeded otherwise null
041     */
042    public Principal authenticate(String name, String password);
043
044    /**
045     * Check the password for the given username. Returns true if the username / password pair match, false otherwise.
046     *
047     * @param name the username
048     * @param password the password to check
049     * @return true is valid, false otherwise
050     */
051    public boolean checkUsernamePassword(String name, String password);
052
053}