/*
 * Copyright 2012-2014 Red Hat, Inc.
 *
 * This file is part of Thermostat.
 *
 * Thermostat is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2, or (at your
 * option) any later version.
 *
 * Thermostat 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Thermostat; see the file COPYING.  If not see
 * <http://www.gnu.org/licenses/>.
 *
 * Linking this code with other modules is making a combined work
 * based on this code.  Thus, the terms and conditions of the GNU
 * General Public License cover the whole combination.
 *
 * As a special exception, the copyright holders of this code give
 * you permission to link this code with independent modules to
 * produce an executable, regardless of the license terms of these
 * independent modules, and to copy and distribute the resulting
 * executable under terms of your choice, provided that you also
 * meet, for each linked independent module, the terms and conditions
 * of the license of that module.  An independent module is a module
 * which is not derived from or based on this code.  If you modify
 * this code, you may extend this exception to your version of the
 * library, but you are not obligated to do so.  If you do not wish
 * to do so, delete this exception statement from your version.
 */

package com.redhat.thermostat.utils.keyring;

import com.redhat.thermostat.annotations.Service;

/**
 * Maps url/username to passwords, securely.  Implementations may support persisting
 * this mapping across sessions.
 */
@Service
public interface Keyring {

    /**
     * Map the given password to the given url and username.
     * @param url The url for this saved password
     * @param username The username for this saved password
     * @param password The password to be saved
     * @throws KeyringException to indicate password could not be saved due to an error
     */
    public void savePassword(String url, String username, char[] password);

    /**
     * Retrieve the password associated with the given url and username.
     * @param url The url for the desired password
     * @param username The username for the desired password
     * @return The password mapped to the given url and username, if any.  Null otherwise
     * @throws KeyringException if error is encountered when attempting to retrieve password
     */
    public char[] getPassword(String url, String username);

    /**
     * Clear the password associated with the given url and username, if any.
     * @param url The url for the password to be cleared
     * @param username The username for the password to be cleared
     * @throws KeyringException if error is encountered when attempting to retrieve password
     */
    public void clearPassword(String url, String username);

}