Project

General

Profile

Repo Protocol Specification » History » Version 116

Shuo Chen, 03/28/2014 12:50 AM

1 1 Shuo Chen
Repo Protocol Specification
2
===========================
3
4 36 Shuo Chen
A Repo supports the network by preserving content and responding to Interests requesting content that it holds. A Repo can exist in any node, and is recommended if applications in that node need to preserve data. The NDN repo protocol is a specification of repo operations including reading, insertion and deletion of data objects in repo.
5 2 Shuo Chen
6
Repo semantics is based on [Command Interests](http://redmine.named-data.net/projects/nfd/wiki/Command_Interests) with signed commponents an the end of the name and basic common semantics of NDN. 
7
8 11 Shuo Chen
When some operation of repo including insertion and deletion of data objects is requested, a command interest is sent. The command interest is the interest as command of insertion and deletion and signed as form of command interest for access control. The repo will response the command with the data object.
9 4 Shuo Chen
10
The repo protocol can be categorized in three sections of reading, insertion and deletion of data objects.
11
12
## Repo Reading Specification
13
14 36 Shuo Chen
Repo registers prefixes of data objects it holds into NDN fowarding deamon and the repo will respond the data with such prefixes.
15 6 Shuo Chen
16 11 Shuo Chen
A standard interest is used to fetch content from the repo. The repo will respond when the name of the interest matches the prefix it registered in NFD. If the content in repo matches the interests, it will respond with the data object. When the interest is not matched, it will not respond.
17 6 Shuo Chen
18
The protocol is listed as bellow
19
20
If there is a matching data object:
21
22 7 Shuo Chen
    Requester                     Repo
23
        |                           |
24
        |                           |
25
        |         Interest          |
26
     t1 |-------------------------->|
27
        |                           |
28
        |        Data Object        |
29
     t2 |<==========================|
30 1 Shuo Chen
        |                           |
31 7 Shuo Chen
        |                           |
32 1 Shuo Chen
        |                           |
33 7 Shuo Chen
34
If there is no matching data object:
35 6 Shuo Chen
36
    Requester                     Repo
37
        |                           |
38 1 Shuo Chen
        |                           |
39 7 Shuo Chen
        |         Interest          |
40
     t1 |-------------------------->|
41
        |                           |
42
        |                           |
43
        |                           |
44
45 74 Shuo Chen
46
### About Freshness
47
48
Solution to handle freshness by repo has not been clearly defined, so producer needs to take care of freshness when it puts things into repo, i.e. explicitly delete obsolete content. The mustbefresh selector will be ignored by repo when fetching content from repo or handling repo command by repo.
49
50 30 Shuo Chen
## Repo Command
51
For insertion, deletion and other operations of repo, these commands are encoded in the form of [sigend command interest](http://redmine.named-data.net/projects/nfd/wiki/Command_Interests). The semantics of repo command interest is as follows:
52 14 Shuo Chen
53 8 Shuo Chen
The name semantics is defined to have following components:
54 1 Shuo Chen
55 75 Shuo Chen
* ``<repo prefix>`` refers to specific prefix repo is listening
56 30 Shuo Chen
* ``<command verb>`` refers to the name of command
57 91 Shuo Chen
* ``<RepoCommandParameter>`` refers to parameters of repo command
58 1 Shuo Chen
59 38 Shuo Chen
The following components are components of singed interest for access control:
60 1 Shuo Chen
61
* ``<timestamp>``
62 8 Shuo Chen
* ``<random-value>``
63
* ``<SignatureInfo>``
64
* ``<SignatureValue>``
65
66 75 Shuo Chen
For prefix of repo /ucla/cs/repo/, the command will be defined as this:
67 33 Shuo Chen
68 91 Shuo Chen
    /ucla/cs/repo/<command verb>/<RepoCommandParameter>/<timestamp>/<random-value>/<SignatureInfo>/<SignatureValue>
69 14 Shuo Chen
70 91 Shuo Chen
### RepoCommandParameter
71 29 Shuo Chen
72 91 Shuo Chen
    RepoCommandParameter ::= REPOCOMMANDPARAMETER-TYPE TLV-LENGTH
73 116 Shuo Chen
                               Name
74 42 Shuo Chen
                               Selectors?
75 1 Shuo Chen
                               StartBlockId?
76
                               EndBlockId?
77 62 Shuo Chen
                               ProcessId?
78 29 Shuo Chen
79 48 Shuo Chen
    Name                  ::= NAME-TYPE TLV-LENGTH NameComponent*
80
    NameComponent         ::= NAME-COMPONENT-TYPE TLV-LENGTH BYTE+
81 43 Shuo Chen
82
    Selectors             ::= SELECTORS-TYPE TLV-LENGTH
83
                               MinSuffixComponents?
84
                               MaxSuffixComponents?
85
                               PublisherPublicKeyLocator?
86
                               Exclude?
87 47 Shuo Chen
                               ChildSelector?
88 43 Shuo Chen
89
    MinSuffixComponents   ::= MIN-SUFFIX-COMPONENTS-TYPE TLV-LENGTH
90
                               nonNegativeInteger
91
92
    MaxSuffixComponents   ::= MAX-SUFFIX-COMPONENTS-TYPE TLV-LENGTH
93
                               nonNegativeInteger
94
95
    PublisherPublicKeyLocator ::= KeyLocator
96
97
    Exclude               ::= EXCLUDE-TYPE TLV-LENGTH Any? (NameComponent (Any)?)+
98
    Any                   ::= ANY-TYPE TLV-LENGTH(=0)
99 47 Shuo Chen
100
    ChildSelector         ::= CHILD-SELECTOR-TYPE TLV-LENGTH
101
                               nonNegativeInteger
102 1 Shuo Chen
    
103
    StartBlockId          ::= STARTBLOCKID-TYPE TLV-LENGTH
104 49 Shuo Chen
                               nonNegativeInteger
105 1 Shuo Chen
    
106
    EndBlockId            ::= ENDBLOCKID-TYPE TLV-LENGTH
107 49 Shuo Chen
                               nonNegativeInteger
108 1 Shuo Chen
109 62 Shuo Chen
    ProcessId            ::= PROCESSID-TYPE TLV-LENGTH
110
                               nonNegativeInteger
111
112 44 Shuo Chen
#### Repo Command Selectors
113 38 Shuo Chen
114 52 Shuo Chen
Repo command supports parts of interest selectors of interest to indicate which contents to process. The definition of standard NDN selectors is described in [NDN Selectors Doc](http://named-data.net/doc/ndn-tlv/interest.html#selectors). The concrete definitions of both standard NDN selectors and repo command selectors are the same.
115
116
The difference between standard NDN interest and Repo Deletion Command interest that, the standard NDN selectors just matches **one** data packet that conforms to the selector conditions, but repo command selectors would matches **any** data packets. For example, if Interest is expressed for /ndn/edu and Exclude specifies one name component ucla, in standard NDN interest, the data producers will first exclude all the data packets with prefix /ndn/edu but not /ndn/edu/ucla, and then just selects one data packet. In repo deletion command interest, it will select all the data packets with prefix /ndn/edu but not /ndn/edu/ucla. However, in repo insert command, the repo will fetch one data just like standard interest selectors.
117 38 Shuo Chen
118 51 Shuo Chen
Repo command supports parts of standard NDN interests including MinSuffixComponents, MaxSuffixComponents, PublisherPublicKeyLocator, Exclude, ChildSelector. If command contains other selectors, repo will ignore these not supported selectors. In addition, selectors are just supported in delete command. If other commands contains selectors, repo will ignore selectors when processing these commands.
119 38 Shuo Chen
120
The form of selectors is as follows:
121
122
    Selectors             ::= SELECTORS-TYPE TLV-LENGTH
123
                               MinSuffixComponents?
124
                               MaxSuffixComponents?
125
                               PublisherPublicKeyLocator?
126 1 Shuo Chen
                               Exclude?
127 51 Shuo Chen
                               ChildSelector?
128 38 Shuo Chen
    
129
    MinSuffixComponents   ::= MIN-SUFFIX-COMPONENTS-TYPE TLV-LENGTH
130
                               nonNegativeInteger
131
132
    MaxSuffixComponents   ::= MAX-SUFFIX-COMPONENTS-TYPE TLV-LENGTH
133
                               nonNegativeInteger
134
135
    PublisherPublicKeyLocator ::= KeyLocator
136
    
137
    Exclude               ::= EXCLUDE-TYPE TLV-LENGTH Any? (NameComponent (Any)?)+
138 1 Shuo Chen
    Any                   ::= ANY-TYPE TLV-LENGTH(=0)
139 51 Shuo Chen
140
    ChildSelector         ::= CHILD-SELECTOR-TYPE TLV-LENGTH
141
                               nonNegativeInteger
142 46 Shuo Chen
143
#### StartBlockId, EndBlockId
144 38 Shuo Chen
145 54 Shuo Chen
StartBlockId and EndBlockId are used to process segmented data. StartBlockId indicate the first segment number and EndBlockId indicate the last segment number. Repo will process segment data whose segment id between StartBlockId and EndBlockId. If StartBlockId is missing, the first segment id the repo process is 0; If EndBlockId is missing, this scenario is described in specific process in Repo Insertion Command section and Repo Deletion Command section.
146 62 Shuo Chen
147 68 Shuo Chen
#### Conflict of Selectors and StartBlockId, EndBlockId
148 67 Shuo Chen
149 91 Shuo Chen
Repo cannot process command with both selectors and StartBlockId, EndBlockId in RepoCommandParameter. If the RepoCommandParameter carries both, repo will ignore this command interest and return with error code of 405.
150 67 Shuo Chen
151 62 Shuo Chen
#### ProcessId
152 53 Shuo Chen
153 63 Shuo Chen
ProcessId is used by insertion and deletion check command to indicate specific insertion and deletion process. The ProcessId is fetched by repo command response of insertion and deletion command.
154
155 30 Shuo Chen
## Repo Command Response
156 1 Shuo Chen
157 30 Shuo Chen
Repo command response is the response data packet of repo command interest. The response contains statuscode to indicate the status of command process and other information. A TLV-encoded block called ``RepoCommandResponse`` is encoded in content of the data packet.
158 1 Shuo Chen
159 30 Shuo Chen
    RepoCommandResponse   ::= INSERTSTATUS-TYPE TLV-LENGTH
160 61 Shuo Chen
                               ProcessId?
161 1 Shuo Chen
                               StatusCode?
162
                               StartBlockId?
163
                               EndBlockId?
164
                               InsertNum?
165
166 61 Shuo Chen
    ProcessId            ::= PROCESSID-TYPE TLV-LENGTH
167 55 Shuo Chen
                                nonNegativeInteger 
168
    
169 1 Shuo Chen
    StatusCode            ::= STATUSCODE-TYPE TLV-LENGTH
170
                                nonNegativeInteger    
171
172
    StartBlockId          ::= STARTBLOCKID-TYPE TLV-LENGTH
173
                                nonNegativeInteger
174
    
175
    EndBlockId            ::= ENDBLOCKID-TYPE TLV-LENGTH
176
                                nonNegativeInteger
177 17 Shuo Chen
178
    InsertNum             ::= INSERTNUM-TYPE TLV-LENGTH
179
                                nonNegativeInteger
180
181 30 Shuo Chen
    DeleteNum             ::= DELETENUM-TYPE TLV-LENGTH
182
                                nonNegativeInteger
183 17 Shuo Chen
184 113 Shuo Chen
### Name
185
Name indicates the Name in repocommandparameter of repo command
186
187
188 61 Shuo Chen
### ProcessId
189
ProcessId is a random number generated by repo to indicate the number of the command process. Client could use this ProcessId to check the status of specific command.
190 59 Shuo Chen
191
### StatusCode
192
193 64 Shuo Chen
StatusCode indicates the status of repo command process. The statuscodes of insert and deletion command are described in following insertion and deletion specification.
194
195 59 Shuo Chen
### StartBlockId, EndBlockId
196
197 65 Shuo Chen
StartBlockId and EndBlockId are the same as those of RepoCommandParameter. If either of those in RepoCommandParameter is missing, repo will set them as the Id known for now. For example, if StartBlockId is missing in RepoCommandParameter, StartBlockId in response will be set 0. If EndBlockId is missing in RepoCommandParameter, EndBlockId will be set null untill Repo get FinalBlockId in data packet. If FinalBlockId in returned data packet is less than EndBlockId, the EndBlockId will be set FinalBlockId.
198
199 59 Shuo Chen
### InsertNum, DeleteNum
200 66 Shuo Chen
InsertNum is used in reponse of insertion status check to indicate how many data packets have been successfully inserted into the repo. DeleteNum is used in response of deletion command and deletion check command. DeleteNum indicates how many data packets have been successfully inserted from repo.
201 59 Shuo Chen
202 58 Shuo Chen
## Repo Trust Model
203 57 Shuo Chen
204
The trust model of repo depends on people who deploy the repo service, such as PKI. Repo can specify their own verification policies, and data consumers can specify their own trust anchors. The NDN [FAQ](http://named-data.net/project/faq/#How_does_NDN8217s_8220trust_management8221_work) shows how NDN trust managment works.
205
206 30 Shuo Chen
## Repo Insertion Specification
207
208 69 Shuo Chen
Repo insertion command requests that the repo retrieve and store content. This command interest is a signed interest and will be validated with access control policy defined by the repo. When the interested is validated and name of the data is not existed in the repo. The repository will reponse with a data object containing OK status and start to send the interest to fetch the data to insert.
209 30 Shuo Chen
210
Segmented data insertion is also supported in the insertion protocol. Segmantation info is defined as a TLV-encoded SegmantationInfo block. If the content is segmented, the final segment id will be encoded in this block.
211
212
### Insertion command interest semantics
213
214
The name semantics is follows the format of the repo command. The <command verb> is defined as ``insert``.
215 76 Shuo Chen
For example, for ``<repo prefix>`` as ``/ucla/cs/repo``, the following is an example:
216 1 Shuo Chen
217 92 Shuo Chen
    /ucla/cs/repo/insert/<RepoCommandParameter>/<timestamp>/<random-value>/<SignatureInfo>/<SignatureValue>
218 30 Shuo Chen
219
### Insertion status check
220
221
During the insertion progress, the requester could send insertion status check command to check the status of the insertion progress. This status check command is also signed interest. The semantics of insertion status check command is shown as follows:
222
223
<command verb> equals to ``insert check``. For example:
224 1 Shuo Chen
225 93 Shuo Chen
    /ucla/cs/repo/insert check/<RepoCommandParameter>/<timestamp>/<random-value>/<SignatureInfo>/<SignatureValue>
226 69 Shuo Chen
227
### RepoCommandParameter
228
229 70 Shuo Chen
RepoCommandParameter of insertion and insertion check command follows that in Repo Command section. Name, Selectors, StartBlockId, EndBlockId are used in insertion. Name and ProcessId are used in insertion check command.
230 69 Shuo Chen
231 70 Shuo Chen
In insertion command, Name represents the name or prefix of data for repo to fetch. If selectors are set, repo will use these selectors to fetch the data. If StartBlockId or EndBlockId is set, the repo will retrieve segmented data with segment number between StartBlockId and EndBlockId. If Repo Insert Command carries both Selectors and StartBlockId, EndBlockId, repo would ignore it and response with statuscode of 405.
232
233
In insertion check command, Name represents name or prefix of data for repo to fetch. ProcessId is set by the RepoCommandResponse to indicate specified process.
234 30 Shuo Chen
235
### Insertatation status response
236
237
This insert status data object could be the response data object of both insert command and insert check command. It will follow the format of repo command response.
238
239 77 Shuo Chen
StatusCode indicates the status of insertion. InsertNum represents how many data has been intersted into the repo. StartBlockId and EndBlockId is the start and end segment id of data inserted. InsertNum is the how many data segments have been inserted. ProcessId indicates an ID of process, a random number gernerated by repo.
240 30 Shuo Chen
241 77 Shuo Chen
For insert cammand, status code will be set according to definition below, StartBlockId and EndBlockId will be set according to the insert command. If StartBlockId in RepoCommandParameter is missing, it will be set 0 in response. If EndBlockId is missing, it will not be set.
242 30 Shuo Chen
243 77 Shuo Chen
For insert check command, status code will be set according to definition below, StartBlockId and EndBlockId will be set according to the StartBlockId and EndBlockId that repo is using, insertnum will be set according to insertion progress. ProcessId is set according to the ID of process checked. If EndBlockId has not been decided, this EndBlockId will not be set in response.
244 30 Shuo Chen
245 1 Shuo Chen
StatusCode Definition:
246 17 Shuo Chen
247
``StatusCode`` | Description
248
-------------- | ----------------------------------------------
249 19 Shuo Chen
``100``        | The command is OK. can start to fetch the data
250
``200``        | All the data has been inserted
251 17 Shuo Chen
``300``        | This insertion is in progress
252 102 Shuo Chen
``401``        | This insertion command or insertion check command is invalidated
253
``402``        | Selectors and BlockId both present
254 105 Shuo Chen
``403``        | Malformed Command
255 17 Shuo Chen
``404``        | No such this insertion is in progress
256 102 Shuo Chen
``405``        | EndBlockId Missing Timeout
257 17 Shuo Chen
258 83 Shuo Chen
### EndBlockId Missing Timeout
259
260
If StartBlockId presents but EndBlockId is missing, and returned data packets do not contain FinalBlockId, the repo will continuosly fetch the data. An EndBlockId missing timeout is set to prevent this ocassion. The repo will start a timer when StartBlockId presents but EndBlockId is missing. When timeout happens, repo will stop fetching data to store and end insert process. If an insert check command arrives during this insert process, the time of timer is set to 0. If data packet containing FinalBlockId arrives, this timeout timer will be dismissed.
261
262 22 Alex Afanasyev
### Protocol Process
263
264 20 Alex Afanasyev
1. start to authorize the command; if authorization does not fail immediately, go to step 3
265 17 Shuo Chen
266 107 Shuo Chen
2. send a negative response indicating authorization failure, and abort these steps, insert process ends (StatusCode: 401)
267 14 Shuo Chen
268 100 Shuo Chen
3. if  both StartBlockId and EndBlockId are missing, go to step 7
269 14 Shuo Chen
270 109 Shuo Chen
4. if either StartBlockId or EndBlockId is present, and one of supported selectors is present. send negative reponse back and abort steps, insert process ends (StatusCode: 402)
271 14 Shuo Chen
272 78 Shuo Chen
5. if both StartBlockId and EndBlockId are present, and StartBlockId is less than or equal to EndBlockId, go to step 7
273 14 Shuo Chen
274 107 Shuo Chen
6. send a negative response indicating malformed command, and abort these steps, insert process ends (StatusCode: 403)
275 14 Shuo Chen
276 78 Shuo Chen
7. wait for authorization completion
277 14 Shuo Chen
278 107 Shuo Chen
8. if authorization fails, go to step 2 (StatusCode: 401)
279 14 Shuo Chen
280 107 Shuo Chen
9. send a positive response indicating insert is in progress (StatusCode: 200)
281 14 Shuo Chen
282 78 Shuo Chen
10. if either StartBlockId or EndBlockId is present, go to step 16
283 14 Shuo Chen
284 78 Shuo Chen
11. start to retrieve Name with selectors in insert command
285 14 Shuo Chen
286 78 Shuo Chen
12. wait for retrieval completion
287 1 Shuo Chen
288 84 Shuo Chen
13. if retrieval fails, go to step 27
289 1 Shuo Chen
290 78 Shuo Chen
14. store retrieved Data packet
291 20 Alex Afanasyev
292 84 Shuo Chen
15. abort these steps, insert process ends
293 1 Shuo Chen
294 84 Shuo Chen
16. if StartBlockId is missing, set StartBlockId 0. If EndBlockId is missing, EndBlockId will be missing unless get FinalBlockId in comming data packets, start EndBlockId Misiing Timeout timer.
295 14 Shuo Chen
296 78 Shuo Chen
17. append StartBlockId to Name
297 1 Shuo Chen
298 78 Shuo Chen
18. start to retrieve Name
299 14 Shuo Chen
300 78 Shuo Chen
19. wait for retrieval completion
301 14 Shuo Chen
302 81 Shuo Chen
20. if retrieval fails, go to step 26
303 14 Shuo Chen
304 78 Shuo Chen
21. store retrieved Data packet
305
306
22. if retrieved Data packet contains FinalBlockId, and FinalBlockId is less than EndBlockId or EndBlockId is missing, let EndBlockId be FinalBlockId
307
308 84 Shuo Chen
23. if the last component of Name is greater than or equal to EndBlockId, abort these steps, insert process ends
309 1 Shuo Chen
310 82 Shuo Chen
24. increment the last component of Name
311 15 Shuo Chen
312 82 Shuo Chen
25. go to step 17
313 1 Shuo Chen
314 84 Shuo Chen
26. retrieve data with this data another 2 times. If these 2 retrieval both failes, abort these steps. if success, go to step 20
315 15 Shuo Chen
316 84 Shuo Chen
27. retrieve data with this data another 2 times. If these 2 retrieval both failes, abort these steps. if success, go to step 13
317
318
If EndBlockId Missing Timeout timer starts, repo will monitor this timer during step 17~26. If this timeout occurs, abort insert command process immediately.
319 15 Shuo Chen
320 20 Alex Afanasyev
Implementation MAY pipeline the Interests.
321 1 Shuo Chen
322 85 Shuo Chen
### Repo insert check command progress
323 16 Shuo Chen
324 20 Alex Afanasyev
Implementation MAY publish a notification of status regarding insert progress. The process of status check is as follows:
325 18 Shuo Chen
326 110 Shuo Chen
1. start to authorize the insert status command, if fails go to 2, if success, go to 3
327 1 Shuo Chen
328 110 Shuo Chen
2. send a negative response indicating authorization failure, and abort these steps (StatusCode: 401)
329 18 Shuo Chen
330 20 Alex Afanasyev
3. start to check the progress of the insert with the data name in the command. If no such progress is found, go to 4. or go to 5.
331 18 Shuo Chen
332 110 Shuo Chen
4. reponse status with status code, abort check process. (StatusCode: 404)
333 18 Shuo Chen
334 110 Shuo Chen
5. ckeck the status of insertion. return the status of insertion progress. If a EndBlockId Missing Timeour timer is running, set this timer to 0. About check process. (StatusCode: 300)
335 20 Alex Afanasyev
336 17 Shuo Chen
### Protocol diagram:
337 10 Alex Afanasyev
338
    Requester                     Repo                          Data producer
339
        |                           |                                 |
340
        |                           |                                 |
341
      +---+  Insert command       +---+                               |
342
      |   | --------------------> |   |                               |
343
      +---+                       |   |                               |
344
        |                         |   |                               |
345
      +---+   Confirm start       |   |                               |
346
      |   | <==================== |   |                               |
347
      +---+   Reject command      +---+                               |
348
        |     (with status code)    |                                 |
349
        |                         +---+     Interest for Data       +---+
350 1 Shuo Chen
        |                         |   | --------------------------> |   |
351
        |                         +---+                             |   |
352 10 Alex Afanasyev
        |                           |                               |   |
353
        |                         +---+       Data segment          |   |
354
        |                         |   | <========================== |   |
355
        |                         +---+                             +---+
356
        |                           |                                 |
357
        |                           ~                                 ~
358
        |                           ~                                 ~
359
        |                           |                                 |
360
        |                         +---+     Interest for Data       +---+
361
        |                         |   | --------------------------> |   |
362
        |                         +---+                             |   |
363 1 Shuo Chen
        |                           |                               |   |
364
        |                         +---+       Data segment          |   |
365
        |                         |   | <========================== |   |
366
        |                         +---+                             +---+
367
        |                           |                                 |
368
        |                           |                                 |
369 17 Shuo Chen
        |                           ~                                 ~
370 1 Shuo Chen
        |                           ~                                 ~
371
        |                           |                                 |
372 30 Shuo Chen
        |                           |                                 |
373 19 Shuo Chen
        |                           |                                 |
374 30 Shuo Chen
      +---+   Status interest     +---+                               |
375 19 Shuo Chen
      |   | --------------------> |   |                               |
376
      +---+                       |   |                               |
377
        |                         |   |                               |
378
      +---+    Status response    |   |                               |
379
      |   | <==================== |   |                               |
380
      +---+                       +---+                               |
381
        |                           |                                 |
382
        |                           |                                 |
383
384
## Repo Deletion Specification
385
386 87 Shuo Chen
Deletion of one content object or content objects under certain prefix are both supported in repo specification. Selectors are used to select multiple content objects. These selectors are different from conventional [selectors](http://named-data.net/doc/ndn-tlv/interest.html#selectors) of interest packet. The conventional selecors of interest would select one data packet of repo. Selecors of delete command will return any data packets which applies for these selectors. Deletion of segmented data is also supported.
387 19 Shuo Chen
388
### Deletion command interest semantics
389
390 1 Shuo Chen
Deletion command interest follows the format of the repo command. For example:
391 19 Shuo Chen
392 94 Shuo Chen
    /ucla/cs/repo/delete/<RepoCommandParameter>/<timestamp>/<random-value>/<SignatureInfo>/<SignatureValue
393 19 Shuo Chen
394 88 Shuo Chen
### Deletion Command RepoCommandParameter
395
396 96 Shuo Chen
Format of deletion command RepoCommandParameter follows that of Repo Command. Name, Selector, StartBlockId, EndBlockId, ProcessId are used to construct RepoCommandParameter.
397 88 Shuo Chen
398 96 Shuo Chen
Name is the name or the prefix of data repo will delete.
399
400
Selector is used to select data.
401
402
StartBlockId and EndBlockId are used to delete segment data. Data of segment id between StartBlockId and EndBlockId will be deleted by repo.
403
404
ProcessId is a random number generated by client to indicate the deletion process. Repo will match this ProcessId with this deletion process.
405 88 Shuo Chen
406 19 Shuo Chen
### Deletion Command Selectors
407
408 39 Shuo Chen
Deletion command selectors follows the [repo command selectors](http://redmine.named-data.net/projects/repo-ng/wiki/Repo_Protocol_Specification#Repo-Command-Selectors).
409
410 19 Shuo Chen
### Deletion status check
411
412 30 Shuo Chen
During the deletion progress, the requester could send deletion status check command to check the status of the deletion progress. This status check command is also signed interest. The semantics of deletion status check command follows the format of repo command. ``<command verb>`` equals to ``delete check``. For example:
413 1 Shuo Chen
414 95 Shuo Chen
    /ucla/cs/repo/delete/<RepoCommandParameter>/<timestamp>/<random-value>/<SignatureInfo>/<SignatureValue>
415 19 Shuo Chen
416 97 Shuo Chen
### Deletion status check RepoCommandParameter
417
418
Name and ProcessId are used to indicate certain deletion process. Repo uses Name and ProcessId to match certain deletion process. If it matches, repo will respond progress of deletion. If just one of Name or ProcessId matches, it fails.
419
420 41 Shuo Chen
### Deletion Check Command Selectors
421
422
Selectors are not supported. Repo will ignore selectors when processing deletion status check command.
423
424 19 Shuo Chen
### Deletion status response
425
426 98 Shuo Chen
Deletion status response is used as response of repo deletion command and repo deletion check command.
427 1 Shuo Chen
428 99 Shuo Chen
Name, StatusCode, Selector, StartBlockId, EndBlockId, ProcessId, DeletenNum are used in deletion status response. Name, ProcessId, Selector is the same as that of delete command. StatusCode indicates the status of deletion. DeleteNum indicates how many data packets have been deleted.
429 98 Shuo Chen
430
In Repo Deletion Command, if just StartBlockId presents, EndBlockId may be the largest segment ID repo holds. If just EndBlockId presents, StartBlockId will be set 0
431 19 Shuo Chen
432
StatusCode Definition:
433
434
``StatusCode`` | Description
435
-------------- | --------------------------------------
436
``200``        | All the data has been deleted
437
``300``        | This deletion is in progress
438 104 Shuo Chen
``401``        | This deletion or deletion check is invalidated
439
``402``        | Selectors and BlockId both present
440 106 Shuo Chen
``403``        | Malformed Command
441 30 Shuo Chen
``404``        | No such this deletion is in progress
442 19 Shuo Chen
443 17 Shuo Chen
### Protocol process
444 1 Shuo Chen
445 101 Shuo Chen
1. start to authorize the command; if authorization does not fail, go to step 3
446 1 Shuo Chen
447 108 Shuo Chen
2. send a negative response indicating authorization failure, and abort these steps, end deletion process. (StatusCode: 401)
448 1 Shuo Chen
449 101 Shuo Chen
3. check whether a deletion process of same RepoCommandParameter exists, waiting for deletion process ends.
450 1 Shuo Chen
451 108 Shuo Chen
4. If selectors and one of StartBlockId and EndBlockId presents, send a negative response and abort these steps, end deletion process. (StatusCode: 402)
452 1 Shuo Chen
453 101 Shuo Chen
5. If selectors present, go to step 8
454 1 Shuo Chen
455 108 Shuo Chen
6. check whether StartBlockId or EndBlockId presents. If both presents but StartBlockId is larger than EndBlockId, return negative response and end deletion process. (StatusCode: 403) Or go to step 9
456 1 Shuo Chen
457 101 Shuo Chen
7. If StartBlockId, EndBlockId and selectors are all missing, go to step 10
458 1 Shuo Chen
459 101 Shuo Chen
8. delete all the data that conforms to the name and selectors, go to step 11
460
461
9. delete all the data packets of segment id between StartBlockId and EndBlockId. If StartBlockId is missing, StartBlockId is set to be 0. If EndBlockId is missing, EndBlockId is set to be the largest segment id that repo holds. go to step 11
462
463
10. delete data exact matches the name. got to step 11
464
465 108 Shuo Chen
11. If lifetime of interest does not expire, return status response of positive statuscode. If lifetime of interest has expired, wait for interest the same RepoCommandParameter and return this status response. End Deletion process. (StatusCode: 200)
466 101 Shuo Chen
467
Client will set deletion command with big lifetime. If life time expires, client will re-express the command.
468 19 Shuo Chen
469 21 Alex Afanasyev
Implementation MAY publish a notification of status regarding delete progress. The process of status check is as follows:
470 19 Shuo Chen
471 21 Alex Afanasyev
1. start to authorize the delete status command
472 19 Shuo Chen
473 108 Shuo Chen
2. send a negative response indicating authorization failure, and abort these steps (StatusCode: 401)
474 19 Shuo Chen
475 21 Alex Afanasyev
3. start to check the progress of the delete with the data name in the command. If no such progress is found, go to 4. or go to 5.
476 19 Shuo Chen
477 108 Shuo Chen
4. reponse status with status code of 404 (StatusCode: 404)
478 21 Alex Afanasyev
479 108 Shuo Chen
5. ckeck te status of delete. return the status data content (StatusCode: 300)
480 19 Shuo Chen
481
### Protocol diagram:
482
483
    Requester                     Repo 
484
        |                           |                                 
485
        |                           |                                 
486
      +---+  Delete command       +---+                               
487
      |   | --------------------> |   |                               
488
      +---+                       +---+                               
489
        |                           |                                 
490
        |                           |                                 
491
        |                           |                                 
492
      +---+   Status interest     +---+                               
493
      |   | --------------------> |   |                               
494
      +---+                       |   |                               
495
        |                         |   |                               
496
      +---+    Status response    |   |                               
497
      |   | <==================== |   |                               
498
      +---+                       +---+                               
499
        |                           |                                 
500
        |                           |                                 
501
        |                           |                                 
502
      +---+   Confirm Deletion    +---+                               
503
      |   | <==================== |   |                               
504
      +---+   Reject command      +---+                               
505
        |     (with status code)    |    
506 20 Alex Afanasyev
        |                           |