XWikiAuthService.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This 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; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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 software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package com.xpn.xwiki.user.api;

import java.security.Principal;

import com.xpn.xwiki.XWikiContext;
import com.xpn.xwiki.XWikiException;

public interface XWikiAuthService
{
    XWikiUser checkAuth(XWikiContext context) throws XWikiException;

    /**
     * Authenticates the user.
     *
     * @param username the user name for the user to authenticate
     * @param password the password of the user to authenticate
     * @param context the XWiki context object
     * @return null if the user is not authenticated properly or a {@link XWikiUser} object representing the
     *         authenticated user if successful
     * @throws XWikiException in case of authentication error
     */
    XWikiUser checkAuth(String username, String password, String rememberme, XWikiContext context)
        throws XWikiException;

    void showLogin(XWikiContext context) throws XWikiException;

    /**
     * @return a null Principal Object if the user hasn't been authenticated or a valid Principal Object if the user is
     *         correctly authenticated
     */
    Principal authenticate(String username, String password, XWikiContext context) throws XWikiException;
}