com.globalmentor.swing.SwingAuthenticator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of globalmentor-swing Show documentation
GlobalMentor Java Swing library.
The newest version!
/*
 * Copyright © 1996-2009 GlobalMentor, Inc. 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.globalmentor.swing;

import java.net.*;

import static com.globalmentor.swing.BasicOptionPane.*;

import com.globalmentor.net.AbstractAuthenticable;

/**
 * Authenticator class which uses Swing to authenticate users.
 * @author Garret Wilson
 */
public class SwingAuthenticator extends AbstractAuthenticable {

	/**
	 * Determines user and password information.
	 * @return The password authentication collected from the user, or null if none is provided.
	 */
	/*TODO fix
		public PasswordAuthentication getPasswordAuthentication()
		{
			return getPasswordAuthentication(null);	//get password authentication, allowing any user to be specified
		}
	*/

	/**
	 * Determines password information for a given user. The user must not be allowed to change the username.
	 * @param username The user for which password information should be gathered, or null if the username is not restricted.
	 * @return The password authentication collected from the user, or null if none is provided.
	 */
	/*TODO fix
		public PasswordAuthentication getPasswordAuthentication(final String username)
		{
			final URI uri=new URI(getRquestingScheme(), getRequestingHost(), )
	    private String requestingHost;
	    private InetAddress requestingSite;
	    private int requestingPort;
	    private String requestingProtocol;
	    private String requestingPrompt;
	    private String requestingScheme;
	    private URL requestingURL;
	    private RequestorType requestingAuthType;
		}
	*/

	/**
	 * Determines password information for a given user in relation to a given URI and description. The user must not be allowed to change the username, if one is
	 * provided.
	 * @param uri The URI for which authentication is requested, or null if there is no relevant URI.
	 * @param prompt A description of the authentication.
	 * @param username The user for which password information should be gathered, or null if the username is not restricted.
	 * @return The password authentication collected from the user, or null if none is provided.
	 */
	public PasswordAuthentication getPasswordAuthentication(final URI uri, final String prompt, final String username) {
		return askPasswordAuthentication(uri != null ? uri.toString() : prompt, prompt, username);
	}

	/**
	 * Asks password authentication.
	 * @param title The dialog title.
	 * @param prompt A prompt string to present the user.
	 * @param username The user for which password information should be gathered, or null if the username is not restricted.
	 * @return The password authentication collected from the user, or null if none is provided.
	 */
	protected PasswordAuthentication askPasswordAuthentication(final String title, final String prompt, final String username) {
		final UserPasswordPanel userPasswordPanel = new UserPasswordPanel(); //create a password panel with verification
		if(username != null) { //if a username was given
			userPasswordPanel.setUsername(username); //set the username in the panel
			userPasswordPanel.setUsernameEditable(false); //don't allow the username to be edited
		}
		//TODO set prompt
		//ask the user for a new password; if the user accepts the change
		if(showConfirmDialog(null, userPasswordPanel, title, OK_CANCEL_OPTION) == OK_OPTION) {
			return new PasswordAuthentication(userPasswordPanel.getUsername(), userPasswordPanel.getPassword()); //return the password authentication from the panel
		} else { //if the user cancels
			return null; //show that the user canceled
		}

	}

}