SipPayloadsApi

Version 19 (Adrian Georgescu, 08/07/2012 08:34 pm)

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