bundles/org.eclipse.team.cvs.core/src/org/eclipse/team/internal/ccvs/core/connection/CVSRepositoryLocation.java - gerrit/platform/eclipse.platform.team - Git at Google

 package org.eclipse.team.internal.ccvs.core.connection;

 /*
  * (c) Copyright IBM Corp. 2000, 2001.
  * All Rights Reserved.
  */

 import java.util.ArrayList;
 import java.util.List;

 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.IConfigurationElement;
 import org.eclipse.core.runtime.IExtension;
 import org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.MultiStatus;
 import org.eclipse.core.runtime.Platform;
 import org.eclipse.core.runtime.Status;
 import org.eclipse.team.internal.ccvs.core.CVSException;
 import org.eclipse.team.internal.ccvs.core.CVSStatus;
 import org.eclipse.team.internal.ccvs.core.Policy;
 import org.eclipse.team.ccvs.core.CVSProviderPlugin;
 import org.eclipse.team.ccvs.core.CVSTeamProvider;
 import org.eclipse.team.ccvs.core.ICVSRepositoryLocation;
 import org.eclipse.team.ccvs.core.IConnectionMethod;
 import org.eclipse.team.ccvs.core.IUserAuthenticator;
 import org.eclipse.team.ccvs.core.IUserInfo;

 /**
  * This class manages a CVS repository location.
  *
  * It provides the mapping between connection method name and the
  * plugged in ICunnectionMethod.
  *
  * It parses location strings into instances.
  *
  * It provides a method to open a connection to the server along
  * with a method to validate that connections can be made.
  *
  * It manages its user info using the plugged in IUserAuthenticator
  * (unless a username and password are provided as part of the creation
  * string, in which case, no authenticator is used).
  *
  * Instances must be disposed of when no longer needed in order to
  * notify the authenticator so cached properties can be cleared
  *
  */
 public class CVSRepositoryLocation implements ICVSRepositoryLocation, IUserInfo {

 	// static variables for extension points
 	private static IUserAuthenticator authenticator;
 	private static IConnectionMethod[] pluggedInConnectionMethods = null;

 	private IConnectionMethod method;
 	private String user;
 	private String password;
 	private String host;
 	private int port;
 	private String root;
 	private boolean userFixed;
 	private boolean passwordFixed;

 	public static final char COLON = ':';
 	public static final char HOST_SEPARATOR = '@';
 	public static final char PORT_SEPARATOR = '#';
 	public static final boolean STANDALONE_MODE = (System.getProperty("cvs.standalone")==null)?false:(new Boolean(System.getProperty("cvs.standalone")).booleanValue());

 	/**
 	 * Create a CVSRepositoryLocation from its composite parts.
 	 */
 	private CVSRepositoryLocation(IConnectionMethod method, String user, String password, String host, int port, String root, boolean userFixed, boolean passwordFixed) {
 		this.method = method;
 		this.user = user;
 		this.password = password;
 		this.host = host;
 		this.port = port;
 		this.root = root;
 		// The username can be fixed only if one is provided
 		if (userFixed && (user != null))
 			this.userFixed = true;
 		// The password can only be fixed if the username is and a password is provided
 		if (userFixed && passwordFixed && (password != null))
 			this.passwordFixed = true;
 //		else {
 //			// If the password is not fixed, there's no need to fix the username
 //			this.userFixed = false;
 //			this.passwordFixed = false;
 //		}
 		// Retrieve a password if one was previosuly cached or set it to blank
 		if (!passwordFixed) {
 			IUserAuthenticator authenticator = getAuthenticator();
 			if (authenticator != null) {
 				try {
 					if (!authenticator.retrievePassword(this, this))
 						password = "";
 				} catch (CVSException e) {
 					password = "";
 				}
 			}
 		}
 	}

 	/**
 	 * Create the connection to the remote server.
 	 * If anything fails, an exception will be thrown and must
 	 * be handled by the caller.
 	 */
 	private Connection createConnection() throws CVSException {
 		// Should the open() of Connection be done in the constructor?
 		// The only reason it should is if connections can be reused (they aren't reused now).
 		Connection connection = new Connection(this, method.createConnection(this, password));
 		connection.open();
 		return connection;
 	}

 	/**
 	 * Dispose of the receiver by clearing any cached authorization information.
 	 * This method shold only be invoked when the corresponding adapter is shut
 	 * down or a connection is being validated.
 	 */
 	protected void dispose() throws CVSException {
 		IUserAuthenticator authenticator = getAuthenticator();
 		if (authenticator != null) {
 			authenticator.dispose(this);
 		}
 	}

 	/**
 	 * @see ICVSRepositoryLocation#getHost()
 	 */
 	public String getHost() {
 		return host;
 	}

 	/**
 	 * @see IRepositoryLocation#getLocation()
 	 *
 	 * The username is inlcuded if it is fixed.
 	 * The password is never included even if it is fixed.
 	 * The port is included if it is not the default port.
 	 */
 	public String getLocation() {
 		return COLON + method.getName() + COLON +
 			(userFixed?(user +
 				(passwordFixed?(COLON + password):"")
 					+ HOST_SEPARATOR):"") +
 			host +
 			((port == USE_DEFAULT_PORT)?"":(PORT_SEPARATOR + new Integer(port).toString())) +
 			COLON + root;
 	}

 	/**
 	 * @see ICVSRepositoryLocation#getMethod()
 	 */
 	public IConnectionMethod getMethod() {
 		return method;
 	}

 	public boolean setMethod(String methodName) {
 		IConnectionMethod newMethod = getPluggedInConnectionMethod(methodName);
 		if (newMethod == null)
 			return false;
 		method = newMethod;
 		return true;
 	}

 	/**
 	 * @see ICVSRepositoryLocation#getPort()
 	 */
 	public int getPort() {
 		return port;
 	}

 	/**
 	 * @see ICVSRepositoryLocation#getRootDirectory()
 	 */
 	public String getRootDirectory() {
 		return root;
 	}

 	/**
 	 * @see ICVSRepositoryLocation#getTimeout()
 	 *
 	 * For the time being, the timeout value is a system wide value
 	 * associated with the CVSPlugin singleton.
 	 */
 	public int getTimeout() {
 		return 60;
 	}

 	/**
 	 * @see ICVSRepositoryLocation#getUserInfo()
 	 */
 	public IUserInfo getUserInfo() {
 		return this;
 	}

 	/**
 	 * @see ICVSRepositoryLocation#getUsername()
 	 * @see IUserInfo#getUsername()
 	 */
 	public String getUsername() {
 		return user;
 	}

 	/**
 	 * @see IUserInfo#isUsernameMutable()
 	 */
 	public boolean isUsernameMutable() {
 		return !userFixed;
 	}

 	/**
 	 * Open a connection to the repository represented by the receiver.
 	 * If the username or password are not fixed, openConnection will
 	 * use the plugged-in authenticator to prompt for the username and/or
 	 * password if one has not previously been provided or if the previously
 	 * supplied username and password are invalid.
 	 */
 	public Connection openConnection() throws CVSException {
 		String message = null;

 		// If we have a username and password, don't authenticate unless we fail.
 		// We would have a username and password if we previously authenticated
 		// or one was stored using storePassword()
 		if ((user != null) && (password != null))
 			try {
 				return createConnection();
 			} catch (CVSAuthenticationException ex) {
 				if (userFixed && passwordFixed)
 					throw ex;
 				message = ex.getMessage();
 			}

 		// If we failed above or we didn't have a username or password, authenticate
 		IUserAuthenticator authenticator = getAuthenticator();
 		if (authenticator == null) {
 			throw new CVSAuthenticationException(this.getLocation(), Policy.bind("Client.noAuthenticator"));
 		}

 		// If we tried above and failed, this is a retry.
 		boolean retry = (message != null);
 		while (true) {
 			try {
 				if (!authenticator.authenticateUser(this, this, retry, message))
 					throw new CVSAuthenticationException(new CVSStatus(CVSStatus.ERROR, Policy.bind("error")));
 			} catch (CVSException e) {
 				throw e;
 			}
 			try {
 				// The following will throw an exception if authentication fails
 				return createConnection();
 			} catch (CVSAuthenticationException ex) {
 				retry = true;
 				message = ex.getMessage();
 			}
 		}
 	}

 	/**
 	 * Implementation of inherited toString()
 	 */
 	public String toString() {
 		return getLocation();
 	}

 	/**
 	 * @see IUserInfo#setPassword(String)
 	 */
 	public void setPassword(String password) {
 		if (passwordFixed)
 			throw new UnsupportedOperationException();
 		this.password = password;
 	}

 	/**
 	 * @see IUserInfo#setUsername(String)
 	 */
 	public void setUsername(String user) {
 		if (userFixed)
 			throw new UnsupportedOperationException();
 		this.user = user;
 	}

 	public void setUserMuteable(boolean muteable) {
 		userFixed = !muteable;
 	}

 	public void storePassword(String password) throws CVSException {
 		IUserAuthenticator authenticator = getAuthenticator();
 		if (authenticator != null) {
 			authenticator.cachePassword(this, this, password);
 		}
 	}

 	public void updateCache() throws CVSException {
 		IUserAuthenticator authenticator = getAuthenticator();
 		if (authenticator != null) {
 			authenticator.cachePassword(this, this, password);
 		}
 	}
 	/**
 	 * Validate that the receiver contains valid information for
 	 * making a connection. If the receiver contains valid
 	 * information, the method returns. Otherwise, an exception
 	 * indicating the problem is throw.
 	 */
 	public boolean validateConnection() throws CVSException {
 		try {
 			openConnection().close();
 			return true;
 		} catch (CVSException e) {
 			// If the validation failed, dispose of any cached info
 			dispose();
 			throw e;
 		}
 	}

 	public static boolean validateConnectionMethod(String methodName) {
 		String[] methods = CVSTeamProvider.getConnectionMethods();
 		for (int i=0;i<methods.length;i++) {
 			if (methodName.equals(methods[i]))
 				return true;
 		}
 		return false;
 	}

 	/**
 	 * Parse a location string and return a CVSRepositoryLocation.
 	 *
 	 * On failure, the status of the exception will be a MultiStatus
 	 * that includes the original parsing error and a general status
 	 * displaying the passed location and proper form. This form is
 	 * better for logging, etc.
 	 */
 	public static CVSRepositoryLocation fromString(String location) throws CVSException {
 		try {
 			return fromString(location, false);
 		} catch (CVSException e) {
 			// Parsing failed. Include a status that
 			// shows the passed location and the proper form
 			MultiStatus error = new MultiStatus(CVSProviderPlugin.ID, CVSStatus.ERROR, Policy.bind("CVSRepositoryLocation.invalidFormat", new Object[] {location}), null);
 			error.merge(new CVSStatus(IStatus.ERROR, null, Policy.bind("CVSRepositoryLocation.locationForm")));
 			error.merge(e.getStatus());
 			throw new CVSException(error);
 		}
 	}

 	/**
 	 * Parse a location string and return a CVSRepositoryLocation.
 	 *
 	 * The valid format (from the cederqvist) is:
 	 *
 	 * :method:[[user][:password]@]hostname[:[port]]/path/to/repository
 	 *
 	 * However, this does not work with CVS on NT so we use the format
 	 *
 	 * :method:[user[:password]@]hostname[#port]:/path/to/repository
 	 *
 	 * Some differences to note:
 	 *    The : after the host/port is not optional because of NT naming including device
 	 *    e.g. :pserver:username:password@hostname#port:D:\cvsroot
 	 *
 	 * If validateOnly is true, this method will always throw an exception.
 	 * The status of the exception indicates success or failure. The status
 	 * of the exception contains a specific message suitable for displaying
 	 * to a user who has knowledge of the provided location string.
 	 * @see CVSRepositoryLocation.fromString(String)
 	 */
 	public static CVSRepositoryLocation fromString(String location, boolean validateOnly) throws CVSException {
 		String partId = null;
 		try {
 			// Get the connection method
 			partId = "CVSRepositoryLocation.parsingMethod";
 			int start = location.indexOf(COLON);
 			if (start != 0)
 				throw new CVSException(Policy.bind("CVSRepositoryLocation.startOfLocation"));
 			int end = location.indexOf(COLON, start + 1);
 			String methodName = location.substring(start + 1, end);
 			IConnectionMethod method = getPluggedInConnectionMethod(methodName);
 			if (method == null)
 				throw new CVSException(new CVSStatus(CVSStatus.ERROR, null, Policy.bind("CVSRepositoryLocation.methods", new Object[] {getPluggedInConnectionMethodNames()})));

 			// Get the user name and password (if provided)
 			partId = "CVSRepositoryLocation.parsingUser";
 			start = end + 1;
 			end = location.indexOf(HOST_SEPARATOR, start);
 			String user = null;;
 			String password = null;
 			// if end is -1 then there is no host separator meaning that the username is not present
 			if (end != -1) {
 				// Get the optional user and password
 				user = location.substring(start, end);
 				// Separate the user and password (if there is a password)
 				start = user.indexOf(COLON);
 				if (start != -1) {
 					partId = "CVSRepositoryLocation.parsingPassword";
 					password = user.substring(start+1);
 					user = user.substring(0, start);
 				}
 				// Set start to point after the host separator
 				start = end + 1;
 			}

 			// Get the host (and port)
 			partId = "CVSRepositoryLocation.parsingHost";
 			end= location.indexOf(COLON, start);
 			String host = location.substring(start, end);
 			int port = USE_DEFAULT_PORT;
 			// Separate the port and host if there is a port
 			start = host.indexOf(PORT_SEPARATOR);
 			if (start != -1) {
 				partId = "CVSRepositoryLocation.parsingPort";
 				port = Integer.parseInt(host.substring(start+1));
 				host = host.substring(0, start);
 			}

 			// Get the repository path (translating backslashes to slashes)
 			partId = "CVSRepositoryLocation.parsingRoot";
 			start = end + 1;
 			String root = location.substring(start).replace('\\', '/');

 			if (validateOnly)
 				throw new CVSException(new CVSStatus(CVSStatus.OK, Policy.bind("ok")));

 			return new CVSRepositoryLocation(method, user, password, host, port, root, (user != null), (password != null));
 		}
 		catch (IndexOutOfBoundsException e) {
 			// We'll get here if anything funny happened while extracting substrings
 			throw new CVSException(Policy.bind(partId));
 		}
 		catch (NumberFormatException e) {
 			// We'll get here if we couldn't parse a number
 			throw new CVSException(Policy.bind(partId));
 		}
 	}

 	public static IUserAuthenticator getAuthenticator() {
 		if (authenticator == null) {
 			authenticator = getPluggedInAuthenticator();
 		}
 		return authenticator;
 	}

 	/**
 	 * Return the connection method registered for the given name or null if none
 	 * are registered
 	 */
 	private static IConnectionMethod getPluggedInConnectionMethod(String methodName) {
 		IConnectionMethod[] methods = getPluggedInConnectionMethods();
 		for(int i=0; i<methods.length; i++) {
 			if(methodName.equals(methods[i].getName()))
 				return methods[i];
 		}
 		return null;
 	}

 	/**
 	 * Return a string containing a list of all connection methods
 	 */
 	private static String getPluggedInConnectionMethodNames() {
 		IConnectionMethod[] methods = getPluggedInConnectionMethods();
 		StringBuffer methodNames = new StringBuffer();
 		for(int i=0; i<methods.length; i++) {
 			String name = methods[i].getName();
 			if (i>0)
 				methodNames.append(", ");
 			methodNames.append(name);
 		}
 		return methodNames.toString();
 	}

 	public static IConnectionMethod[] getPluggedInConnectionMethods() {
 		if(pluggedInConnectionMethods==null) {
 			List connectionMethods = new ArrayList();

 			if (STANDALONE_MODE) {
 				connectionMethods.add(new PServerConnectionMethod());
 			} else {
 				IExtension[] extensions = Platform.getPluginRegistry().getExtensionPoint(CVSProviderPlugin.ID, CVSProviderPlugin.PT_CONNECTIONMETHODS).getExtensions();
 				for(int i=0; i<extensions.length; i++) {
 					IExtension extension = extensions[i];
 					IConfigurationElement[] configs = extension.getConfigurationElements();
 					if (configs.length == 0) {
 						CVSProviderPlugin.log(new Status(IStatus.ERROR, CVSProviderPlugin.ID, 0, Policy.bind("CVSProviderPlugin.execProblem"), null));
 						continue;
 					}
 					try {
 						IConfigurationElement config = configs[0];
 						connectionMethods.add(config.createExecutableExtension("run"));
 					} catch (CoreException ex) {
 						CVSProviderPlugin.log(new Status(IStatus.ERROR, CVSProviderPlugin.ID, 0, Policy.bind("CVSProviderPlugin.execProblem"), ex));
 					}
 				}
 			}
 			pluggedInConnectionMethods = (IConnectionMethod[])connectionMethods.toArray(new IConnectionMethod[0]);
 		}
 		return pluggedInConnectionMethods;
 	}

 	private static IUserAuthenticator getPluggedInAuthenticator() {
 		IExtension[] extensions = Platform.getPluginRegistry().getExtensionPoint(CVSProviderPlugin.ID, CVSProviderPlugin.PT_AUTHENTICATOR).getExtensions();
 		if (extensions.length == 0)
 			return null;
 		IExtension extension = extensions[0];
 		IConfigurationElement[] configs = extension.getConfigurationElements();
 		if (configs.length == 0) {
 			CVSProviderPlugin.log(new Status(IStatus.ERROR, CVSProviderPlugin.ID, 0, Policy.bind("CVSAdapter.noConfigurationElement", new Object[] {extension.getUniqueIdentifier()}), null));
 			return null;
 		}
 		try {
 			IConfigurationElement config = configs[0];
 			return (IUserAuthenticator) config.createExecutableExtension("run");
 		} catch (CoreException ex) {
 			CVSProviderPlugin.log(new Status(IStatus.ERROR, CVSProviderPlugin.ID, 0, Policy.bind("CVSAdapter.unableToInstantiate", new Object[] {extension.getUniqueIdentifier()}), ex));
 			return null;
 		}
 	}
 	/**
 	 * Validate that the given string could ne used to succesfully create
 	 * an instance of the receiver.
 	 *
 	 * This method performs some initial checks to provide displayable
 	 * feedback and also tries a more in-depth parse using fromString(String, boolean).
 	 */
 	public static IStatus validate(String location) {

 		// Check some simple things that are not checked in creation
 		if (location == null)
 			return new CVSStatus(CVSStatus.ERROR, null, Policy.bind("CVSRepositoryLocation.nullLocation"));
 		if (location.equals(""))
 			return new CVSStatus(CVSStatus.ERROR, null, Policy.bind("CVSRepositoryLocation.emptyLocation"));
 		if (location.endsWith(" ") || location.endsWith("\t"))
 			return new CVSStatus(CVSStatus.ERROR, null, Policy.bind("CVSRepositoryLocation.endWhitespace"));
 		if (!location.startsWith(":") || location.indexOf(COLON, 1) == -1)
 			return new CVSStatus(CVSStatus.ERROR, null, Policy.bind("CVSRepositoryLocation.startOfLocation"));

 		// Do some quick checks to provide geberal feedback
 		String formatError = Policy.bind("CVSRepositoryLocation.locationForm");
 		int secondColon = location.indexOf(COLON, 1);
 		int at = location.indexOf(HOST_SEPARATOR);
 		if (at != -1) {
 			String user = location.substring(secondColon + 1, at);
 			if (user.equals(""))
 				return new CVSStatus(CVSStatus.ERROR, null, formatError);
 		} else
 			at = secondColon;
 		int colon = location.indexOf(COLON, at + 1);
 		if (colon == -1)
 			return new CVSStatus(CVSStatus.ERROR, null, formatError);
 		String host = location.substring(at + 1, colon);
 		if (host.equals(""))
 				return new CVSStatus(CVSStatus.ERROR, null, formatError);
 		String path = location.substring(colon + 1, location.length());
 		if (path.equals(""))
 				return new CVSStatus(CVSStatus.ERROR, null, formatError);

 		// Do a full parse and see if it passes
 		try {
 			fromString(location, true);
 		} catch (CVSException e) {
 			// An exception is always throw. Return the status
 			return e.getStatus();
 		}

 		// Looks ok (we'll actually never get here because above
 		// fromString(String, boolean) will always throw an exception).
 		return new CVSStatus(IStatus.OK, Policy.bind("ok"));
 	}
 }
	package org.eclipse.team.internal.ccvs.core.connection;

	/*
	* (c) Copyright IBM Corp. 2000, 2001.
	* All Rights Reserved.
	*/

	import java.util.ArrayList;
	import java.util.List;

	import org.eclipse.core.runtime.CoreException;
	import org.eclipse.core.runtime.IConfigurationElement;
	import org.eclipse.core.runtime.IExtension;
	import org.eclipse.core.runtime.IStatus;
	import org.eclipse.core.runtime.MultiStatus;
	import org.eclipse.core.runtime.Platform;
	import org.eclipse.core.runtime.Status;
	import org.eclipse.team.internal.ccvs.core.CVSException;
	import org.eclipse.team.internal.ccvs.core.CVSStatus;
	import org.eclipse.team.internal.ccvs.core.Policy;
	import org.eclipse.team.ccvs.core.CVSProviderPlugin;
	import org.eclipse.team.ccvs.core.CVSTeamProvider;
	import org.eclipse.team.ccvs.core.ICVSRepositoryLocation;
	import org.eclipse.team.ccvs.core.IConnectionMethod;
	import org.eclipse.team.ccvs.core.IUserAuthenticator;
	import org.eclipse.team.ccvs.core.IUserInfo;

	/**
	* This class manages a CVS repository location.
	*
	* It provides the mapping between connection method name and the
	* plugged in ICunnectionMethod.
	*
	* It parses location strings into instances.
	*
	* It provides a method to open a connection to the server along
	* with a method to validate that connections can be made.
	*
	* It manages its user info using the plugged in IUserAuthenticator
	* (unless a username and password are provided as part of the creation
	* string, in which case, no authenticator is used).
	*
	* Instances must be disposed of when no longer needed in order to
	* notify the authenticator so cached properties can be cleared
	*
	*/
	public class CVSRepositoryLocation implements ICVSRepositoryLocation, IUserInfo {

	// static variables for extension points
	private static IUserAuthenticator authenticator;
	private static IConnectionMethod[] pluggedInConnectionMethods = null;

	private IConnectionMethod method;
	private String user;
	private String password;
	private String host;
	private int port;
	private String root;
	private boolean userFixed;
	private boolean passwordFixed;

	public static final char COLON = ':';
	public static final char HOST_SEPARATOR = '@';
	public static final char PORT_SEPARATOR = '#';
	public static final boolean STANDALONE_MODE = (System.getProperty("cvs.standalone")==null)?false:(new Boolean(System.getProperty("cvs.standalone")).booleanValue());

	/**
	* Create a CVSRepositoryLocation from its composite parts.
	*/
	private CVSRepositoryLocation(IConnectionMethod method, String user, String password, String host, int port, String root, boolean userFixed, boolean passwordFixed) {
	this.method = method;
	this.user = user;
	this.password = password;
	this.host = host;
	this.port = port;
	this.root = root;
	// The username can be fixed only if one is provided
	if (userFixed && (user != null))
	this.userFixed = true;
	// The password can only be fixed if the username is and a password is provided
	if (userFixed && passwordFixed && (password != null))
	this.passwordFixed = true;
	// else {
	// // If the password is not fixed, there's no need to fix the username
	// this.userFixed = false;
	// this.passwordFixed = false;
	// }
	// Retrieve a password if one was previosuly cached or set it to blank
	if (!passwordFixed) {
	IUserAuthenticator authenticator = getAuthenticator();
	if (authenticator != null) {
	try {
	if (!authenticator.retrievePassword(this, this))
	password = "";
	} catch (CVSException e) {
	password = "";
	}
	}
	}
	}

	/**
	* Create the connection to the remote server.
	* If anything fails, an exception will be thrown and must
	* be handled by the caller.
	*/
	private Connection createConnection() throws CVSException {
	// Should the open() of Connection be done in the constructor?
	// The only reason it should is if connections can be reused (they aren't reused now).
	Connection connection = new Connection(this, method.createConnection(this, password));
	connection.open();
	return connection;
	}

	/**
	* Dispose of the receiver by clearing any cached authorization information.
	* This method shold only be invoked when the corresponding adapter is shut
	* down or a connection is being validated.
	*/
	protected void dispose() throws CVSException {
	IUserAuthenticator authenticator = getAuthenticator();
	if (authenticator != null) {
	authenticator.dispose(this);
	}
	}

	/**
	* @see ICVSRepositoryLocation#getHost()
	*/
	public String getHost() {
	return host;
	}

	/**
	* @see IRepositoryLocation#getLocation()
	*
	* The username is inlcuded if it is fixed.
	* The password is never included even if it is fixed.
	* The port is included if it is not the default port.
	*/
	public String getLocation() {
	return COLON + method.getName() + COLON +
	(userFixed?(user +
	(passwordFixed?(COLON + password):"")
	+ HOST_SEPARATOR):"") +
	host +
	((port == USE_DEFAULT_PORT)?"":(PORT_SEPARATOR + new Integer(port).toString())) +
	COLON + root;
	}

	/**
	* @see ICVSRepositoryLocation#getMethod()
	*/
	public IConnectionMethod getMethod() {
	return method;
	}

	public boolean setMethod(String methodName) {
	IConnectionMethod newMethod = getPluggedInConnectionMethod(methodName);
	if (newMethod == null)
	return false;
	method = newMethod;
	return true;
	}

	/**
	* @see ICVSRepositoryLocation#getPort()
	*/
	public int getPort() {
	return port;
	}

	/**
	* @see ICVSRepositoryLocation#getRootDirectory()
	*/
	public String getRootDirectory() {
	return root;
	}

	/**
	* @see ICVSRepositoryLocation#getTimeout()
	*
	* For the time being, the timeout value is a system wide value
	* associated with the CVSPlugin singleton.
	*/
	public int getTimeout() {
	return 60;
	}

	/**
	* @see ICVSRepositoryLocation#getUserInfo()
	*/
	public IUserInfo getUserInfo() {
	return this;
	}

	/**
	* @see ICVSRepositoryLocation#getUsername()
	* @see IUserInfo#getUsername()
	*/
	public String getUsername() {
	return user;
	}

	/**
	* @see IUserInfo#isUsernameMutable()
	*/
	public boolean isUsernameMutable() {
	return !userFixed;
	}

	/**
	* Open a connection to the repository represented by the receiver.
	* If the username or password are not fixed, openConnection will
	* use the plugged-in authenticator to prompt for the username and/or
	* password if one has not previously been provided or if the previously
	* supplied username and password are invalid.
	*/
	public Connection openConnection() throws CVSException {
	String message = null;

	// If we have a username and password, don't authenticate unless we fail.
	// We would have a username and password if we previously authenticated
	// or one was stored using storePassword()
	if ((user != null) && (password != null))
	try {
	return createConnection();
	} catch (CVSAuthenticationException ex) {
	if (userFixed && passwordFixed)
	throw ex;
	message = ex.getMessage();
	}

	// If we failed above or we didn't have a username or password, authenticate
	IUserAuthenticator authenticator = getAuthenticator();
	if (authenticator == null) {
	throw new CVSAuthenticationException(this.getLocation(), Policy.bind("Client.noAuthenticator"));
	}

	// If we tried above and failed, this is a retry.
	boolean retry = (message != null);
	while (true) {
	try {
	if (!authenticator.authenticateUser(this, this, retry, message))
	throw new CVSAuthenticationException(new CVSStatus(CVSStatus.ERROR, Policy.bind("error")));
	} catch (CVSException e) {
	throw e;
	}
	try {
	// The following will throw an exception if authentication fails
	return createConnection();
	} catch (CVSAuthenticationException ex) {
	retry = true;
	message = ex.getMessage();
	}
	}
	}

	/**
	* Implementation of inherited toString()
	*/
	public String toString() {
	return getLocation();
	}

	/**
	* @see IUserInfo#setPassword(String)
	*/
	public void setPassword(String password) {
	if (passwordFixed)
	throw new UnsupportedOperationException();
	this.password = password;
	}

	/**
	* @see IUserInfo#setUsername(String)
	*/
	public void setUsername(String user) {
	if (userFixed)
	throw new UnsupportedOperationException();
	this.user = user;
	}

	public void setUserMuteable(boolean muteable) {
	userFixed = !muteable;
	}

	public void storePassword(String password) throws CVSException {
	IUserAuthenticator authenticator = getAuthenticator();
	if (authenticator != null) {
	authenticator.cachePassword(this, this, password);
	}
	}

	public void updateCache() throws CVSException {
	IUserAuthenticator authenticator = getAuthenticator();
	if (authenticator != null) {
	authenticator.cachePassword(this, this, password);
	}
	}
	/**
	* Validate that the receiver contains valid information for
	* making a connection. If the receiver contains valid
	* information, the method returns. Otherwise, an exception
	* indicating the problem is throw.
	*/
	public boolean validateConnection() throws CVSException {
	try {
	openConnection().close();
	return true;
	} catch (CVSException e) {
	// If the validation failed, dispose of any cached info
	dispose();
	throw e;
	}
	}

	public static boolean validateConnectionMethod(String methodName) {
	String[] methods = CVSTeamProvider.getConnectionMethods();
	for (int i=0;i<methods.length;i++) {
	if (methodName.equals(methods[i]))
	return true;
	}
	return false;
	}

	/**
	* Parse a location string and return a CVSRepositoryLocation.
	*
	* On failure, the status of the exception will be a MultiStatus
	* that includes the original parsing error and a general status
	* displaying the passed location and proper form. This form is
	* better for logging, etc.
	*/
	public static CVSRepositoryLocation fromString(String location) throws CVSException {
	try {
	return fromString(location, false);
	} catch (CVSException e) {
	// Parsing failed. Include a status that
	// shows the passed location and the proper form
	MultiStatus error = new MultiStatus(CVSProviderPlugin.ID, CVSStatus.ERROR, Policy.bind("CVSRepositoryLocation.invalidFormat", new Object[] {location}), null);
	error.merge(new CVSStatus(IStatus.ERROR, null, Policy.bind("CVSRepositoryLocation.locationForm")));
	error.merge(e.getStatus());
	throw new CVSException(error);
	}
	}

	/**
	* Parse a location string and return a CVSRepositoryLocation.
	*
	* The valid format (from the cederqvist) is:
	*
	* :method:[[user][:password]@]hostname[:[port]]/path/to/repository
	*
	* However, this does not work with CVS on NT so we use the format
	*
	* :method:[user[:password]@]hostname[#port]:/path/to/repository
	*
	* Some differences to note:
	* The : after the host/port is not optional because of NT naming including device
	* e.g. :pserver:username:password@hostname#port:D:\cvsroot
	*
	* If validateOnly is true, this method will always throw an exception.
	* The status of the exception indicates success or failure. The status
	* of the exception contains a specific message suitable for displaying
	* to a user who has knowledge of the provided location string.
	* @see CVSRepositoryLocation.fromString(String)
	*/
	public static CVSRepositoryLocation fromString(String location, boolean validateOnly) throws CVSException {
	String partId = null;
	try {
	// Get the connection method
	partId = "CVSRepositoryLocation.parsingMethod";
	int start = location.indexOf(COLON);
	if (start != 0)
	throw new CVSException(Policy.bind("CVSRepositoryLocation.startOfLocation"));
	int end = location.indexOf(COLON, start + 1);
	String methodName = location.substring(start + 1, end);
	IConnectionMethod method = getPluggedInConnectionMethod(methodName);
	if (method == null)
	throw new CVSException(new CVSStatus(CVSStatus.ERROR, null, Policy.bind("CVSRepositoryLocation.methods", new Object[] {getPluggedInConnectionMethodNames()})));

	// Get the user name and password (if provided)
	partId = "CVSRepositoryLocation.parsingUser";
	start = end + 1;
	end = location.indexOf(HOST_SEPARATOR, start);
	String user = null;;
	String password = null;
	// if end is -1 then there is no host separator meaning that the username is not present
	if (end != -1) {
	// Get the optional user and password
	user = location.substring(start, end);
	// Separate the user and password (if there is a password)
	start = user.indexOf(COLON);
	if (start != -1) {
	partId = "CVSRepositoryLocation.parsingPassword";
	password = user.substring(start+1);
	user = user.substring(0, start);
	}
	// Set start to point after the host separator
	start = end + 1;
	}

	// Get the host (and port)
	partId = "CVSRepositoryLocation.parsingHost";
	end= location.indexOf(COLON, start);
	String host = location.substring(start, end);
	int port = USE_DEFAULT_PORT;
	// Separate the port and host if there is a port
	start = host.indexOf(PORT_SEPARATOR);
	if (start != -1) {
	partId = "CVSRepositoryLocation.parsingPort";
	port = Integer.parseInt(host.substring(start+1));
	host = host.substring(0, start);
	}

	// Get the repository path (translating backslashes to slashes)
	partId = "CVSRepositoryLocation.parsingRoot";
	start = end + 1;
	String root = location.substring(start).replace('\\', '/');

	if (validateOnly)
	throw new CVSException(new CVSStatus(CVSStatus.OK, Policy.bind("ok")));

	return new CVSRepositoryLocation(method, user, password, host, port, root, (user != null), (password != null));
	}
	catch (IndexOutOfBoundsException e) {
	// We'll get here if anything funny happened while extracting substrings
	throw new CVSException(Policy.bind(partId));
	}
	catch (NumberFormatException e) {
	// We'll get here if we couldn't parse a number
	throw new CVSException(Policy.bind(partId));
	}
	}

	public static IUserAuthenticator getAuthenticator() {
	if (authenticator == null) {
	authenticator = getPluggedInAuthenticator();
	}
	return authenticator;
	}

	/**
	* Return the connection method registered for the given name or null if none
	* are registered
	*/
	private static IConnectionMethod getPluggedInConnectionMethod(String methodName) {
	IConnectionMethod[] methods = getPluggedInConnectionMethods();
	for(int i=0; i<methods.length; i++) {
	if(methodName.equals(methods[i].getName()))
	return methods[i];
	}
	return null;
	}

	/**
	* Return a string containing a list of all connection methods
	*/
	private static String getPluggedInConnectionMethodNames() {
	IConnectionMethod[] methods = getPluggedInConnectionMethods();
	StringBuffer methodNames = new StringBuffer();
	for(int i=0; i<methods.length; i++) {
	String name = methods[i].getName();
	if (i>0)
	methodNames.append(", ");
	methodNames.append(name);
	}
	return methodNames.toString();
	}

	public static IConnectionMethod[] getPluggedInConnectionMethods() {
	if(pluggedInConnectionMethods==null) {
	List connectionMethods = new ArrayList();

	if (STANDALONE_MODE) {
	connectionMethods.add(new PServerConnectionMethod());
	} else {
	IExtension[] extensions = Platform.getPluginRegistry().getExtensionPoint(CVSProviderPlugin.ID, CVSProviderPlugin.PT_CONNECTIONMETHODS).getExtensions();
	for(int i=0; i<extensions.length; i++) {
	IExtension extension = extensions[i];
	IConfigurationElement[] configs = extension.getConfigurationElements();
	if (configs.length == 0) {
	CVSProviderPlugin.log(new Status(IStatus.ERROR, CVSProviderPlugin.ID, 0, Policy.bind("CVSProviderPlugin.execProblem"), null));
	continue;
	}
	try {
	IConfigurationElement config = configs[0];
	connectionMethods.add(config.createExecutableExtension("run"));
	} catch (CoreException ex) {
	CVSProviderPlugin.log(new Status(IStatus.ERROR, CVSProviderPlugin.ID, 0, Policy.bind("CVSProviderPlugin.execProblem"), ex));
	}
	}
	}
	pluggedInConnectionMethods = (IConnectionMethod[])connectionMethods.toArray(new IConnectionMethod[0]);
	}
	return pluggedInConnectionMethods;
	}

	private static IUserAuthenticator getPluggedInAuthenticator() {
	IExtension[] extensions = Platform.getPluginRegistry().getExtensionPoint(CVSProviderPlugin.ID, CVSProviderPlugin.PT_AUTHENTICATOR).getExtensions();
	if (extensions.length == 0)
	return null;
	IExtension extension = extensions[0];
	IConfigurationElement[] configs = extension.getConfigurationElements();
	if (configs.length == 0) {
	CVSProviderPlugin.log(new Status(IStatus.ERROR, CVSProviderPlugin.ID, 0, Policy.bind("CVSAdapter.noConfigurationElement", new Object[] {extension.getUniqueIdentifier()}), null));
	return null;
	}
	try {
	IConfigurationElement config = configs[0];
	return (IUserAuthenticator) config.createExecutableExtension("run");
	} catch (CoreException ex) {
	CVSProviderPlugin.log(new Status(IStatus.ERROR, CVSProviderPlugin.ID, 0, Policy.bind("CVSAdapter.unableToInstantiate", new Object[] {extension.getUniqueIdentifier()}), ex));
	return null;
	}
	}
	/**
	* Validate that the given string could ne used to succesfully create
	* an instance of the receiver.
	*
	* This method performs some initial checks to provide displayable
	* feedback and also tries a more in-depth parse using fromString(String, boolean).
	*/
	public static IStatus validate(String location) {

	// Check some simple things that are not checked in creation
	if (location == null)
	return new CVSStatus(CVSStatus.ERROR, null, Policy.bind("CVSRepositoryLocation.nullLocation"));
	if (location.equals(""))
	return new CVSStatus(CVSStatus.ERROR, null, Policy.bind("CVSRepositoryLocation.emptyLocation"));
	if (location.endsWith(" ") \|\| location.endsWith("\t"))
	return new CVSStatus(CVSStatus.ERROR, null, Policy.bind("CVSRepositoryLocation.endWhitespace"));
	if (!location.startsWith(":") \|\| location.indexOf(COLON, 1) == -1)
	return new CVSStatus(CVSStatus.ERROR, null, Policy.bind("CVSRepositoryLocation.startOfLocation"));

	// Do some quick checks to provide geberal feedback
	String formatError = Policy.bind("CVSRepositoryLocation.locationForm");
	int secondColon = location.indexOf(COLON, 1);
	int at = location.indexOf(HOST_SEPARATOR);
	if (at != -1) {
	String user = location.substring(secondColon + 1, at);
	if (user.equals(""))
	return new CVSStatus(CVSStatus.ERROR, null, formatError);
	} else
	at = secondColon;
	int colon = location.indexOf(COLON, at + 1);
	if (colon == -1)
	return new CVSStatus(CVSStatus.ERROR, null, formatError);
	String host = location.substring(at + 1, colon);
	if (host.equals(""))
	return new CVSStatus(CVSStatus.ERROR, null, formatError);
	String path = location.substring(colon + 1, location.length());
	if (path.equals(""))
	return new CVSStatus(CVSStatus.ERROR, null, formatError);

	// Do a full parse and see if it passes
	try {
	fromString(location, true);
	} catch (CVSException e) {
	// An exception is always throw. Return the status
	return e.getStatus();
	}

	// Looks ok (we'll actually never get here because above
	// fromString(String, boolean) will always throw an exception).
	return new CVSStatus(IStatus.OK, Policy.bind("ok"));
	}
	}