Project

General

Profile

Repo Protocol Specification » History » Version 114

Shuo Chen, 02/27/2014 04:43 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 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 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 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.
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
170 61 Shuo Chen
    ProcessId            ::= PROCESSID-TYPE TLV-LENGTH
171 55 Shuo Chen
                                nonNegativeInteger 
172
    
173 1 Shuo Chen
    StatusCode            ::= STATUSCODE-TYPE TLV-LENGTH
174
                                nonNegativeInteger    
175
176
    StartBlockId          ::= STARTBLOCKID-TYPE TLV-LENGTH
177
                                nonNegativeInteger
178
    
179
    EndBlockId            ::= ENDBLOCKID-TYPE TLV-LENGTH
180
                                nonNegativeInteger
181 17 Shuo Chen
182
    InsertNum             ::= INSERTNUM-TYPE TLV-LENGTH
183
                                nonNegativeInteger
184
185 30 Shuo Chen
    DeleteNum             ::= DELETENUM-TYPE TLV-LENGTH
186
                                nonNegativeInteger
187 17 Shuo Chen
188 113 Shuo Chen
### Name
189
Name indicates the Name in repocommandparameter of repo command
190
191
192 61 Shuo Chen
### ProcessId
193
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.
194 59 Shuo Chen
195
### StatusCode
196
197 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.
198
199 59 Shuo Chen
### StartBlockId, EndBlockId
200
201 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.
202
203 59 Shuo Chen
### InsertNum, DeleteNum
204 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.
205 59 Shuo Chen
206 58 Shuo Chen
## Repo Trust Model
207 57 Shuo Chen
208
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.
209
210 30 Shuo Chen
## Repo Insertion Specification
211
212 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.
213 30 Shuo Chen
214
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.
215
216
### Insertion command interest semantics
217
218
The name semantics is follows the format of the repo command. The <command verb> is defined as ``insert``.
219 76 Shuo Chen
For example, for ``<repo prefix>`` as ``/ucla/cs/repo``, the following is an example:
220 1 Shuo Chen
221 92 Shuo Chen
    /ucla/cs/repo/insert/<RepoCommandParameter>/<timestamp>/<random-value>/<SignatureInfo>/<SignatureValue>
222 30 Shuo Chen
223
### Insertion status check
224
225
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:
226
227
<command verb> equals to ``insert check``. For example:
228 1 Shuo Chen
229 93 Shuo Chen
    /ucla/cs/repo/insert check/<RepoCommandParameter>/<timestamp>/<random-value>/<SignatureInfo>/<SignatureValue>
