javax.security.enterprise.credential.Password Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javaee-web-api Show documentation
Java(TM) EE 8 Web Profile Specification APIs
There is a newer version: 8.0.1
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2015-2017 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
 * or LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package javax.security.enterprise.credential;

import static java.util.Arrays.copyOf;
import java.util.Objects;

import java.util.Arrays;

/**
 * Represents a text-based password, and includes a built-in mechanism for securely
 * clearing the value.
 */
public class Password {

    private static final char[] EMPTY_VALUE = new char[0];
    private volatile char[] value;

    /**
     * Constructor
     *
     * @param value The password value
     * @throws java.lang.NullPointerException Value is null
     */
    public Password(char[] value) {
        Objects.requireNonNull(value, "Password value may not be null");

        this.value = copyOf(value, value.length);
    }

    /**
     * Constructor
     *
     * @param value The password value
     * @throws java.lang.NullPointerException Value is null
     */
    public Password(String value) {
        this(null == value ? null : value.toCharArray());
    }

    /**
     * Determines the password value.
     *
     * @return The password value, empty array if cleared.
     */
    public char[] getValue() {
        return value;
    }

    /**
     * Securely clears the password value.
     */
    public void clear() {
        if (EMPTY_VALUE == value)
            return;

        char[] tempValue = value;
        value = EMPTY_VALUE;

        for (int i = 0; i < tempValue.length; i++) {
            tempValue[i] = 0x00;
        }
    }
    
    public boolean compareTo(String password) {
    	if (password == null) {
    		return false;
    	}
    	
    	return Arrays.equals(password.toCharArray(), value);
    }
}