Project

General

Profile

Repo Protocol Specification » History » Version 89

Shuo Chen, 02/25/2014 02:42 PM

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
* ``<RepoCommandParameters>`` 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 30 Shuo Chen
    /ucla/cs/repo/<command verb>/<RepoCommandParameters>/<timestamp>/<random-value>/<SignatureInfo>/<SignatureValue>
69 14 Shuo Chen
70 30 Shuo Chen
### RepoCommandParameters
71 29 Shuo Chen
72 48 Shuo Chen
    RepoCommandParameters ::= REPOCOMMANDPARAMETERS-TYPE TLV-LENGTH
73 1 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 45 Shuo Chen
#### Name
113
114 50 Shuo Chen
Name in command parameter is TLV-encoded block and represents the name or prefix of the data repo will process. The definition and format of name section are the same as the [name section](http://named-data.net/doc/ndn-tlv/name.html#name) of NDN interest.
115 45 Shuo Chen
116 44 Shuo Chen
#### Repo Command Selectors
117 38 Shuo Chen
118 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.
119
120
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.
121 38 Shuo Chen
122 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.
123 38 Shuo Chen
124
The form of selectors is as follows:
125
126
    Selectors             ::= SELECTORS-TYPE TLV-LENGTH
127
                               MinSuffixComponents?
128
                               MaxSuffixComponents?
129
                               PublisherPublicKeyLocator?
130 1 Shuo Chen
                               Exclude?
131 51 Shuo Chen
                               ChildSelector?
132 38 Shuo Chen
    
133
    MinSuffixComponents   ::= MIN-SUFFIX-COMPONENTS-TYPE TLV-LENGTH
134
                               nonNegativeInteger
135
136
    MaxSuffixComponents   ::= MAX-SUFFIX-COMPONENTS-TYPE TLV-LENGTH
137
                               nonNegativeInteger
138
139
    PublisherPublicKeyLocator ::= KeyLocator
140
    
141
    Exclude               ::= EXCLUDE-TYPE TLV-LENGTH Any? (NameComponent (Any)?)+
142 1 Shuo Chen
    Any                   ::= ANY-TYPE TLV-LENGTH(=0)
143 51 Shuo Chen
144
    ChildSelector         ::= CHILD-SELECTOR-TYPE TLV-LENGTH
145
                               nonNegativeInteger
146 46 Shuo Chen
147
#### StartBlockId, EndBlockId
148 38 Shuo Chen
149 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.
150 62 Shuo Chen
151 68 Shuo Chen
#### Conflict of Selectors and StartBlockId, EndBlockId
152 67 Shuo Chen
153 89 Shuo Chen
Repo cannot process command with both selectors and StartBlockId, EndBlockId in RepoCommandParameters. If the RepoCommandParameter carries both, repo will ignore this command interest and return with error code of 405.
154 67 Shuo Chen
155 62 Shuo Chen
#### ProcessId
156 53 Shuo Chen
157 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.
158
159 30 Shuo Chen
## Repo Command Response
160 1 Shuo Chen
161 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.
162 1 Shuo Chen
163 30 Shuo Chen
    RepoCommandResponse   ::= INSERTSTATUS-TYPE TLV-LENGTH
164 61 Shuo Chen
                               ProcessId?
165 1 Shuo Chen
                               StatusCode?
166
                               StartBlockId?
167
                               EndBlockId?
168
                               InsertNum?
169 30 Shuo Chen
                               DeleteNum?
170 1 Shuo Chen
171 61 Shuo Chen
    ProcessId            ::= PROCESSID-TYPE TLV-LENGTH
172 55 Shuo Chen
                                nonNegativeInteger 
173
    
174 1 Shuo Chen
    StatusCode            ::= STATUSCODE-TYPE TLV-LENGTH
175
                                nonNegativeInteger    
176
177
    StartBlockId          ::= STARTBLOCKID-TYPE TLV-LENGTH
178
                                nonNegativeInteger
179
    
180
    EndBlockId            ::= ENDBLOCKID-TYPE TLV-LENGTH
181
                                nonNegativeInteger
182 17 Shuo Chen
183
    InsertNum             ::= INSERTNUM-TYPE TLV-LENGTH
184
                                nonNegativeInteger
185
186 30 Shuo Chen
    DeleteNum             ::= DELETENUM-TYPE TLV-LENGTH
187
                                nonNegativeInteger
188 17 Shuo Chen
189 61 Shuo Chen
### ProcessId
190
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.
191 59 Shuo Chen
192
### StatusCode
193
194 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.
195
196 59 Shuo Chen
### StartBlockId, EndBlockId
197
198 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.
199
200 59 Shuo Chen
### InsertNum, DeleteNum
201 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.
202 59 Shuo Chen
203 58 Shuo Chen
## Repo Trust Model
204 57 Shuo Chen
205
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.
206
207 30 Shuo Chen
## Repo Insertion Specification
208
209 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.
210 30 Shuo Chen
211
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.
212
213
### Insertion command interest semantics
214
215
The name semantics is follows the format of the repo command. The <command verb> is defined as ``insert``.
216 76 Shuo Chen
For example, for ``<repo prefix>`` as ``/ucla/cs/repo``, the following is an example:
217 1 Shuo Chen
218 31 Shuo Chen
    /ucla/cs/repo/insert/<RepoCommandParameters>/<timestamp>/<random-value>/<SignatureInfo>/<SignatureValue>
219 30 Shuo Chen
220
### Insertion status check
221
222
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:
223
224
<command verb> equals to ``insert check``. For example:
225 1 Shuo Chen
226
    /ucla/cs/repo/insert check/<RepoCommandParameters>/<timestamp>/<random-value>/<SignatureInfo>/<SignatureValue>
227 69 Shuo Chen
228
### RepoCommandParameter
229
230 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.
231 69 Shuo Chen
232 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.
233
234
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.
235 30 Shuo Chen
236
### Insertatation status response
237
238
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.
239
240 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.
241 30 Shuo Chen
242 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.
243 30 Shuo Chen
244 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.
245 30 Shuo Chen
246 1 Shuo Chen
StatusCode Definition:
247 17 Shuo Chen
248
``StatusCode`` | Description
249
-------------- | ----------------------------------------------
250 19 Shuo Chen
``100``        | The command is OK. can start to fetch the data
251
``200``        | All the data has been inserted
252 17 Shuo Chen
``300``        | This insertion is in progress
253
``401``        | This insertion check is invalidated
254
``404``        | No such this insertion is in progress
255 30 Shuo Chen
``505``        | status check command is not supported
256 17 Shuo Chen
257 83 Shuo Chen
### EndBlockId Missing Timeout
258
259
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.
260
261 22 Alex Afanasyev
### Protocol Process
262
263 20 Alex Afanasyev
1. start to authorize the command; if authorization does not fail immediately, go to step 3
264 17 Shuo Chen
265 84 Shuo Chen
2. send a negative response indicating authorization failure, and abort these steps, insert process ends
266 14 Shuo Chen
267 78 Shuo Chen
3. if  StartBlockId or EndBlockId is missing, go to step 7
268 14 Shuo Chen
269 84 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
270 14 Shuo Chen
271 78 Shuo Chen
5. if both StartBlockId and EndBlockId are present, and StartBlockId is less than or equal to EndBlockId, go to step 7
272 14 Shuo Chen
273 84 Shuo Chen
6. send a negative response indicating malformed command, and abort these steps, insert process ends
274 14 Shuo Chen
275 78 Shuo Chen
7. wait for authorization completion
276 14 Shuo Chen
277 78 Shuo Chen
8. if authorization fails, go to step 2
278 14 Shuo Chen
279 78 Shuo Chen
9. send a positive response indicating insert is in progress
280 14 Shuo Chen
281 78 Shuo Chen
10. if either StartBlockId or EndBlockId is present, go to step 16
282 14 Shuo Chen
283 78 Shuo Chen
11. start to retrieve Name with selectors in insert command
284 14 Shuo Chen
285 78 Shuo Chen
12. wait for retrieval completion
286 1 Shuo Chen
287 84 Shuo Chen
13. if retrieval fails, go to step 27
288 1 Shuo Chen
289 78 Shuo Chen
14. store retrieved Data packet
290 20 Alex Afanasyev
291 84 Shuo Chen
15. abort these steps, insert process ends
292 1 Shuo Chen
293 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.
294 14 Shuo Chen
295 78 Shuo Chen
17. append StartBlockId to Name
296 1 Shuo Chen
297 78 Shuo Chen
18. start to retrieve Name
298 14 Shuo Chen
299 78 Shuo Chen
19. wait for retrieval completion
300 14 Shuo Chen
301 81 Shuo Chen
20. if retrieval fails, go to step 26
302 14 Shuo Chen
303 78 Shuo Chen
21. store retrieved Data packet
304
305
22. if retrieved Data packet contains FinalBlockId, and FinalBlockId is less than EndBlockId or EndBlockId is missing, let EndBlockId be FinalBlockId
306
307 84 Shuo Chen
23. if the last component of Name is greater than or equal to EndBlockId, abort these steps, insert process ends
308 1 Shuo Chen
309 82 Shuo Chen
24. increment the last component of Name
310 15 Shuo Chen
311 82 Shuo Chen
25. go to step 17
312 1 Shuo Chen
313 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
314 15 Shuo Chen
315 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
316
317
If EndBlockId Missing Timeout timer starts, repo will monitor this timer during step 17~26. If this timeout occurs, abort insert command process immediately.
318 15 Shuo Chen
319 20 Alex Afanasyev
Implementation MAY pipeline the Interests.
320 1 Shuo Chen
321 85 Shuo Chen
### Repo insert check command progress
322 16 Shuo Chen
323 20 Alex Afanasyev
Implementation MAY publish a notification of status regarding insert progress. The process of status check is as follows:
324 18 Shuo Chen
325 20 Alex Afanasyev
1. start to authorize the insert status command
326 1 Shuo Chen
327 20 Alex Afanasyev
2. send a negative response indicating authorization failure, and abort these steps
328 18 Shuo Chen
329 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.
330 18 Shuo Chen
331 85 Shuo Chen
4. reponse status with status code, abort check process.
332 18 Shuo Chen
333 86 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.
334 20 Alex Afanasyev
335 17 Shuo Chen
### Protocol diagram:
336 10 Alex Afanasyev
337
    Requester                     Repo                          Data producer
338
        |                           |                                 |
339
        |                           |                                 |
340
      +---+  Insert command       +---+                               |
341
      |   | --------------------> |   |                               |
342
      +---+                       |   |                               |
343
        |                         |   |                               |
344
      +---+   Confirm start       |   |                               |
345
      |   | <==================== |   |                               |
346
      +---+   Reject command      +---+                               |
347
        |     (with status code)    |                                 |
348
        |                         +---+     Interest for Data       +---+
349 1 Shuo Chen
        |                         |   | --------------------------> |   |
350
        |                         +---+                             |   |
351 10 Alex Afanasyev
        |                           |                               |   |
352
        |                         +---+       Data segment          |   |
353
        |                         |   | <========================== |   |
354
        |                         +---+                             +---+
355
        |                           |                                 |
356
        |                           ~                                 ~
357
        |                           ~                                 ~
358
        |                           |                                 |
359
        |                         +---+     Interest for Data       +---+
360
        |                         |   | --------------------------> |   |
361
        |                         +---+                             |   |
362 1 Shuo Chen
        |                           |                               |   |
363
        |                         +---+       Data segment          |   |
364
        |                         |   | <========================== |   |
365
        |                         +---+                             +---+
366
        |                           |                                 |
367
        |                           |                                 |
368 17 Shuo Chen
        |                           ~                                 ~
369 1 Shuo Chen
        |                           ~                                 ~
370
        |                           |                                 |
371 30 Shuo Chen
        |                           |                                 |
372 19 Shuo Chen
        |                           |                                 |
373 30 Shuo Chen
      +---+   Status interest     +---+                               |
374 19 Shuo Chen
      |   | --------------------> |   |                               |
375
      +---+                       |   |                               |
376
        |                         |   |                               |
377
      +---+    Status response    |   |                               |
378
      |   | <==================== |   |                               |
379
      +---+                       +---+                               |
380
        |                           |                                 |
381
        |                           |                                 |
382
383
## Repo Deletion Specification
384
385 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.
386 19 Shuo Chen
387
### Deletion command interest semantics
388
389 1 Shuo Chen
Deletion command interest follows the format of the repo command. For example:
390 19 Shuo Chen
391
    /ucla/cs/repo/delete/<RepoCommandParameters>/<timestamp>/<random-value>/<SignatureInfo>/<SignatureValue>
392
393 88 Shuo Chen
### Deletion Command RepoCommandParameter
394
395
396
397 19 Shuo Chen
### Deletion Command Selectors
398
399 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).
400
401 19 Shuo Chen
### Deletion status check
402
403 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:
404 1 Shuo Chen
405 34 Shuo Chen
    /ucla/cs/repo/delete/<RepoCommandParameters>/<timestamp>/<random-value>/<SignatureInfo>/<SignatureValue>
