IntentRepositoryManager.java

/*******************************************************************************
 * Copyright (c) 2011 Obeo.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     Obeo - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.intent.collab.common.repository;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.mylyn.docs.intent.collab.common.internal.IntentRepositoryManagerImpl;
import org.eclipse.mylyn.docs.intent.collab.repository.Repository;
import org.eclipse.mylyn.docs.intent.collab.repository.RepositoryConnectionException;

/**
 * Manages the creation of repositories.
 * 
 * @author <a href="mailto:william.piers@obeo.fr">William Piers</a>
 */
public interface IntentRepositoryManager {

	/**
	 * Default instance.
	 */
	IntentRepositoryManager INSTANCE = new IntentRepositoryManagerImpl();

	/**
	 * Returns the {@link Repository} associated to the given identifier (can be an IProject name, a CDO
	 * Repository name...).
	 * 
	 * @param identifier
	 *            the identifier (can be an IProject name, a CDO Repository name...) to get the Repository
	 *            from
	 * @return the {@link Repository} associated to the given Intent project name
	 * @throws RepositoryConnectionException
	 *             if the repository cannot be created
	 * @throws CoreException
	 *             if the repository type cannot be found
	 */
	Repository getRepository(String identifier) throws RepositoryConnectionException, CoreException;

	/**
	 * Indicates if the given project is handled by a {@link Repository}.
	 * 
	 * @param identifier
	 *            the identifier (can be an IProject name, a CDO Repository name...) to get the Repository
	 *            from
	 * @return true if the given project is handled by a {@link Repository}, false otherwise
	 */
	boolean isManagedProject(String identifier);

	/**
	 * Removes the repository from the registry.
	 * 
	 * @param identifier
	 *            the identifier (can be an IProject name, a CDO Repository name...) to get the Repository
	 *            from
	 */
	void deleteRepository(String identifier);

	/**
	 * Registers the repository with the given identifier.
	 * 
	 * @param identifier
	 *            the repository identifier
	 * @param repository
	 *            the repository
	 */
	void register(String identifier, Repository repository);

}