LoginService.java
资源名称:swingx.zip [点击查看]
上传用户:zhengdagz
上传日期:2014-03-06
资源大小:1956k
文件大小:8k
源码类别:
xml/soap/webservice
开发平台:
Java
- /*
- * $Id: LoginService.java,v 1.5 2005/10/10 18:02:51 rbair Exp $
- *
- * Copyright 2004 Sun Microsystems, Inc., 4150 Network Circle,
- * Santa Clara, California 95054, U.S.A. All rights reserved.
- *
- * This library 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 library 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 library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
- */
- package org.jdesktop.swingx.auth;
- import java.io.IOException;
- import java.util.*;
- import java.awt.EventQueue;
- import javax.swing.SwingUtilities;
- /**
- * <b>LoginService</b> is the abstract base class for all classes implementing
- * a login mechanism. It allows you to customize the threading behaviour
- * used to perform the login. Subclasses need to override the <b>authenticate</b>
- * method.
- * Subclasses may implement the getUserRoles() method to return a meaningful value
- * this method will be called once upon a successful login to determine the user roles.
- * It is not defined as abstract to simplify the task of implementing a login service
- * for those who do not require this functionality.
- *
- * @author Bino George
- * @author Shai Almog
- */
- public abstract class LoginService {
- private Vector<LoginListener> listenerList = new Vector<LoginListener>();
- private Thread loginThread;
- /*
- * Controls the authentication behaviour to be either
- * synchronous or asynchronous
- */
- private boolean synchronous;
- private boolean canceled;
- private String server;
- public LoginService() {
- }
- public LoginService(String server) {
- setServer(server);
- }
- /**
- * This method is intended to be implemented by clients
- * wishing to authenticate a user with a given password.
- * Clients should implement the authentication in a
- * manner that the authentication can be cancelled at
- * any time.
- *
- * @param name username
- * @param password password
- * @param server server (optional)
- *
- * @return <code>true</code> on authentication success
- * @throws IOException
- */
- public abstract boolean authenticate(String name, char[] password, String server) throws IOException;
- /**
- * Called immediately after a successful authentication. This method should return an array
- * of user roles or null if role based permissions are not used.
- *
- * @return per default <code>null</code>
- */
- public String[] getUserRoles() {
- return null;
- }
- /**
- * Notifies the LoginService that an already running
- * authentication request should be cancelled. This
- * method is intended to be used by clients who want
- * to provide user with control over cancelling a long
- * running authentication request.
- */
- public void cancelAuthentication() {
- canceled = true;
- EventQueue.invokeLater(new Runnable() {
- public void run() {
- fireLoginCanceled(new LoginEvent(this));
- }
- });
- }
- /**
- * This method is intended to be overridden by subclasses
- * to customize the threading to use pooling etc. The default
- * implementation just creates a new Thread with the given runnable.
- *
- * @param runnable runnable
- * @return a new login thread
- */
- public Thread getLoginThread(Runnable runnable) {
- return new Thread(runnable);
- }
- /**
- * This method starts the authentication process and is either
- * synchronous or asynchronous based on the synchronous property
- *
- * @param user user
- * @param password password
- * @param server server
- * @throws IOException
- */
- public void startAuthentication(final String user, final char[] password, final String server) throws IOException {
- canceled = false;
- if (getSynchronous()) {
- if (authenticate(user,password,server)) {
- fireLoginSucceeded(new LoginEvent(this));
- } else {
- fireLoginFailed(new LoginEvent(this));
- }
- } else {
- Runnable runnable = new Runnable() {
- public void run() {
- try {
- final boolean result = authenticate(user,password,server);
- if (!canceled) {
- EventQueue.invokeLater(new Runnable() {
- public void run() {
- if (result) {
- fireLoginSucceeded(new LoginEvent(LoginService.this));
- }
- else {
- fireLoginFailed(new LoginEvent(LoginService.this));
- }
- }
- });
- }
- } catch(final IOException failed) {
- SwingUtilities.invokeLater(new Runnable() {
- public void run() {
- fireLoginFailed(new LoginEvent(LoginService.this, failed));
- }
- });
- }
- }
- };
- loginThread = getLoginThread(runnable) ;
- loginThread.start();
- fireLoginStarted(new LoginEvent(this));
- }
- }
- /**
- * Get the synchronous property
- * @return the synchronous property
- */
- public boolean getSynchronous() {
- return synchronous;
- }
- /**
- * Sets the synchronous property
- *
- * @param synchronous synchronous property
- */
- public void setSynchronous(boolean synchronous) {
- this.synchronous = synchronous;
- }
- /**
- * Adds a <strong>LoginListener</strong> to the list of listeners
- *
- * @param listener listener
- */
- public void addLoginListener(LoginListener listener) {
- listenerList.add(listener);
- }
- /**
- * Removes a <strong>LoginListener</strong> from the list of listeners
- *
- * @param listener listener
- */
- public void removeLoginListener(LoginListener listener) {
- listenerList.remove(listener);
- }
- void fireLoginStarted(final LoginEvent source) {
- Iterator iter = listenerList.iterator();
- while (iter.hasNext()) {
- LoginListener listener = (LoginListener) iter.next();
- listener.loginStarted(source);
- }
- }
- void fireLoginSucceeded(final LoginEvent source) {
- Iterator iter = listenerList.iterator();
- while (iter.hasNext()) {
- LoginListener listener = (LoginListener) iter.next();
- listener.loginSucceeded(source);
- }
- }
- void fireLoginFailed(final LoginEvent source) {
- Iterator iter = listenerList.iterator();
- while (iter.hasNext()) {
- LoginListener listener = (LoginListener) iter.next();
- listener.loginFailed(source);
- }
- }
- void fireLoginCanceled(final LoginEvent source) {
- Iterator iter = listenerList.iterator();
- while (iter.hasNext()) {
- LoginListener listener = (LoginListener) iter.next();
- listener.loginCanceled(source);
- }
- }
- /**
- * @return Returns the server.
- */
- public String getServer() {
- return server;
- }
- /**
- * @param server The server to set.
- */
- public void setServer(String server) {
- this.server = server;
- }
- }