1/*
2 *  Licensed to the Apache Software Foundation (ASF) under one or more
3 *  contributor license agreements.  See the NOTICE file distributed with
4 *  this work for additional information regarding copyright ownership.
5 *  The ASF licenses this file to You under the Apache License, Version 2.0
6 *  (the "License"); you may not use this file except in compliance with
7 *  the License.  You may obtain a copy of the License at
8 *
9 *     http://www.apache.org/licenses/LICENSE-2.0
10 *
11 *  Unless required by applicable law or agreed to in writing, software
12 *  distributed under the License is distributed on an "AS IS" BASIS,
13 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 *  See the License for the specific language governing permissions and
15 *  limitations under the License.
16 */
17
18package java.net;
19
20/**
21 * This immutable class is a data structure that encapsulates username and
22 * password which is used by the {@code Authenticator} class.
23 *
24 * @see Authenticator
25 */
26public final class PasswordAuthentication {
27
28    private String userName;
29
30    private char[] password;
31
32    /**
33     * Creates an instance of a password authentication with a specified
34     * username and password.
35     *
36     * @param userName
37     *            the username to store.
38     * @param password
39     *            the associated password to store.
40     */
41    public PasswordAuthentication(String userName, char[] password) {
42        this.userName = userName;
43        this.password = password.clone();
44    }
45
46    /**
47     * Gets a clone of the password stored by this instance. The user is
48     * responsible to finalize the returned array if the password clone is no
49     * longer needed.
50     *
51     * @return the copied password.
52     */
53    public char[] getPassword() {
54        return password.clone();
55    }
56
57    /**
58     * Gets the username stored by this instance.
59     *
60     * @return the stored username.
61     */
62    public String getUserName() {
63        return userName;
64    }
65}
66