examples/org.eclipse.team.examples.filesystem/doc-html/team_filesystem_ex.html

<!doctype html public "-//w3c//dtd html 4.0//en">
<html>
<head>
   <meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2013. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
   <link rel="stylesheet" href="../../../book.css" charset="ISO-8859-1" type="text/css">
   <title>Team - File System Repository Provider Example</title>
</head>
<body>

<h2>Team - File System Repository Provider Example</h2>

<h3>Introduction</h3>
<p>
The File System and Pessimistic Repository Providers examples shows how to define your own repository provider. In particular you
this example shows how to:
<ul>
<li>Extend the RepositoryProvider class and register a new repository provider.
<li>Register a sharing wizard that will appear in the Team > Share... wizard.
<li>Add resource actions to the Team menu.
<li>Implement synchronization support that shows up the Synchronize View.
<li>Use decorators to show the repository state of the local resources.
<li>How to implement a file modification validator.
<li>Add a repository provider to a capability.
<li>Add a History page for the basic file system which will display both the local history revisions and the file system revisions in the
History view.</li>
</ul>
The example includes two separate repository providers: the basic file system and the pessimistic file system. The basic provider illustrates
the synchronization support whereas the pessimistic provider is more focused to allowing you to test the workbench behavior with pessimistic
repository providers. There is a preference page for the pessimistic provider that allows configuring the behavior of the file modification
validator.

<h3>Running the example</h3>
<p>
To start using this example create a project and select <b>Team > Share Project...</b> from the project's popup menu. Click the show 
all wizards button. This will show both the file system provider and the pessimistic provider.
<ul>
<li><b>Basic file system provider</b>: you will have to enter the location in the local file system where you would like to connect the project
to. The Get and Put operations in the Team menu will now transfer to and from the selected location. And if you open the Synchronize View
you can browse the synchronization between the local workspace and the remote file system location the files are stored in. If you edit
a file and then create a Synchronization you can browse changes between the local and the remote.
<li><b>Pessimistic file system provider</b>: the sharing wizard next page doesn't actually require any user input. The pessimistic
provider doesn't actually copy the local files anywhere, and instead simply simulates a check in/check out by flipping the 
read-only bit on files. Once a project is shared with the pessimistic provider you can add files to control and the check in and check out.
</ul>
<p>
</body>
</html>