[Bio] / FigCommon / SeedRegistry Repository:
ViewVC logotype

Annotation of /FigCommon/SeedRegistry

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (view) (download)

1 : olson 1.1 SEED Instance Registry
2 :     ========================
3 :     Robert Olson <olson@mcs.anl.gov>
4 :     Dec 2003
5 :    
6 :     The SEED instance registry is a network facility that allows users of
7 :     SEED instances to register these instances and to look up the list of
8 :     registered instances for the purpose of performing peer-to-peer
9 :     updates.
10 :    
11 :     The Registration Process
12 :     ------------------------
13 :    
14 :     The following information is maintained for each registered seed:
15 :    
16 :     *Instance ID*. A unique identifier for the SEED instance.
17 :    
18 :     *Name*. A human-readable name for the SEED instance, provided by the
19 :     SEED user registering the instance.
20 :    
21 :     *URL*. The URL to the SEED instance.
22 :    
23 :     *Comment*. A free-text comment about the seed instance.
24 :    
25 :     Registration API
26 :     ~~~~~~~~~~~~~~~~
27 :    
28 :     We define a simple HTTP GET/POST API for manipulating the registry.
29 :    
30 :     The high-level functions provided are as follows.
31 :    
32 :     - Register. Register a new SEED instance. This registration returns a
33 :     cookie that can be used to later change or delete the registration.
34 :    
35 :     - Unregister. Remove a SEED registration.
36 :    
37 :     - Retrieve. Return a list of SEED instances (in machine-parsable format).
38 :    
39 :     - View. Return a human-readable HTML form of the list of SEED
40 :     instances.
41 :    
42 :     Register
43 :     ^^^^^^^^
44 :    
45 :     This is an HTTP POST with the arguments encoded in standard
46 :     application/x-www-form-urlencoded format. The following values are
47 :     expected to be passed:
48 :    
49 :     *id*. SEED instance identifier.
50 :     *name*. SEED instance name.
51 :     *url*. SEED instance URL.
52 :     *comment*. Comment.
53 :    
54 :     The return is also in application/x-www-form-urlencoded format, with
55 :     the following values:
56 :    
57 :     *status*. Status code.
58 :     *token*. A unique token used to change the registration entry in the
59 :     *future.
60 :    

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3