wikiauthenticator.java

wiki建站资源 java编写的 很好用

/* 
    JSPWiki - a JSP-based WikiWiki clone.

    Copyright (C) 2001-2004 Janne Jalkanen ([e-mail])

    This program 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 program 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package com.ecyrd.jspwiki.auth;

import java.util.Properties;
import com.ecyrd.jspwiki.NoRequiredPropertyException;

/**
 *  Defines the interface for connecting to different authentication
 *  services.
 *
 *  @since 2.1.11.
 *  @author Erik Bunn
 */
public interface WikiAuthenticator
{
    /**
     * Initializes the WikiAuthenticator based on values from a Properties
     * object.
     */
    public void initialize( Properties props )
        throws NoRequiredPropertyException;

    /**
     * Authenticates a user, using the name and password present in the
     * parameter.
     *
     * @return true, if this is a valid UserProfile, false otherwise.
     * @throws PasswordExpiredException If the password has expired, but is
     *                                  valid otherwise.
     */
    public boolean authenticate( UserProfile wup )
        throws WikiSecurityException;
}