StandardOperations becomes SimpleAccess

2 files changed, 278 insertions, 19 deletions

diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/RepositoryProvider.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/RepositoryProvider.java
index 7aab61e4b..d38586e4e 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/RepositoryProvider.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/RepositoryProvider.java
@@ -13,6 +13,7 @@ import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.Status;
 import org.eclipse.team.core.internal.Policy;
+import org.eclipse.team.internal.simpleAccess.SimpleAccessOperations;
 
 /**
  * A concrete subclass of <code>RepositoryProvider</code> is created for each
@@ -68,25 +69,18 @@ public abstract class RepositoryProvider implements IProjectNature {
 
 	abstract public String getID();
 
-	/**
-	 * Returns an object which implements a set of provider neutral operations for this 
-	 * provider. Answers <code>null</code> if the provider does not wish to support these 
-	 * operations.
-	 * <p>
-	 * The <code>StandardOperations</code> class exposes a basic repository model that
-	 * providers may implement to allow third-party plugins to perform repository operations
-	 * programmatically. For example, a code generation tool may want to get source
-	 * files before generating the code, and check-in the results.  If a provider plugin does
-	 * not adhere to the <i>semantics</i> of the <code>StandardOperations</code> class
-	 * as described, the provider will not be useable programmatically by other third-party 
-	 * plugins.</p>
-	 * 
-	 * @return the repository operations or <code>null</code> if the provider does not
-	 * support provider neutral operations.
-	 */
-	public StandardOperations getStandardOperations() {
-		return null;
-	}
+	/*
+	 * Provisional.
+ 	 * Returns an object which implements a set of provider neutral operations for this 
+ 	 * provider. Answers <code>null</code> if the provider does not wish to support these 
+ 	 * operations.
+ 	 * 
+ 	 * @return the repository operations or <code>null</code> if the provider does not
+ 	 * support provider neutral operations.
+ 	 */
+	public SimpleAccessOperations getSimpleAccess() {
+ 		return null;
+ 	}
 
 	/**
 	 * Returns an <code>IFileModificationValidator</code> for pre-checking operations 
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/internal/simpleAccess/SimpleAccessOperations.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/internal/simpleAccess/SimpleAccessOperations.java
new file mode 100644
index 000000000..f4e1f80a5
--- /dev/null
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/internal/simpleAccess/SimpleAccessOperations.java
@@ -0,0 +1,265 @@
+package org.eclipse.team.internal.simpleAccess;
+
+/*
+ * (c) Copyright 2001 MyCorporation.
+ * All Rights Reserved.
+ */
+
+import org.eclipse.team.core.*;
+import org.eclipse.core.resources.IFile;
+import org.eclipse.core.resources.IResource;
+import org.eclipse.core.runtime.IPath;
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.IStatus;
+
+	/*
+	 * This class represents provisional API.  Its here to allow experimentation with 3rd party tools
+	 * calling providers in a repository neutral manner.
+	 * 
+	 * A provider is not required to implement this API.
+	 * Implementers, and those who reference it, do so with the awareness that this class may be
+	 * removed or substantially changed at future times without warning.
+ 	 * 
+	 * The <code>SimpleAccessOperations</code> class exposes a basic repository model that
+	 * providers may implement to allow third-party plugins to perform repository operations
+	 * programmatically. For example, a code generation tool may want to get source
+	 * files before generating the code, and check-in the results.  If a provider plugin does
+	 * not adhere to the <i>semantics</i> of the <code>SimpleAccessOperations</code> class
+	 * as described, they are free to opt out of implementing it.
+	 */
+
+public interface SimpleAccessOperations {
+	
+	/**
+	 * Updates the local resource to have the same content as the corresponding remote
+	 * resource. Where the local resource does not exist, this method will create it.
+	 * <p>
+	 * If the remote resource is a container (e.g. folder or project) this operation is equivalent 
+	 * to getting each non-container member of the remote resource, thereby updating the
+	 * content of existing local members, creating local members to receive new remote resources,
+	 * and deleting local members that no longer have a corresponding remote resource.</p>
+	 * <p>
+	 * The method is applied to all resources satisfying the depth parameter, described above.</p>
+	 * <p>
+	 * Interrupting the method (via the progress monitor) may lead to partial, but consistent, results.</p>
+	 * 
+	 * @param resources an array of local resources to update from the corresponding remote
+	 * resources.
+	 * @param depth the depth to traverse the given resources, taken from <code>IResource</code>
+	 * static constants.
+	 * @param progress a progress monitor to indicate the duration of the operation, or
+	 * <code>null</code> if progress reporting is not required.
+	 * @throws TeamProviderException if there is a problem getting one or more of the resources.  The
+	 * exception will contain multiple statuses, one for each resource in the <code>resources</code>
+	 * array.  Possible status codes include:
+	 * <ul>
+	 * 		<li>NO_REMOTE_RESOURCE</li>
+	 *			<li>IO_FAILED</li>
+	 * 		<li>NOT_AUTHORIZED</li>
+	 * 		<li>UNABLE</li>
+	 * </ul>
+	 */
+	public void get(IResource[] resources, int depth, IProgressMonitor progress) throws TeamException;
+
+	/**
+	 * Changes the state of the local resource from checked-in to checked-out and transfers the content
+	 * of the remote resource to the local resource.
+	 * <p>
+	 * Where no corresponding local resource exists in the workspace, one is created (including any
+	 * intermediate parent containers) to receive the contents of the remote resource.</p>
+	 * <p>
+	 * Implementations may optimistically only flag the state change locally and rely on resolving conflicts
+	 * during check-in, or they may pessimistically also checkout or lock the remote resource during a
+	 * local resource checkout to avoid conflicts.  The provider API does not subscribe to either model
+	 * and supports each equally.</p>
+	 * <p>
+	 * Where checkout is applied to a resource that is already checked-out the method has no
+	 * effect.</p>
+	 *
+	 * @param resources the array of local resources to be checked-out.
+	 * @param depth the depth to traverse the given resources, taken from <code>IResource</code>
+	 * constants.
+	 * @param progress a progress monitor to indicate the duration of the operation, or
+	 * <code>null</code> if progress reporting is not required.
+	 * @throws TeamProviderException if there is a problem checking-out one or more of the resources.
+	 * The exception will contain multiple statuses, one for each resource in the <code>resources</code>
+	 * array.  Possible status codes include:
+	 * <ul>
+	 * 		<li>NOT_CHECKED_IN</li>
+	 *			<li>NO_REMOTE_RESOURCE</li>
+	 *			<li>IO_FAILED</li>
+	 * 		<li>NOT_AUTHORIZED</li>
+	 * 		<li>UNABLE</li>
+	 * </ul>
+	 * @see checkin(IResource[], int, IProgressMonitor)
+	 */
+	public void checkout(IResource[] resources, int depth, IProgressMonitor progress) throws TeamException;
+
+	/**
+	 * Transfers the content of the local resource to the corresponding remote resource, and changes the
+	 * state of the local resource from checked-out to checked-in.
+	 * <p>
+	 * If a remote resource does not exist this method creates a new remote resource with the same content
+	 * as the given local resource.  The local resource is said to <i>correspond</i> to the new remote resource.</p>
+	 * <p>
+	 * Where providers deal with stores that check-out or lock resources this method is an opportunity
+	 * to transfer the content and make the corresponding remote check-in or unlock.  It is envisaged that
+	 * where the server maintains resource versions, checkin creates a new version of the remote resource.</p>
+	 * <p>
+	 * Note that some providers may <em>require</em> that a resource is checked-out before it can be
+	 * checked-in.  However, all providers must support the explicit checking out a resource before checking
+	 * it in (e.g., even if the check out is a no-op).</p>
+	 * 
+	 * @param resources an array of local resources to be checked-in.
+	 * @param the depth to traverse the given resources, taken from <code>IResource</code>
+	 * constants.
+	 * @param progress a progress monitor to indicate the duration of the operation, or
+	 * <code>null</code> if progress reporting is not required.
+	 * @throws TeamProviderException if there is a problem checking-in one or more of the resources.
+	 * The exception will contain multiple statuses, one for each resource in the <code>resources</code>
+	 * array.  Possible status codes include:
+	 * <ul>
+	 * 		<li>NOT_CHECKED_OUT</li>
+	 *			<li>IO_FAILED</li>
+	 * 		<li>NOT_AUTHORIZED</li>
+	 * 		<li>UNABLE</li>
+	 * </ul>
+	 * @see checkout(IResource[], int, IProgressMonitor)
+	 */
+	public void checkin(IResource[] resources, int depth, IProgressMonitor progress) throws TeamException;
+
+	/**
+	 * Changes the state of the local resource from checked-out to checked-in without updating the contents
+	 * of the remote resource.
+	 * <p>
+	 * Note that where the provider is a versioning provider, it is envisaged (though not required) that the
+	 * uncheckout operation does not create a new version.</p>
+	 * <p>
+	 * Note also that <code>uncheckout()</code> does not affect the content of the local resource.  The
+	 * caller is required to perform a <code>get()</code> to revert the local resource if that is required
+	 * (otherwise the local resource will be left with the changes that were made while the remote resource
+	 * was checked-out.  Furthermore, it is valid to call <code>uncheckout()</code> with an
+	 * <code>IResource</code> that does not exist locally.</p>
+	 * 
+	 * @param resources an array of the local resources that are to be unchecked-out.
+	 * @param depth the depth to traverse the given resources, taken from <code>IResource</code>
+	 * constants.
+	 * @param progress a progress monitor to indicate the duration of the operation, or
+	 * <code>null</code> if progress reporting is not required.
+	 * @throws TeamProviderException if there is a problem undoing the check-out of one or more of
+	 * the resources.  The exception will contain multiple statuses, one for each resource in the
+	 * <code>resources</code> array.  Possible status codes include:
+	 * <ul>
+	 * 		<li>NOT_CHECKED_OUT</li>
+	 *			<li>IO_FAILED</li>
+	 * 		<li>NOT_AUTHORIZED</li>
+	 * 		<li>UNABLE</li>
+	 * </ul>
+	 * @see checkin(IResource)
+	 * @see uncheckout(IResource)
+	 */
+	public void uncheckout(IResource[] resources, int depth, IProgressMonitor progress) throws TeamException;
+
+	/**
+	 * Deletes the remote resource corresponding to the given local resource.
+	 * <p>
+	 * The notion of delete is simply to make the remote resource unavailable.  Where the provider
+	 * supports versioning it is not specified whether the delete operation makes the version
+	 * temporarily or forever unavailable, or indeed whether the entire history is made unavailable.</p>
+	 * <p>
+	 * Note that the <code>IResource</code>'s passed as arguments may be non-existant in the
+	 * workbench, the typical case is when such a resource has been received in a core callback.</p>
+	 * <p>
+	 * The resource may be checked-in or checked-out prior to deletion.  The local resource is not
+	 * deleted by this method.</p>
+	 * <p>
+	 * Resource deletions are inherently deep.</p>
+	 * 
+	 * @param resources the array of resources whose corresponding remote resources are to be deleted.
+	 * @param progress a progress monitor to indicate the duration of the operation, or
+	 * <code>null</code> if progress reporting is not required.
+	 * @throws TeamProviderException if there is a problem deleting one or more of
+	 * the resources.  The exception will contain multiple statuses, one for each resource in the
+	 * <code>resources</code> array.  Possible status codes include:
+	 * <ul>
+	 * 		<li>NO_REMOTE_RESOURCE</li>
+	 *			<li>IO_FAILED</li>
+	 * 		<li>NOT_AUTHORIZED</li>
+	 * 		<li>UNABLE</li>
+	 * </ul>
+	 */
+	public void delete(IResource[] resources, IProgressMonitor progress) throws TeamException;
+
+	/**
+	 * Informs the provider that a local resource's name or path has changed.
+	 * <p>
+	 * Some providers, such as versioning providers, may require this information to track the resource
+	 * across name changes.</p>
+	 * <p>
+	 * Note that this method is always called <em>after</em> the local resource has been moved.</p>
+	 * 
+	 * @param source the full name of the resource before it was moved.
+	 * @param target the resource that was moved.
+	 * @param progress a progress monitor to indicate the duration of the operation, or
+	 * <code>null</code> if progress reporting is not required.
+	 * @throws TeamProviderException if there is a problem recording the move.  The exception will
+	 * contain a single status. Possible status codes are:
+	 * <ul>
+	 * 		<li>NO_REMOTE_RESOURCE</li>
+	 *			<li>IO_FAILED</li>
+	 * 		<li>NOT_AUTHORIZED</li>
+	 * 		<li>UNABLE</li>
+	 * </ul>
+	 */	
+	public void moved(IPath source, IResource target, IProgressMonitor progress) throws TeamException;
+	
+	/*
+	 * Implementor's Note:
+	 * The following methods are required to return promptly (i.e., they may be used to determine the state of
+	 * a resource in a UI where long delays are unacceptable).  Implementations may cache these values
+	 * and update the cache on an explicit call to #refreshState().
+	 * 
+	 * They are currently listed in the provider API, however, they may be moved to a new or different
+	 * interface in the future to better reflect their UI-orientation.
+	 */
+
+	/**
+	 * Answers if the remote resource state is checked-out. If the resource has never been checked in this
+	 * method will return <code>true</code>.
+	 * <p>
+	 * It is undefined whether this method tests for a resource being checked out to this workspace
+	 * or any workspace.</p>
+	 * 
+	 * @param resource the local resource to test.
+	 * @return <code>true</code> if the resource is checked-out and <code>false</code> if it is not.
+	 * @see checkout(IResource[], int, IProgressMonitor)
+	 * @see refreshState(IResource[], int, IProgressMonitor)
+	 */
+	public boolean isCheckedOut(IResource resource);
+	
+	/**
+	 * Answers whether the resource has a corresponding remote resource.
+	 * <p>
+	 * Before a resource is checked-in, the resource will occur locally but not remotely, and calls to this
+	 * method will return <code>false</code>.  Once a local resource is checked in (and assuming the local
+	 * local resource is not moved or the remote resource deleted) there will be a corresponding remote
+	 * resource and this method returns <code>true</code>.</p>
+	 * 
+	 * @param resource the local resource to test.
+	 * @return <code>true</code> if the local resource has a corresponding remote resource,
+	 * and <code>false</code> otherwise.
+	 * @see checkin(IResource[], int, IProgressMonitor)
+	 * @see refreshState(IResource[], int, IProgressMonitor)
+	 */
+	public boolean hasRemote(IResource resource);
+
+	/**
+	 * Answer if the local resource currently has a different timestamp to the base timestamp
+	 * for this resource.
+	 * 
+	 * @param resource the resource to test.
+	 * @return <code>true</code> if the resource has a different modification
+	 * timestamp, and <code>false</code> otherwise.
+	 */
+	public boolean isDirty(IResource resource);
+}
\ No newline at end of file