406 19 Shuo Chen
407 41 Shuo Chen
### Deletion Check Command Selectors
408
409
Selectors are not supported. Repo will ignore selectors when processing deletion status check command.
410
411 19 Shuo Chen
### Deletion status response
412
413 30 Shuo Chen
This delete status data object could be the response data packet of both delete command and delete check command. The name of data packet is the same as that of command.The deletion status is enocoded as a TLV echoded block in content block in data packet. The TLV block format follows RepoCommandResponse.
414 19 Shuo Chen
415
StatusCode indicates the status of deletion. DeleteSum is the sum of the deletion. DeleteNum represents how many data has been deleted.
416
417
StatusCode Definition:
418
419
``StatusCode`` | Description
420
-------------- | --------------------------------------
421
``200``        | All the data has been deleted
422
``300``        | This deletion is in progress
423
``401``        | This deletion check is invalidated
424
``404``        | No such this deletion is in progress
425 30 Shuo Chen
``505``        | status check command is not supported
426 19 Shuo Chen
427 17 Shuo Chen
### Protocol process
428 1 Shuo Chen
429 21 Alex Afanasyev
1. start to authorize the command; if authorization does not fail immediately, go to step 3
430 1 Shuo Chen
431 21 Alex Afanasyev
2. send a negative response indicating authorization failure, and abort these steps
432 1 Shuo Chen
433 21 Alex Afanasyev
3. check whether selectors are presented. If selectors are presented, go to step 4, or select the data packet of the exact name of command. If some data is selected, go to step 6. If no data selected, go to step 5
434 1 Shuo Chen
435 21 Alex Afanasyev
4. select all the data packets that comforms to data name of the command and the selectors. If some data packets are selected, go to step 6. Or no data selected, go to step 5.
436 1 Shuo Chen
437 21 Alex Afanasyev
5. send a negative response and abort the delete transaction.
438 1 Shuo Chen
439 21 Alex Afanasyev
6. wait for authorization completion
440 1 Shuo Chen
441 21 Alex Afanasyev
7. if authorization fails, go to step 2
442 1 Shuo Chen
443 21 Alex Afanasyev
8. start to delete the selected data. If deletion success, return positive reponse, or return negative response and abort the deletion.
444 19 Shuo Chen
445 21 Alex Afanasyev
Implementation MAY publish a notification of status regarding delete progress. The process of status check is as follows:
446 19 Shuo Chen
447 21 Alex Afanasyev
1. start to authorize the delete status command
448 19 Shuo Chen
449 21 Alex Afanasyev
2. send a negative response indicating authorization failure, and abort these steps
450 19 Shuo Chen
451 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.
452 19 Shuo Chen
453 21 Alex Afanasyev
4. reponse status with status code of 404
454
455
5. ckeck te status of delete. return the status data content
456 19 Shuo Chen
457
### Protocol diagram:
458
459
    Requester                     Repo 
460
        |                           |                                 
461
        |                           |                                 
462
      +---+  Delete command       +---+                               
463
      |   | --------------------> |   |                               
464
      +---+                       +---+                               
465
        |                           |                                 
466
        |                           |                                 
467
        |                           |                                 
468
      +---+   Status interest     +---+                               
469
      |   | --------------------> |   |                               
470
      +---+                       |   |                               
471
        |                         |   |                               
472
      +---+    Status response    |   |                               
473
      |   | <==================== |   |                               
474
      +---+                       +---+                               
475
        |                           |                                 
476
        |                           |                                 
477
        |                           |                                 
478
      +---+   Confirm Deletion    +---+                               
479
      |   | <==================== |   |                               
480
      +---+   Reject command      +---+                               
481
        |     (with status code)    |    
482 20 Alex Afanasyev
        |                           |