| J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 1997-2001 Sun Microsystems, Inc. All Rights Reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun in the LICENSE file that accompanied this code. |
| 10 | * |
| 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | * accompanied this code). |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License version |
| 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | * |
| 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | |
| 26 | package java.net; |
| 27 | |
| 28 | |
| 29 | /** |
| 30 | * The class PasswordAuthentication is a data holder that is used by |
| 31 | * Authenticator. It is simply a repository for a user name and a password. |
| 32 | * |
| 33 | * @see java.net.Authenticator |
| 34 | * @see java.net.Authenticator#getPasswordAuthentication() |
| 35 | * |
| 36 | * @author Bill Foote |
| 37 | * @since 1.2 |
| 38 | */ |
| 39 | |
| 40 | public final class PasswordAuthentication { |
| 41 | |
| 42 | private String userName; |
| 43 | private char[] password; |
| 44 | |
| 45 | /** |
| 46 | * Creates a new <code>PasswordAuthentication</code> object from the given |
| 47 | * user name and password. |
| 48 | * |
| 49 | * <p> Note that the given user password is cloned before it is stored in |
| 50 | * the new <code>PasswordAuthentication</code> object. |
| 51 | * |
| 52 | * @param userName the user name |
| 53 | * @param password the user's password |
| 54 | */ |
| 55 | public PasswordAuthentication(String userName, char[] password) { |
| 56 | this.userName = userName; |
| 57 | this.password = password.clone(); |
| 58 | } |
| 59 | |
| 60 | /** |
| 61 | * Returns the user name. |
| 62 | * |
| 63 | * @return the user name |
| 64 | */ |
| 65 | public String getUserName() { |
| 66 | return userName; |
| 67 | } |
| 68 | |
| 69 | /** |
| 70 | * Returns the user password. |
| 71 | * |
| 72 | * <p> Note that this method returns a reference to the password. It is |
| 73 | * the caller's responsibility to zero out the password information after |
| 74 | * it is no longer needed. |
| 75 | * |
| 76 | * @return the password |
| 77 | */ |
| 78 | public char[] getPassword() { |
| 79 | return password; |
| 80 | } |
| 81 | } |