001/*
002 * $Id: LoginListener.java 3707 2010-07-08 19:19:25Z kschaefe $
003 *
004 * Copyright 2004 Sun Microsystems, Inc., 4150 Network Circle,
005 * Santa Clara, California 95054, U.S.A. All rights reserved.
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 * 
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
015 * Lesser General Public License for more details.
016 * 
017 * You should have received a copy of the GNU Lesser General Public
018 * License along with this library; if not, write to the Free Software
019 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
020 */
021package org.jdesktop.swingx.auth;
022
023import java.util.EventListener;
024
025/**
026 * <b>LoginListener</b> provides a listener for the actual login
027 * process.
028 *
029 * @author Bino George
030 * @author Shai Almog
031 */
032public interface LoginListener extends EventListener {
033    
034    /**
035     *  Called by the <strong>JXLoginPane</strong> in the event of a login failure
036     *
037     * @param source panel that fired the event
038     */
039    public void loginFailed(LoginEvent source);
040    /**
041     *  Called by the <strong>JXLoginPane</strong> when the Authentication
042     *  operation is started.
043     * @param source panel that fired the event
044     */
045    public void loginStarted(LoginEvent source);
046    /**
047     *  Called by the <strong>JXLoginPane</strong> in the event of a login
048     *  cancellation by the user.
049     *
050     * @param source panel that fired the event
051     */
052    public void loginCanceled(LoginEvent source);
053    /**
054     *  Called by the <strong>JXLoginPane</strong> in the event of a
055     *  successful login.
056     *
057     * @param source panel that fired the event
058     */
059    public void loginSucceeded(LoginEvent source);
060}