230 69 Shuo Chen
231
### RepoCommandParameter
232
233 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.
234 69 Shuo Chen
235 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.
236
237
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.
238 30 Shuo Chen
239
### Insertatation status response
240
241
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.
242
243 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.
244 30 Shuo Chen
245 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.
246 30 Shuo Chen
247 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.
248 30 Shuo Chen
249 1 Shuo Chen
StatusCode Definition:
250 17 Shuo Chen
251
``StatusCode`` | Description
252
-------------- | ----------------------------------------------
253 19 Shuo Chen
``100``        | The command is OK. can start to fetch the data
254
``200``        | All the data has been inserted
255 17 Shuo Chen
``300``        | This insertion is in progress
256 102 Shuo Chen
``401``        | This insertion command or insertion check command is invalidated
257
``402``        | Selectors and BlockId both present
258 105 Shuo Chen
``403``        | Malformed Command
259 17 Shuo Chen
``404``        | No such this insertion is in progress
260 102 Shuo Chen
``405``        | EndBlockId Missing Timeout
261 17 Shuo Chen
262 83 Shuo Chen
### EndBlockId Missing Timeout
263
264
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.
265
266 22 Alex Afanasyev
### Protocol Process
267
268 20 Alex Afanasyev
1. start to authorize the command; if authorization does not fail immediately, go to step 3
269 17 Shuo Chen
270 107 Shuo Chen
2. send a negative response indicating authorization failure, and abort these steps, insert process ends (StatusCode: 401)
271 14 Shuo Chen
272 100 Shuo Chen
3. if  both StartBlockId and EndBlockId are missing, go to step 7
273 14 Shuo Chen
274 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)
275 14 Shuo Chen
276 78 Shuo Chen
5. if both StartBlockId and EndBlockId are present, and StartBlockId is less than or equal to EndBlockId, go to step 7
277 14 Shuo Chen
278 107 Shuo Chen
6. send a negative response indicating malformed command, and abort these steps, insert process ends (StatusCode: 403)
279 14 Shuo Chen
280 78 Shuo Chen
7. wait for authorization completion
281 14 Shuo Chen
282 107 Shuo Chen
8. if authorization fails, go to step 2 (StatusCode: 401)
283 14 Shuo Chen
284 107 Shuo Chen
9. send a positive response indicating insert is in progress (StatusCode: 200)
285 14 Shuo Chen
286 78 Shuo Chen
10. if either StartBlockId or EndBlockId is present, go to step 16
287 14 Shuo Chen
288 78 Shuo Chen
11. start to retrieve Name with selectors in insert command
289 14 Shuo Chen
290 78 Shuo Chen
12. wait for retrieval completion
291 1 Shuo Chen
292 84 Shuo Chen
13. if retrieval fails, go to step 27
293 1 Shuo Chen
294 78 Shuo Chen
14. store retrieved Data packet
295 20 Alex Afanasyev
296 84 Shuo Chen
15. abort these steps, insert process ends
297 1 Shuo Chen
298 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.
299 14 Shuo Chen
300 78 Shuo Chen
17. append StartBlockId to Name
301 1 Shuo Chen
302 78 Shuo Chen
18. start to retrieve Name
303 14 Shuo Chen
304 78 Shuo Chen
19. wait for retrieval completion
305 14 Shuo Chen
306 81 Shuo Chen
20. if retrieval fails, go to step 26
307 14 Shuo Chen
308 78 Shuo Chen
21. store retrieved Data packet
309
310
22. if retrieved Data packet contains FinalBlockId, and FinalBlockId is less than EndBlockId or EndBlockId is missing, let EndBlockId be FinalBlockId
311
312 84 Shuo Chen
23. if the last component of Name is greater than or equal to EndBlockId, abort these steps, insert process ends
313 1 Shuo Chen
314 82 Shuo Chen
24. increment the last component of Name
315 15 Shuo Chen
316 82 Shuo Chen
25. go to step 17
317 1 Shuo Chen
318 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
319 15 Shuo Chen
320 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
321
322
If EndBlockId Missing Timeout timer starts, repo will monitor this timer during step 17~26. If this timeout occurs, abort insert command process immediately.
323 15 Shuo Chen
324 20 Alex Afanasyev
Implementation MAY pipeline the Interests.
325 1 Shuo Chen
326 85 Shuo Chen
### Repo insert check command progress
327 16 Shuo Chen
328 20 Alex Afanasyev
Implementation MAY publish a notification of status regarding insert progress. The process of status check is as follows:
329 18 Shuo Chen
330 110 Shuo Chen
1. start to authorize the insert status command, if fails go to 2, if success, go to 3
331 1 Shuo Chen
332 110 Shuo Chen
2. send a negative response indicating authorization failure, and abort these steps (StatusCode: 401)
333 18 Shuo Chen
334 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.
335 18 Shuo Chen
336 110 Shuo Chen
4. reponse status with status code, abort check process. (StatusCode: 404)
337 18 Shuo Chen
338 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)
339 20 Alex Afanasyev
340 17 Shuo Chen
### Protocol diagram:
341 10 Alex Afanasyev
342
    Requester                     Repo                          Data producer
343
        |                           |                                 |
344
        |                           |                                 |
345
      +---+  Insert command       +---+                               |
346
      |   | --------------------> |   |                               |
347
      +---+                       |   |                               |
348
        |                         |   |                               |
349
      +---+   Confirm start       |   |                               |
350
      |   | <==================== |   |                               |
351
      +---+   Reject command      +---+                               |
352
        |     (with status code)    |                                 |
353
        |                         +---+     Interest for Data       +---+
354 1 Shuo Chen
        |                         |   | --------------------------> |   |
355
        |                         +---+                             |   |
356 10 Alex Afanasyev
        |                           |                               |   |
357
        |                         +---+       Data segment          |   |
358
        |                         |   | <========================== |   |
359
        |                         +---+                             +---+
360
        |                           |                                 |
361
        |                           ~                                 ~
362
        |                           ~                                 ~
363
        |                           |                                 |
364
        |                         +---+     Interest for Data       +---+
365
        |                         |   | --------------------------> |   |
366
        |                         +---+                             |   |
367 1 Shuo Chen
        |                           |                               |   |
368
        |                         +---+       Data segment          |   |
369
        |                         |   | <========================== |   |
370
        |                         +---+                             +---+
371
        |                           |                                 |
372
        |                           |                                 |
373 17 Shuo Chen
        |                           ~                                 ~
374 1 Shuo Chen
        |                           ~                                 ~
375
        |                           |                                 |
376 30 Shuo Chen
        |                           |                                 |
377 19 Shuo Chen
        |                           |                                 |
378 30 Shuo Chen
      +---+   Status interest     +---+                               |
379 19 Shuo Chen
      |   | --------------------> |   |                               |
380
      +---+                       |   |                               |
381
        |                         |   |                               |
382
      +---+    Status response    |   |                               |
383
      |   | <==================== |   |                               |
384
      +---+                       +---+                               |
385
        |                           |                                 |
386
        |                           |                                 |
387
388
## Repo Deletion Specification
389
390 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.
391 19 Shuo Chen
392
### Deletion command interest semantics
393
394 1 Shuo Chen
Deletion command interest follows the format of the repo command. For example:
395 19 Shuo Chen
396 94 Shuo Chen
    /ucla/cs/repo/delete/<RepoCommandParameter>/<timestamp>/<random-value>/<SignatureInfo>/<SignatureValue
