SipPayloadsApi
Version 26 (Adrian Georgescu, 08/07/2012 08:51 pm)
1 | 25 | Adrian Georgescu | h1. SIMPLE Payloads API |
---|---|---|---|
2 | 1 | Adrian Georgescu | |
3 | 24 | Adrian Georgescu | These applications provide functionality that are required for implementing |
4 | 24 | Adrian Georgescu | a feature-rich SIP SIMPLE client. |
5 | 1 | Adrian Georgescu | |
6 | 24 | Adrian Georgescu | These applications are used for parsing and generating bodies carried using |
7 | 24 | Adrian Georgescu | PUBLISH, SUBSCRIBE and NOTIFY methods designed for asynchronous event |
8 | 24 | Adrian Georgescu | notifications, to convey in near real-time, information between SIP |
9 | 24 | Adrian Georgescu | end-points. |
10 | 24 | Adrian Georgescu | |
11 | 24 | Adrian Georgescu | An example of such information is presence, which in its basic form it |
12 | 24 | Adrian Georgescu | provides user availability information based on end-user choice. In its |
13 | 24 | Adrian Georgescu | advanced form, presence can provide rich state information including but not |
14 | 24 | Adrian Georgescu | limited to user mood, geo-location, environment, noise level and the type of |
15 | 24 | Adrian Georgescu | communication desired. The information can be disseminated based on a |
16 | 24 | Adrian Georgescu | granular policy which allows end-users to decide who has access to which |
17 | 24 | Adrian Georgescu | part of the published information. |
18 | 1 | Adrian Georgescu | |
19 | 21 | Adrian Georgescu | h2. Address Book |
20 | 1 | Adrian Georgescu | |
21 | 21 | Adrian Georgescu | source:sipsimple/addressbook.py |
22 | 21 | Adrian Georgescu | |
23 | 18 | Adrian Georgescu | High-level implementation of an addressbook stored in XCAP documents. The |
24 | 18 | Adrian Georgescu | contacts, groups and their attributes are stored in resource lists and OMA |
25 | 18 | Adrian Georgescu | extensions described in OMA-TS-Presence_SIMPLE_XDM are used for describing |
26 | 18 | Adrian Georgescu | policy and RLS services by references to resource lists. Multiple client |
27 | 1 | Adrian Georgescu | instances can synchronize this addressbook using XCAP-diff event package. |
28 | 1 | Adrian Georgescu | |
29 | 21 | Adrian Georgescu | h2. Watcher Info |
30 | 1 | Adrian Georgescu | |
31 | 1 | Adrian Georgescu | Described in RFC3857 and RFC3858. |
32 | 1 | Adrian Georgescu | |
33 | 21 | Adrian Georgescu | source:sipsimple/payloads/watcherinfo.py |
34 | 21 | Adrian Georgescu | |
35 | 18 | Adrian Georgescu | Parses NOTIFY body for presence.winfo event. Used for keeping track of |
36 | 18 | Adrian Georgescu | watchers that subscribed to our presentity. Based on this information the |
37 | 18 | Adrian Georgescu | the user can manage its presence policy. To retrieve this information the |
38 | 1 | Adrian Georgescu | SIP client must subscribe to its own address for event presence.winfo. |
39 | 1 | Adrian Georgescu | |
40 | 21 | Adrian Georgescu | h2. Resource Lists |
41 | 1 | Adrian Georgescu | |
42 | 1 | Adrian Georgescu | Described in RFC4826. |
43 | 18 | Adrian Georgescu | |
44 | 21 | Adrian Georgescu | source:sipsimple/payloads/resourcelists.py |
45 | 21 | Adrian Georgescu | |
46 | 18 | Adrian Georgescu | Parses and generates XML documents for constructing resource lists |
47 | 18 | Adrian Georgescu | documents. Used for server side storage of presence related buddy lists |
48 | 18 | Adrian Georgescu | using XCAP protocol. The SIP clients maintain the resource-lists on the |
49 | 1 | Adrian Georgescu | XCAP server which provides persisten storage and aggregation point for |
50 | 18 | Adrian Georgescu | multiple devices. |
51 | 1 | Adrian Georgescu | |
52 | 1 | Adrian Georgescu | |
53 | 21 | Adrian Georgescu | h2. RLS Services |
54 | 1 | Adrian Georgescu | |
55 | 21 | Adrian Georgescu | Described in RFC4826. |
56 | 21 | Adrian Georgescu | |
57 | 21 | Adrian Georgescu | source:sipsimple/payloads/rlsservices.py |
58 | 21 | Adrian Georgescu | |
59 | 18 | Adrian Georgescu | Parses and generates XML documents for constructing rls-services documents. |
60 | 18 | Adrian Georgescu | Used for delegating presence related works to the server. The client build |
61 | 18 | Adrian Georgescu | rls-services lists with buddies and instructs the server to subscribe to the |
62 | 1 | Adrian Georgescu | sip uris indicated in the lists. This way the client can save bandwidth as |
63 | 18 | Adrian Georgescu | the server performs the signalling for subscription and collection of |
64 | 1 | Adrian Georgescu | notifications and provides consolidated answer to the sip user agent. |
65 | 1 | Adrian Georgescu | |
66 | 1 | Adrian Georgescu | |
67 | 21 | Adrian Georgescu | h2. RLS Notifications |
68 | 1 | Adrian Georgescu | |
69 | 1 | Adrian Georgescu | * source:sipsimple/payloads/rlmi.py |
70 | 21 | Adrian Georgescu | * source:sipsimple/payloads/rlsnotify.py |
71 | 21 | Adrian Georgescu | |
72 | 22 | Adrian Georgescu | Described in RFC4482 |
73 | 1 | Adrian Georgescu | |
74 | 1 | Adrian Georgescu | Document handling for NOTIFY body for Resource Lists Contact Information. |
75 | 21 | Adrian Georgescu | |
76 | 22 | Adrian Georgescu | h2. Policy |
77 | 1 | Adrian Georgescu | |
78 | 22 | Adrian Georgescu | Described in RFC4745 |
79 | 22 | Adrian Georgescu | |
80 | 23 | Adrian Georgescu | source:sipsimple/payloads/policy.py |
81 | 1 | Adrian Georgescu | |
82 | 21 | Adrian Georgescu | Generic data types to be used in policy applications. |
83 | 21 | Adrian Georgescu | |
84 | 22 | Adrian Georgescu | h2. Presence Rules |
85 | 18 | Adrian Georgescu | |
86 | 22 | Adrian Georgescu | Described in RFC5025. |
87 | 15 | Adrian Georgescu | |
88 | 23 | Adrian Georgescu | source:sipsimple/payloads/presrules.py |
89 | 22 | Adrian Georgescu | |
90 | 1 | Adrian Georgescu | Parses and generates authorization rules in XML format for presence or other |
91 | 1 | Adrian Georgescu | applications. Authorization rules are stored on the XCAP server. The |
92 | 1 | Adrian Georgescu | presence rules are generated either based on user initiative or as a |
93 | 1 | Adrian Georgescu | response to a new subscription signaled by a change in the watcherinfo |
94 | 18 | Adrian Georgescu | application. |
95 | 18 | Adrian Georgescu | |
96 | 18 | Adrian Georgescu | |
97 | 22 | Adrian Georgescu | h2. OMA Policy |
98 | 1 | Adrian Georgescu | |
99 | 23 | Adrian Georgescu | source:sipsimple/payloads/omapolicy.py |
100 | 22 | Adrian Georgescu | |
101 | 22 | Adrian Georgescu | Described in OMA-TS-Presence_SIMPLE_XDM-V1_1 |
102 | 22 | Adrian Georgescu | |
103 | 18 | Adrian Georgescu | Conditions extension handling according to OMA-TS-Presence_SIMPLE_XDM-V1_1. |
104 | 18 | Adrian Georgescu | This module provides an extension to common policy defined in RFC4745 to |
105 | 18 | Adrian Georgescu | support condition extensions defined by OMA. |
106 | 1 | Adrian Georgescu | |
107 | 22 | Adrian Georgescu | h2. Presence Content |
108 | 15 | Adrian Georgescu | |
109 | 22 | Adrian Georgescu | source:sipsimple/payloads/prescontent.py |
110 | 18 | Adrian Georgescu | |
111 | 22 | Adrian Georgescu | Described in OMA-TS-Presence_SIMPLE_XDM-V1_1 |
112 | 22 | Adrian Georgescu | |
113 | 15 | Adrian Georgescu | Generates presence content application documents according to OMA TS |
114 | 18 | Adrian Georgescu | Presence SIMPLE Content. |
115 | 1 | Adrian Georgescu | |
116 | 22 | Adrian Georgescu | h2. XCAP Directory |
117 | 8 | Adrian Georgescu | |
118 | 22 | Adrian Georgescu | source:sipsimple/payloads/directory.py (OMA Core Specifications) |
119 | 1 | Adrian Georgescu | |
120 | 18 | Adrian Georgescu | Parses xcap-directory messages according to OMA TS XDM Core. |
121 | 8 | Adrian Georgescu | |
122 | 22 | Adrian Georgescu | source:sipsimple/payloads/dialoginfo.py |
123 | 1 | Adrian Georgescu | |
124 | 22 | Adrian Georgescu | Described in RFC4235. |
125 | 1 | Adrian Georgescu | |
126 | 18 | Adrian Georgescu | Parses and produces dialog-info messages according to RFC4235. |
127 | 1 | Adrian Georgescu | |
128 | 1 | Adrian Georgescu | |
129 | 22 | Adrian Georgescu | h2. Dialog Rules |
130 | 18 | Adrian Georgescu | |
131 | 22 | Adrian Georgescu | source:sipsimple/payloads/dialogrules.py |
132 | 22 | Adrian Georgescu | |
133 | 18 | Adrian Georgescu | Parses and produces Dialog Authorization Rules documents. As there is no RFC |
134 | 15 | Adrian Georgescu | for this, common-policy format from RFC 4745 is used. Subscription Handling |
135 | 11 | Adrian Georgescu | has been taken from RFC 5025. |
136 | 11 | Adrian Georgescu | |
137 | 22 | Adrian Georgescu | h2. PIDF |
138 | 1 | Adrian Georgescu | |
139 | 22 | Adrian Georgescu | source:sipsimple/payloads/pidf.py |
140 | 18 | Adrian Georgescu | |
141 | 22 | Adrian Georgescu | Described in RFC3863 and RFC3379. |
142 | 22 | Adrian Georgescu | |
143 | 18 | Adrian Georgescu | This module provides classes to parse and generate PIDF documents, and also |
144 | 18 | Adrian Georgescu | uses the XML Application extensibility API to allow extensions to PIDF. It |
145 | 1 | Adrian Georgescu | is used to parse NOTIFY body for presence event and generates rich presence |
146 | 1 | Adrian Georgescu | state information for use with PUBLISH. Used to generate own presence |
147 | 18 | Adrian Georgescu | information and to parse the state of buddy lists entries we have subscribed |
148 | 1 | Adrian Georgescu | to. A SIP client typically instantiates a new pidf object for itself and for |
149 | 1 | Adrian Georgescu | each buddy it SUBSCRIBEs to and update each object when a NOTIFY is |
150 | 1 | Adrian Georgescu | received. The list of buddys is maintained using resourcelists application. |
151 | 1 | Adrian Georgescu | |
152 | 22 | Adrian Georgescu | h2. RPIDF |
153 | 1 | Adrian Georgescu | |
154 | 22 | Adrian Georgescu | source:sipsimple/payloads/rpid.py |
155 | 18 | Adrian Georgescu | |
156 | 22 | Adrian Georgescu | Described in RFC4480. |
157 | 22 | Adrian Georgescu | |
158 | 1 | Adrian Georgescu | This module provides an extension to PIDF to support rich presence. |
159 | 1 | Adrian Georgescu | |
160 | 22 | Adrian Georgescu | h2. Presence Data Model |
161 | 1 | Adrian Georgescu | |
162 | 22 | Adrian Georgescu | source:sipsimple/payloads/presdm.py. |
163 | 11 | Adrian Georgescu | |
164 | 22 | Adrian Georgescu | Described in RFC4479. |
165 | 11 | Adrian Georgescu | |
166 | 22 | Adrian Georgescu | This module provides an extension to the PIDF to support the data module defined in RFC4479. |
167 | 1 | Adrian Georgescu | |
168 | 22 | Adrian Georgescu | h2. CIPID |
169 | 22 | Adrian Georgescu | |
170 | 22 | Adrian Georgescu | source:sipsimple/payloads/cipid.py |
171 | 22 | Adrian Georgescu | |
172 | 22 | Adrian Georgescu | Described in RFC4482. |
173 | 1 | Adrian Georgescu | |
174 | 1 | Adrian Georgescu | This module provides an extension to PIDF to provide person related information. |
175 | 1 | Adrian Georgescu | |
176 | 22 | Adrian Georgescu | h2. Endpoint Capabilities |
177 | 18 | Adrian Georgescu | |
178 | 22 | Adrian Georgescu | source:sipsimple/payloads/caps.py |
179 | 11 | Adrian Georgescu | |
180 | 22 | Adrian Georgescu | Described in RFC5196. |
181 | 22 | Adrian Georgescu | |
182 | 18 | Adrian Georgescu | This module provides capabilities application: displays OPTIONS request-like information |
183 | 11 | Adrian Georgescu | as an extension to the PIDF. |
184 | 11 | Adrian Georgescu | |
185 | 22 | Adrian Georgescu | h2. XCAP capabilities |
186 | 11 | Adrian Georgescu | |
187 | 22 | Adrian Georgescu | source:sipsimple/payloads/xcapcaps.py |
188 | 18 | Adrian Georgescu | |
189 | 22 | Adrian Georgescu | Described in RFC4825. |
190 | 22 | Adrian Georgescu | |
191 | 18 | Adrian Georgescu | Support for parsing and building xcap-caps documents, as defined by RFC4825. |
192 | 1 | Adrian Georgescu | |
193 | 26 | Adrian Georgescu | h2. XCAP Differences |
194 | 15 | Adrian Georgescu | |
195 | 22 | Adrian Georgescu | source:sipsimple/payloads/xcapdiff.py |
196 | 22 | Adrian Georgescu | |
197 | 22 | Adrian Georgescu | Described in RFC5874. |
198 | 18 | Adrian Georgescu | |
199 | 18 | Adrian Georgescu | Parses NOTIFY body for xcap-diff event. Used to detect changes in XCAP |
200 | 15 | Adrian Georgescu | documents changed by other device configured for the same presentity. |
201 | 1 | Adrian Georgescu | |
202 | 1 | Adrian Georgescu | |
203 | 23 | Adrian Georgescu | h2. Is-composing |
204 | 1 | Adrian Georgescu | |
205 | 23 | Adrian Georgescu | source:sipsimple/payloads/iscomposing.py |
206 | 23 | Adrian Georgescu | |
207 | 23 | Adrian Georgescu | Described in RFC3994. |
208 | 23 | Adrian Georgescu | |
209 | 1 | Adrian Georgescu | This module parses and generates isComposing messages according to RFC3994. It's used |
210 | 18 | Adrian Georgescu | mainly in chat environments to indicate the other party that the user is actually |
211 | 1 | Adrian Georgescu | typing a message. |
212 | 1 | Adrian Georgescu | |
213 | 1 | Adrian Georgescu | |
214 | 23 | Adrian Georgescu | h2. Conference Information |
215 | 11 | Adrian Georgescu | |
216 | 23 | Adrian Georgescu | source:sipsimple/payloads/conference.py |
217 | 23 | Adrian Georgescu | |
218 | 23 | Adrian Georgescu | Described in RFC4575. |
219 | 23 | Adrian Georgescu | |
220 | 1 | Adrian Georgescu | This module implements conference-info payload parsing and generating for |
221 | 1 | Adrian Georgescu | describing information about conference participants and related resources. |
222 | 1 | Adrian Georgescu | |
223 | 18 | Adrian Georgescu | |
224 | 23 | Adrian Georgescu | h2. Message Summary |
225 | 23 | Adrian Georgescu | |
226 | 23 | Adrian Georgescu | source:sipsimple/payloads/messagesummary.py |
227 | 23 | Adrian Georgescu | |
228 | 23 | Adrian Georgescu | Described in RFC3842. |
229 | 18 | Adrian Georgescu | |
230 | 18 | Adrian Georgescu | This module implements a parser and generator for message-summary payload, |
231 | 1 | Adrian Georgescu | which is used to indicate missed calls or voice mail recordings. |