-
Notifications
You must be signed in to change notification settings - Fork 0
/
SPEC-COMPLIANCE
271 lines (248 loc) · 10.8 KB
/
SPEC-COMPLIANCE
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
This document exists to keep track of which parts of XEP-0060
pubsubclient implements. This is useful for developers wanting to know
which bits work, and for contributors wanting to know which areas need
improving.
The format is as follows:
Section number. Section name: Pubsubclient support
Current spec at time of writing: 1.12 (2008-09-03)
------------------------------------------------------------------------
1. Introduction:
1.1. Overview:
1.2. How It Works:
2. Glossary:
3. Requirements:
4. Preliminaries:
4.1. Affiliations:
4.2. Subscription States:
4.3. Event Types:
4.4. Node Types:
4.5. Node Access Models:
4.6. Addressing:
4.6.1. JID:
4.6.2. JID+NodeID:
5. Entity Use Cases:
5.1. Discover Features: NO HANDLER
5.2. Discover Nodes: Implemented as pubsubclient.get_nodes
5.3. Discover Node Information: Implemented as pubsubclient.
5.4. Discover Node Meta-Data: Implemented as pubsubclient.
5.5. Discover Items for a Node: Implemented as Node.get_items
5.6. Retrieve Subscriptions: Implemented as pubsubclient.retrieve_subscriptions
5.7. Retrieve Affiliations: NO HANDLER
6. Subscriber Use Cases:
6.1. Subscribe to a Node: Implemented in Node.subscribe and pubsubclient.subscribe
6.1.1. Request: Node.subscribe and pubsubclient.subscribe
6.1.2. Success Case: NO HANDLER
6.1.3. Error Cases: NO HANDLER
6.1.3.1. JIDs Do Not Match: NO HANDLER
6.1.3.2. Presence Subscription Required: NO HANDLER
6.1.3.3. Not in Roster Group: NO HANDLER
6.1.3.4. Not on Whitelist: NO HANDLER
6.1.3.5. Payment Required: NO HANDLER
6.1.3.6. Anonymous Subscriptions Not Allowed: NO HANDLER
6.1.3.7. Subscription Pending: NO HANDLER
6.1.3.8. Blocked: NO HANDLER
6.1.3.9. Subscriptions Not Supported: NO HANDLER
6.1.3.10. Node Has Moved: NO HANDLER
6.1.3.11. Node Does Not Exist: NO HANDLER
6.1.4. Approval Required: NO HANDLER
6.1.5. Configuration Required: NO HANDLER
6.1.6. Multiple Subscriptions: NO HANDLER
6.1.7. Receiving the Last Published Item: NO HANDLER
6.2. Unsubscribe from a Node: Implemented in pubsubclient.unsubscribe
6.2.1. Request: Implemented in pubsubclient.unsubscribe
6.2.2. Success Case: NO HANDLER
6.2.3. Error Cases: NO HANDLER
6.2.3.1. No Subscription ID: NO HANDLER
6.2.3.2. No Such Subscriber: NO HANDLER
6.2.3.3. Insufficient Privileges: NO HANDLER
6.2.3.4. Node Does Not Exist: NO HANDLER
6.2.3.5. Bad Subscription ID: NO HANDLER
6.3. Configure Subscription Options: NO HANDLER
6.3.1. Advertising Support: NO HANDLER
6.3.2. Request: NO HANDLER
6.3.3. Success Case: NO HANDLER
6.3.4. Error Cases: NO HANDLER
6.3.4.1. Insufficient Privileges: NO HANDLER
6.3.4.2. No Such Subscriber: NO HANDLER
6.3.4.3. NodeID Required: NO HANDLER
6.3.4.4. Subscription ID Required: NO HANDLER
6.3.4.5. Invalid Subscription ID: NO HANDLER
6.3.4.6. Subscription Options Not Supported: NO HANDLER
6.3.4.7. Node Does Not Exist: NO HANDLER
6.3.5. Form Submission: NO HANDLER
6.3.6. Form Processing: NO HANDLER
6.3.6.1. Success: NO HANDLER
6.3.6.2. Failure: NO HANDLER
6.3.7. Subscribe and Configure: NO HANDLER
6.4. Retrieve Items from a Node: Implemented in Node.get_items and pubsubclient.request_items_generic
6.4.1. Permissions: NO HANDLER
6.4.2. Requesting All Items: NO HANDLER
6.4.3. Returning All Items: NO HANDLER
6.4.4. Returning Some Items: NO HANDLER
6.4.5. Returning the Last Published Item: NO HANDLER
6.4.6. Returning Notifications Only: NO HANDLER
6.4.7. Requesting Some Items: NO HANDLER
6.4.8. Error Cases: NO HANDLER
6.4.8.1. Subscription ID Required: NO HANDLER
6.4.8.2. Invalid Subscription ID: NO HANDLER
6.4.8.3. Entity Not Subscribed: NO HANDLER
6.4.8.4. Persistent Items Not Supported: NO HANDLER
6.4.8.5. Item Retrieval Not Supported: NO HANDLER
6.4.8.6. Presence Subscription Required: NO HANDLER
6.4.8.7. Not in Roster Group: NO HANDLER
6.4.8.8. Not on Whitelist: NO HANDLER
6.4.8.9. Payment Required: NO HANDLER
6.4.8.10. Blocked: NO HANDLER
6.4.8.11. Node Does Not Exist: NO HANDLER
7. Publisher Use Cases:
7.1. Publish an Item to a Node: NO HANDLER
7.1.1. Request: NO HANDLER
7.1.2. Success Case: NO HANDLER
7.1.2.1. Notification With Payload: NO HANDLER
7.1.2.2. Notification Without Payload: NO HANDLER
7.1.2.3. Inclusion of Subscription ID: NO HANDLER
7.1.3. Error Cases: NO HANDLER
7.1.3.1. Insufficient Privileges: NO HANDLER
7.1.3.2. Item Publication Not Supported: NO HANDLER
7.1.3.3. Node Does Not Exist: NO HANDLER
7.1.3.4. Payload Too Big: NO HANDLER
7.1.3.5. Bad Payload: NO HANDLER
7.1.3.6. Request Does Not Match Configuration: NO HANDLER
7.1.4. Automatic Node Creation: NO HANDLER
7.1.5. Publishing Options: NO HANDLER
7.2. Delete an Item from a Node: NO HANDLER
7.2.1. Request: NO HANDLER
7.2.2. Success Case: NO HANDLER
7.2.2.1. Delete And Notify: NO HANDLER
7.2.2.2. Inclusion of Subscription ID: NO HANDLER
7.2.3. Error Cases: NO HANDLER
7.2.3.1. Insufficient Privileges: NO HANDLER
7.2.3.2. Node Does Not Exist: NO HANDLER
7.2.3.3. NodeID Required: NO HANDLER
7.2.3.4. Item or ItemID Required: NO HANDLER
7.2.3.5. Persistent Items Not Supported: NO HANDLER
7.2.3.6. Item Deletion Not Supported: NO HANDLER
8. Owner Use Cases:
8.1. Create a Node: NO HANDLER
8.1.1. General Considerations: NO HANDLER
8.1.2. Create a Node With Default Configuration: NO HANDLER
8.1.3. Create and Configure a Node: NO HANDLER
8.2. Configure a Node: NO HANDLER
8.2.1. Request: NO HANDLER
8.2.2. Success Case: NO HANDLER
8.2.3. Error Cases: NO HANDLER
8.2.3.1. Node Configuration Not Supported: NO HANDLER
8.2.3.2. Insufficient Privileges: NO HANDLER
8.2.3.3. NodeID Required: NO HANDLER
8.2.3.4. No Configuration Options: NO HANDLER
8.2.4. Form Submission: NO HANDLER
8.2.5. Form Processing: NO HANDLER
8.2.5.1. Success: NO HANDLER
8.2.5.2. Failure: NO HANDLER
8.2.5.3. Success With Notifications: NO HANDLER
8.3. Request Default Configuration Options: NO HANDLER
8.3.1. Request: NO HANDLER
8.3.2. Success Case: NO HANDLER
8.3.3. Error Cases: NO HANDLER
8.3.3.1. Node Configuration Not Supported: NO HANDLER
8.3.3.2. Default Configuration Retrieval Not Supported: NO HANDLER
8.4. Delete a Node: Implemented as pubsubclient.delete_a_node
8.4.1. Request: Implemented as pubsubclient.delete_a_node
8.4.2. Success Case: Runs return_function with True
8.4.3. Error Cases: Runs return_function with False
8.4.3.1. Insufficient Privileges: Runs return_function with False
8.4.3.2. Node Does Not Exist: Runs return_function with False
8.5. Purge All Node Items: Implemented in pubsubclient.purge_all_items_from_a_node
8.5.1. Request: Implemented in pubsubclient.purge_all_items_from_a_node
8.5.2. Success Case: Only prints reply
8.5.3. Error Cases: Only prints reply
8.5.3.1. Node Purging Not Supported: Only prints reply
8.5.3.2. Insufficient Privileges: Only prints reply
8.5.3.3. Node Does Not Persist Items: Only prints reply
8.5.3.4. Node Does Not Exist: Only prints reply
8.6. Manage Subscription Requests: NO HANDLER
8.7. Process Pending Subscription Requests: NO HANDLER
8.7.1. Request: NO HANDLER
8.7.2. Success Case: NO HANDLER
8.7.3. Error Cases: NO HANDLER
8.7.3.1. Ad-Hoc Commands Not Supported: NO HANDLER
8.7.3.2. Get-Pending Not Supported: NO HANDLER
8.7.3.3. Insufficient Privileges: NO HANDLER
8.7.3.4. Node Does Not Exist: NO HANDLER
8.7.4. Per-Node Request: NO HANDLER (Bug in spec?)
8.8. Manage Subscriptions: NO HANDLER
8.8.1. Retrieve Subscriptions List: NO HANDLER
8.8.1.1. Request: NO HANDLER
8.8.1.2. Success Case: NO HANDLER
8.8.1.3. Error Cases: NO HANDLER
8.8.2. Modify Subscriptions: NO HANDLER
8.8.2.1. Request: NO HANDLER
8.8.2.2. Success Case: NO HANDLER
8.8.2.3. Error Cases: NO HANDLER
8.8.2.4. Multiple Simultaneous Modifications: NO HANDLER
8.8.3. Delete a Subscriber: NO HANDLER
8.8.4. Notifying Subscribers: NO HANDLER
8.9. Manage Affiliations: NO HANDLER
8.9.1. Retrieve Affiliations List: NO HANDLER
8.9.1.1. Request: NO HANDLER
8.9.1.2. Success Case: NO HANDLER
8.9.1.3. Error Cases: NO HANDLER
8.9.2. Modify Affiliation: NO HANDLER
8.9.2.1. Request: NO HANDLER
8.9.2.2. Success Case: NO HANDLER
8.9.2.3. Error Cases: NO HANDLER
8.9.2.4. Multiple Simultaneous Modifications: NO HANDLER
8.9.3. Delete an Entity: NO HANDLER
8.9.4. Notifying Entities: NO HANDLER
9. IM Account Integration: NO HANDLER
9.1. Auto-Subscribe: NO HANDLER
9.1.1. Account Owner: NO HANDLER
9.1.2. Presence Subscriber: NO HANDLER
9.1.3. Presence Sharer: NO HANDLER
9.2. Filtered Notifications: NO HANDLER
10. Feature Summary:
11. Error Conditions:
12. Implementation Notes:
12.1. Notification Triggers:
12.2. Intended Recipients for Notifications:
12.3. Handling Notification-Related Errors:
12.4. Presence-Based Delivery of Events:
12.5. Not Routing Events to Offline Storage:
12.6. Including a Message Body:
12.7. Node ID and Item ID Uniqueness:
12.8. Item Caching:
12.9. Batch Processing:
12.10. Auto-Subscribing Owners and Publishers:
12.11. Authorizing Subscription Requests (Pending Subscribers):
12.12. Notification of Subscription State Changes:
12.13. NodeID Semantics:
12.14. Multiple Node Discovery:
12.15. Inclusion of SHIM Headers:
12.16. Associating Events and Payloads with the Generating Entity:
12.17. Chaining:
12.18. Time-Based Subscriptions (Leases):
12.19. Content-Based Pubsub Systems:
12.20. Singleton Nodes:
13. Internationalization Considerations:
13.1. Field Labels:
14. Security Considerations:
15. IANA Considerations:
16. XMPP Registrar Considerations:
16.1. Protocol Namespaces:
16.2. Service Discovery Category/Type:
16.3. Service Discovery Features:
16.4. Field Standardization:
16.4.1. pubsub#subscribe_authorization FORM_TYPE:
16.4.2. pubsub#subscribe_options FORM_TYPE:
16.4.3. pubsub#node_config FORM_TYPE:
16.4.4. pubsub#meta-data FORM_TYPE:
16.4.5. pubsub#publish-options FORM_TYPE:
16.5. SHIM Headers:
16.6. URI Query Types:
17. XML Schemas:
17.1. http://jabber.org/protocol/pubsub:
17.2. http://jabber.org/protocol/pubsub#errors:
17.3. http://jabber.org/protocol/pubsub#event:
17.4. http://jabber.org/protocol/pubsub#owner:
18. Acknowledgements:
19. Author Note: