IPasswordsRepository.java

// BlogBridge -- RSS feed reader, manager, and web based service
// Copyright (C) 2002-2006 by R. Pito Salas
//
// This program 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 of the License, or (at your option) any later version.
//
// This program 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 this program;
// if not, write to the Free Software Foundation, Inc., 59 Temple Place,
// Suite 330, Boston, MA 02111-1307 USA
//
// Contact: R. Pito Salas
// mailto:pitosalas@users.sourceforge.net
// More information: about BlogBridge
// http://www.blogbridge.com
// http://sourceforge.net/projects/blogbridge
//
// $Id: IPasswordsRepository.java,v 1.2 2006/01/08 05:00:09 kyank Exp $
//

package com.salas.bb.utils.net.auth;

import java.net.PasswordAuthentication;

/**
 * Passwords storage interface.
 */
public interface IPasswordsRepository
{
    /**
     * Returns password entered by user for given context key.
     *
     * @param contextKey    context key.
     *
     * @return authentication info or <code>NULL</code> if there's no match for the context.
     */
    PasswordAuthentication getAuthInformation(String contextKey);

    /**
     * Forgets anything about this key.
     *
     * @param contextKey    context key.
     */
    void forget(String contextKey);

    /**
     * Forgets everything about stored passwords.
     */
    void forgetAll();

    /**
     * Records new password for given context key. If key isn't present,
     * the record will be added, if it is -- updated.
     *
     * @param contextKey        context key.
     * @param authentication    authentication info.
     */
    void record(String contextKey, PasswordAuthentication authentication);
}