Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: e590138cbb561394901877e381f4bd3a88d62628 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
  <meta content="text/html; charset=iso-8859-1"
 http-equiv="Content-Type">
  <meta content="IBM" name="Author">
  <title>Package-level Javadoc</title>
</head>
<body>
Application programming interfaces for generating and refreshing
synchronization state.
<h2>Package Specification</h2>
<p>This package specifies the API for Team subscribers. A Subscriber
provides access to the synchronization state between the local
workspace resources and a set of variants of those resources, whether
it be a code repository or some other type of server (e.g. FTP). A
subscriber is typically associated with only a subset of the resources
in the local workspace, referred to as the set of resources the
subscriber supervises. The supervised local resources have a
corresponding variant state which describes the state of the remote
resources that correspond to the local resources.</p>
<p>A Subscriber provides:</p>
<ul>
  <li>a set of root resources that define the subset of resources in
the workspace that the subscriber supervises (some children of the
roots may not be supervised, as indicated by the isSupervised method).</li>
  <li>access to the synchronization state (using SyncInfo) between the
resources it supervises and their corresponding variant resources.</li>
  <li> the ability to refresh the the remote state</li>
  <li>change notification to registered listeners (of type
ISubscriberChangeListener) when the variant state changes or when roots
are added or removed.</li>
</ul>
<h3>Implementing a Subscriber </h3>
<p>An implementation of a subscriber must provide:
</p>
<ul>
  <li>a subclass of Subcriber which maintains the synchronization state
between its local resources and their corresponding variants.</li>
  <li>an implemenation of IResourceVariant which provides access to the
contents and other state of a variant resource that corresponds to a
local resource</li>
  <li>an implementation of IResourceVariantComparator which is used by
SyncInfo to determine the synchronization state of a resource.</li>
</ul>
Optionally, a subscriber may provide a subclass of SyncInfo in order to
customize the algorithm used to
determine the synchronization state of a resource.
<p></p>
<h3>Additional Classes</h3>
<p>The SubscriberSyncInfoCollector is used to collect the SyncInfo for
out-of-sync resources from a subscriber into a SyncInfoTree that can be
used to, for example, display the out-of-sync resources of a subscriber
to the user. The collector supports filtering by working set and
SyncInfoFilter (e.g. to select groupings such as incoming-changes or
conflicts). Even when filtered, the collector still maintains a set of
all out-of-sync resources from the subscriber in order to provide
statistics on the number of pre and post filtered out-of-sync resources.</p>
<p>FilteredSyncInfoCollector: should be generalized</p>
</body>
</html>

Back to the top