397 19 Shuo Chen
398 88 Shuo Chen
### Deletion Command RepoCommandParameter
399
400 96 Shuo Chen
Format of deletion command RepoCommandParameter follows that of Repo Command. Name, Selector, StartBlockId, EndBlockId, ProcessId are used to construct RepoCommandParameter.
401 88 Shuo Chen
402 96 Shuo Chen
Name is the name or the prefix of data repo will delete.
403
404
Selector is used to select data.
405
406
StartBlockId and EndBlockId are used to delete segment data. Data of segment id between StartBlockId and EndBlockId will be deleted by repo.
407
408
ProcessId is a random number generated by client to indicate the deletion process. Repo will match this ProcessId with this deletion process.
409 88 Shuo Chen
410 19 Shuo Chen
### Deletion Command Selectors
411
412 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).
413
414 19 Shuo Chen
### Deletion status check
415
416 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:
417 1 Shuo Chen
418 95 Shuo Chen
    /ucla/cs/repo/delete/<RepoCommandParameter>/<timestamp>/<random-value>/<SignatureInfo>/<SignatureValue>
419 19 Shuo Chen
420 97 Shuo Chen
### Deletion status check RepoCommandParameter
421
422
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.
423
424 41 Shuo Chen
### Deletion Check Command Selectors
425
426
Selectors are not supported. Repo will ignore selectors when processing deletion status check command.
427
428 19 Shuo Chen
### Deletion status response
429
430 98 Shuo Chen
Deletion status response is used as response of repo deletion command and repo deletion check command.
431 1 Shuo Chen
432 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.
433 98 Shuo Chen
434
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
435 19 Shuo Chen
436
StatusCode Definition:
437
438
``StatusCode`` | Description
439
-------------- | --------------------------------------
440
``200``        | All the data has been deleted
441
``300``        | This deletion is in progress
442 104 Shuo Chen
``401``        | This deletion or deletion check is invalidated
443
``402``        | Selectors and BlockId both present
444 106 Shuo Chen
``403``        | Malformed Command
445 30 Shuo Chen
``404``        | No such this deletion is in progress
446 19 Shuo Chen
447 17 Shuo Chen
### Protocol process
448 1 Shuo Chen
449 101 Shuo Chen
1. start to authorize the command; if authorization does not fail, go to step 3
450 1 Shuo Chen
451 108 Shuo Chen
2. send a negative response indicating authorization failure, and abort these steps, end deletion process. (StatusCode: 401)
452 1 Shuo Chen
453 101 Shuo Chen
3. check whether a deletion process of same RepoCommandParameter exists, waiting for deletion process ends.
454 1 Shuo Chen
455 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)
456 1 Shuo Chen
457 101 Shuo Chen
5. If selectors present, go to step 8
458 1 Shuo Chen
459 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
460 1 Shuo Chen
461 101 Shuo Chen
7. If StartBlockId, EndBlockId and selectors are all missing, go to step 10
462 1 Shuo Chen
463 101 Shuo Chen
8. delete all the data that conforms to the name and selectors, go to step 11
464
465
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
466
467
10. delete data exact matches the name. got to step 11
468
469 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)
470 101 Shuo Chen
471
Client will set deletion command with big lifetime. If life time expires, client will re-express the command.
472 19 Shuo Chen
473 21 Alex Afanasyev
Implementation MAY publish a notification of status regarding delete progress. The process of status check is as follows:
474 19 Shuo Chen
475 21 Alex Afanasyev
1. start to authorize the delete status command
476 19 Shuo Chen
477 108 Shuo Chen
2. send a negative response indicating authorization failure, and abort these steps (StatusCode: 401)
478 19 Shuo Chen
479 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.
480 19 Shuo Chen
481 108 Shuo Chen
4. reponse status with status code of 404 (StatusCode: 404)
482 21 Alex Afanasyev
483 108 Shuo Chen
5. ckeck te status of delete. return the status data content (StatusCode: 300)
484 19 Shuo Chen
485
### Protocol diagram:
486
487
    Requester                     Repo 
488
        |                           |                                 
489
        |                           |                                 
490
      +---+  Delete command       +---+                               
491
      |   | --------------------> |   |                               
492
      +---+                       +---+                               
493
        |                           |                                 
494
        |                           |                                 
495
        |                           |                                 
496
      +---+   Status interest     +---+                               
497
      |   | --------------------> |   |                               
498
      +---+                       |   |                               
499
        |                         |   |                               
500
      +---+    Status response    |   |                               
501
      |   | <==================== |   |                               
502
      +---+                       +---+                               
503
        |                           |                                 
504
        |                           |                                 
505
        |                           |                                 
506
      +---+   Confirm Deletion    +---+                               
507
      |   | <==================== |   |                               
508
      +---+   Reject command      +---+                               
509
        |     (with status code)    |    
510 20 Alex Afanasyev
        |                           |