/*
 * FindBugs - Find Bugs in Java programs
 * Copyright (C) 2003-2008 University of Maryland
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package edu.umd.cs.findbugs.cloud.username;

import edu.umd.cs.findbugs.BugCollection;
import edu.umd.cs.findbugs.cloud.CloudPlugin;

import java.io.IOException;

/**
 * @author pugh
 */
public interface NameLookup {
	
	static final String USER_NAME = "user.name";
	
	/** Return name that should be used as the user identity */
	String getUsername();

	/** tries to obtain a user name.
	 * May prompt the user and/or perform network activity.
	 * @param plugin TODO
	 * @param bugCollection
	 * 
	 * @return true if successful
	 */
	boolean signIn(CloudPlugin plugin, BugCollection bugCollection) throws IOException;
}