Xcapclient

Version 13 (Adrian Georgescu, 11/06/2008 02:47 pm)

1 13 Adrian Georgescu
= xcapclient =
2 1 Adrian Georgescu
3 1 Adrian Georgescu
To use this script you must to have a valid [wiki:configuration_file configuration file].
4 1 Adrian Georgescu
5 13 Adrian Georgescu
== Description ==
6 1 Adrian Georgescu
7 12 Adrian Georgescu
[[Image(http://www.openxcap.org/chrome/site/SIMPLE-XCAP-client.png, align=right, nolink)]]
8 8 Adrian Georgescu
9 9 Adrian Georgescu
XCAP protocol, defined in RFC 4825, allows a client to read, write, and
10 9 Adrian Georgescu
modify application configuration data stored in XML format on a server. XCAP
11 9 Adrian Georgescu
maps XML document sub-trees and element attributes to HTTP URIs, so that
12 9 Adrian Georgescu
these components can be directly accessed by HTTP. An XCAP server used by
13 9 Adrian Georgescu
XCAP clients to store data like presence policy in combination with a SIP
14 9 Adrian Georgescu
Presence server that supports PUBLISH/SUBSCRIBE/NOTIFY SIP methods can
15 9 Adrian Georgescu
provide a complete SIP SIMPLE solution.
16 9 Adrian Georgescu
17 10 Adrian Georgescu
This XCAP  client is part of python-xcaplib package provided by [http://openxcap.org OpenXCAP] server. If you have installed bash_completion.d/xcapclient  you can use TAB completion to browse through the content of the XCAP server documents/nodes/atributes. For more information read the documentation that comes with the package.
18 1 Adrian Georgescu
19 1 Adrian Georgescu
{{{
20 1 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -h
21 1 Adrian Georgescu
22 1 Adrian Georgescu
  xcapclient: Client for managing full or partial XML documents on XCAP servers (RFC 4825)
23 1 Adrian Georgescu
  xcapclient [OPTIONS] --app AUID ACTION [NODE-SELECTOR]
24 1 Adrian Georgescu
25 1 Adrian Georgescu
  ACTION is an operation to perform: get, replace, insert, put or delete.
26 1 Adrian Georgescu
  Presence of NODE-SELECTOR indicates that action is to be performed on an
27 1 Adrian Georgescu
  element or an attribute.
28 1 Adrian Georgescu
29 1 Adrian Georgescu
Options:
30 1 Adrian Georgescu
  -h, --help             show this help message and exit
31 1 Adrian Georgescu
  -a NAME, --account-name=NAME
32 1 Adrian Georgescu
                         the account name from which to read account settings.
33 1 Adrian Georgescu
                         Corresponds to section Account_NAME in the
34 1 Adrian Georgescu
                         configuration file. If not supplied, the section
35 1 Adrian Georgescu
                         [Account] will be read.
36 1 Adrian Georgescu
  --show-config          show options from the configuration file; use
37 1 Adrian Georgescu
                         together with --account-name
38 1 Adrian Georgescu
  --xcap-root=XCAP_ROOT  XCAP root, e.g. https://xcap.example.com/xcap-root
39 1 Adrian Georgescu
  --sip-address=SIP_ADDRESS
40 1 Adrian Georgescu
                         SIP address of the user in the form username@domain
41 1 Adrian Georgescu
  -p PASSWORD, --password=PASSWORD
42 1 Adrian Georgescu
                         password to use if authentication is required. If not
43 1 Adrian Georgescu
                         supplied will be asked interactively
44 1 Adrian Georgescu
  --app=AUID             Application Unique ID. There's no default value;
45 1 Adrian Georgescu
                         however, it may be guessed from NODE-SELECTOR or from
46 1 Adrian Georgescu
                         the input file. Known apps: watchers, pidf-
47 1 Adrian Georgescu
                         manipulation, rls-services, resource-lists, xcap-
48 1 Adrian Georgescu
                         caps, pres-rules, test-app
49 1 Adrian Georgescu
  --filename=FILENAME    
50 1 Adrian Georgescu
  -c CONTEXT, --context=CONTEXT
51 1 Adrian Georgescu
                         document context, users or global; default is users
52 1 Adrian Georgescu
                         for everything except xcap-caps
53 1 Adrian Georgescu
  --etag=ETAG            perform a conditional operation
54 1 Adrian Georgescu
  -i INPUT_FILENAME      source file for the PUT request; default is <stdin>
55 1 Adrian Georgescu
  -o OUTPUT_FILENAME     output file for the body of the server response
56 1 Adrian Georgescu
                         (successful or not); default is <stdout>
57 1 Adrian Georgescu
  -d, --dump             print HTTP traffic to stderr
58 2 Adrian Georgescu
}}}
59 2 Adrian Georgescu
60 2 Adrian Georgescu
61 6 Adrian Georgescu
== Example for XCAP server capabilities (xcap-caps)  == 
62 6 Adrian Georgescu
{{{
63 6 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -a alice --app xcap-caps GET
64 6 Adrian Georgescu
get https://xcap.sipthor.net/xcap-root/xcap-caps/global/index
65 6 Adrian Georgescu
etag: "ab12efdd1aff88296deee1aa195b823e"
66 6 Adrian Georgescu
content-type: application/xcap-caps+xml
67 6 Adrian Georgescu
content-length: 826
68 6 Adrian Georgescu
<?xml version='1.0' encoding='UTF-8'?>
69 6 Adrian Georgescu
<xcap-caps xmlns='urn:ietf:params:xml:ns:xcap-caps'>
70 6 Adrian Georgescu
<auids>
71 6 Adrian Georgescu
<auid>watchers</auid>
72 6 Adrian Georgescu
<auid>org.openmobilealliance.pres-rules</auid>
73 6 Adrian Georgescu
<auid>rls-services</auid>
74 6 Adrian Georgescu
<auid>pidf-manipulation</auid>
75 6 Adrian Georgescu
<auid>xcap-caps</auid>
76 6 Adrian Georgescu
<auid>test-app</auid>
77 6 Adrian Georgescu
<auid>resource-lists</auid>
78 6 Adrian Georgescu
<auid>pres-rules</auid>
79 6 Adrian Georgescu
</auids>
80 6 Adrian Georgescu
<extensions>
81 6 Adrian Georgescu
</extensions>
82 6 Adrian Georgescu
<namespaces>
83 6 Adrian Georgescu
<namespace>http://openxcap.org/ns/watchers</namespace>
84 6 Adrian Georgescu
<namespace>urn:ietf:params:xml:ns:pres-rules</namespace>
85 6 Adrian Georgescu
<namespace>urn:ietf:params:xml:ns:rls-services</namespace>
86 6 Adrian Georgescu
<namespace>urn:ietf:params:xml:ns:pidf</namespace>
87 6 Adrian Georgescu
<namespace>urn:ietf:params:xml:ns:xcap-caps</namespace>
88 6 Adrian Georgescu
<namespace>test-app</namespace>
89 6 Adrian Georgescu
<namespace>urn:ietf:params:xml:ns:resource-lists</namespace>
90 6 Adrian Georgescu
<namespace>urn:ietf:params:xml:ns:pres-rules</namespace>
91 6 Adrian Georgescu
</namespaces>
92 6 Adrian Georgescu
</xcap-caps>
93 6 Adrian Georgescu
}}}
94 6 Adrian Georgescu
95 5 Adrian Georgescu
== Example for pres-rules XCAP document ==
96 1 Adrian Georgescu
97 3 Adrian Georgescu
=== PUT ===
98 3 Adrian Georgescu
99 2 Adrian Georgescu
{{{
100 2 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -a alice PUT -i work/python-xcaplib/examples/pres-rules.xml 
101 2 Adrian Georgescu
put https://xcap.sipthor.net/xcap-root/pres-rules/users/sip:alice@example.com/index
102 2 Adrian Georgescu
201 Created
103 2 Adrian Georgescu
etag: "345ba7c1ce125b2ff2438c19b25b4077"
104 2 Adrian Georgescu
content-type: application/auth-policy+xml
105 2 Adrian Georgescu
}}}
106 1 Adrian Georgescu
107 2 Adrian Georgescu
108 3 Adrian Georgescu
=== GET ===
109 2 Adrian Georgescu
110 2 Adrian Georgescu
{{{
111 2 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -a alice --app pres-rules get 
112 2 Adrian Georgescu
get https://xcap.sipthor.net/xcap-root/pres-rules/users/sip:alice@example.com/index
113 2 Adrian Georgescu
etag: "345ba7c1ce125b2ff2438c19b25b4077"
114 2 Adrian Georgescu
content-type: application/auth-policy+xml
115 2 Adrian Georgescu
content-length: 939
116 2 Adrian Georgescu
<?xml version="1.0" encoding="UTF-8"?>
117 2 Adrian Georgescu
<ruleset xmlns="urn:ietf:params:xml:ns:common-policy" xmlns:pr="urn:ietf:params:xml:ns:pres-rules" xmlns:cp="www.counterpath.com/privacy-lists">
118 2 Adrian Georgescu
<rule id="pres_whitelist">
119 2 Adrian Georgescu
<conditions>
120 2 Adrian Georgescu
<identity>
121 2 Adrian Georgescu
<one id="sip:bob@example.com"/>
122 2 Adrian Georgescu
<one id="sip:alice@example.com"/>
123 2 Adrian Georgescu
<many domain="ag-projects.com">
124 2 Adrian Georgescu
</many>
125 2 Adrian Georgescu
</identity>
126 2 Adrian Georgescu
</conditions>
127 2 Adrian Georgescu
<actions>
128 2 Adrian Georgescu
<pr:sub-handling>allow</pr:sub-handling>
129 2 Adrian Georgescu
</actions>
130 2 Adrian Georgescu
<transformations>
131 2 Adrian Georgescu
<pr:provide-services>
132 2 Adrian Georgescu
<pr:all-services/>
133 2 Adrian Georgescu
</pr:provide-services>
134 2 Adrian Georgescu
<pr:provide-persons>
135 2 Adrian Georgescu
<pr:all-persons/>
136 2 Adrian Georgescu
</pr:provide-persons>
137 2 Adrian Georgescu
<pr:provide-devices>
138 2 Adrian Georgescu
<pr:all-devices/>
139 2 Adrian Georgescu
</pr:provide-devices>
140 2 Adrian Georgescu
<pr:provide-all-attributes/>
141 2 Adrian Georgescu
</transformations>
142 2 Adrian Georgescu
</rule>
143 2 Adrian Georgescu
<rule id="pres_blacklist">
144 2 Adrian Georgescu
<conditions>
145 2 Adrian Georgescu
<identity>
146 2 Adrian Georgescu
<one id="sip:40316600024@abc.com"/>
147 2 Adrian Georgescu
</identity>
148 2 Adrian Georgescu
</conditions>
149 2 Adrian Georgescu
<actions>
150 2 Adrian Georgescu
<pr:sub-handling>block</pr:sub-handling>
151 2 Adrian Georgescu
</actions>
152 2 Adrian Georgescu
<transformations/>
153 2 Adrian Georgescu
</rule>
154 1 Adrian Georgescu
</ruleset>
155 2 Adrian Georgescu
}}}
156 2 Adrian Georgescu
157 3 Adrian Georgescu
=== DELETE ===
158 2 Adrian Georgescu
159 2 Adrian Georgescu
{{{
160 2 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -a alice --app pres-rules DELETE
161 1 Adrian Georgescu
delete https://xcap.sipthor.net/xcap-root/pres-rules/users/sip:alice@example.com/index
162 1 Adrian Georgescu
200 OK
163 1 Adrian Georgescu
content-type: application/auth-policy+xml
164 3 Adrian Georgescu
}}}
165 3 Adrian Georgescu
166 3 Adrian Georgescu
167 5 Adrian Georgescu
== Example for resource-lists XCAP document ==
168 3 Adrian Georgescu
169 3 Adrian Georgescu
=== PUT ===
170 3 Adrian Georgescu
171 3 Adrian Georgescu
{{{
172 3 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -a alice PUT -i work/python-xcaplib/examples/resource-lists.xml 
173 3 Adrian Georgescu
put https://xcap.sipthor.net/xcap-root/resource-lists/users/sip:alice@example.com/index
174 3 Adrian Georgescu
201 Created
175 3 Adrian Georgescu
etag: "f8c47352d61b5b256ee80d964e03efd6"
176 3 Adrian Georgescu
content-type: application/resource-lists+xml
177 3 Adrian Georgescu
}}}
178 3 Adrian Georgescu
179 3 Adrian Georgescu
=== GET ===
180 3 Adrian Georgescu
181 3 Adrian Georgescu
{{{
182 3 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -a alice --app resource-lists GET
183 3 Adrian Georgescu
get https://xcap.sipthor.net/xcap-root/resource-lists/users/sip:alice@example.com/index
184 3 Adrian Georgescu
etag: "f8c47352d61b5b256ee80d964e03efd6"
185 3 Adrian Georgescu
content-type: application/resource-lists+xml
186 3 Adrian Georgescu
content-length: 991
187 3 Adrian Georgescu
<?xml version="1.0" encoding="UTF-8"?>
188 3 Adrian Georgescu
   <resource-lists xmlns="urn:ietf:params:xml:ns:resource-lists"
189 3 Adrian Georgescu
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
190 3 Adrian Georgescu
    <list name="friends">
191 3 Adrian Georgescu
     <entry uri="sip:bill@example.com">
192 3 Adrian Georgescu
      <display-name>Bill Doe</display-name>
193 3 Adrian Georgescu
     </entry>
194 3 Adrian Georgescu
     <entry-ref ref="resource-lists/users/sip:bill@example.com/index/~~/resource-lists/list%5b@name=%22list1%22%5d/entry%5b@uri=%22sip:petri@example.com%22%5d"/>
195 3 Adrian Georgescu
     <list name="close-friends">
196 3 Adrian Georgescu
      <display-name>Close Friends</display-name>
197 3 Adrian Georgescu
      <entry uri="sip:joe@example.com">
198 3 Adrian Georgescu
       <display-name>Joe Smith</display-name>
199 3 Adrian Georgescu
      </entry>
200 3 Adrian Georgescu
      <entry uri="sip:nancy@example.com">
201 3 Adrian Georgescu
       <display-name>Nancy Gross</display-name>
202 3 Adrian Georgescu
      </entry>
203 3 Adrian Georgescu
      <external anchor="http://xcap.example.org/resource-lists/users/sip:a@example.org/index/~~/resource-lists/list%5b@name=%22mkting%22%5d">
204 3 Adrian Georgescu
        <display-name>Marketing</display-name>
205 3 Adrian Georgescu
       </external>
206 3 Adrian Georgescu
     </list>
207 3 Adrian Georgescu
    </list>
208 3 Adrian Georgescu
   </resource-lists>
209 3 Adrian Georgescu
}}}
210 3 Adrian Georgescu
211 3 Adrian Georgescu
=== DELETE ===
212 3 Adrian Georgescu
213 3 Adrian Georgescu
{{{
214 3 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -a alice --app resource-lists DELETE
215 3 Adrian Georgescu
delete https://xcap.sipthor.net/xcap-root/resource-lists/users/sip:alice@example.com/index
216 3 Adrian Georgescu
200 OK
217 3 Adrian Georgescu
content-type: application/resource-lists+xml
218 3 Adrian Georgescu
adigeo@ag-imac3:~$
219 1 Adrian Georgescu
}}}
220 4 Adrian Georgescu
221 5 Adrian Georgescu
== Example for rls-services XCAP document ==
222 4 Adrian Georgescu
223 4 Adrian Georgescu
=== PUT ===
224 4 Adrian Georgescu
225 4 Adrian Georgescu
{{{
226 4 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -a alice PUT -i work/python-xcaplib/examples/rls-services.xml 
227 4 Adrian Georgescu
put https://xcap.sipthor.net/xcap-root/rls-services/users/sip:alice@example.com/index
228 4 Adrian Georgescu
201 Created
229 4 Adrian Georgescu
etag: "44f5fca1b08352815ee12f1a0c32d812"
230 4 Adrian Georgescu
content-type: application/rls-services+xml
231 4 Adrian Georgescu
}}}
232 4 Adrian Georgescu
233 4 Adrian Georgescu
=== GET ===
234 4 Adrian Georgescu
235 4 Adrian Georgescu
{{{
236 4 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -a alice --app rls-services GET
237 4 Adrian Georgescu
get https://xcap.sipthor.net/xcap-root/rls-services/users/sip:alice@example.com/index
238 4 Adrian Georgescu
etag: "44f5fca1b08352815ee12f1a0c32d812"
239 4 Adrian Georgescu
content-type: application/rls-services+xml
240 4 Adrian Georgescu
content-length: 797
241 4 Adrian Georgescu
<?xml version="1.0" encoding="UTF-8"?>
242 4 Adrian Georgescu
   <rls-services xmlns="urn:ietf:params:xml:ns:rls-services"
243 4 Adrian Georgescu
      xmlns:rl="urn:ietf:params:xml:ns:resource-lists"
244 4 Adrian Georgescu
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
245 4 Adrian Georgescu
    <service uri="sip:mybuddies@example.com">
246 4 Adrian Georgescu
     <resource-list>https://xcap.example.com/xcap-root/resource-lists/users/sip:alice@example.com/index/~~/resource-lists/list%5b@name=%22l1%22%5d</resource-list>
247 4 Adrian Georgescu
     <packages>
248 4 Adrian Georgescu
      <package>presence</package>
249 4 Adrian Georgescu
     </packages>
250 4 Adrian Georgescu
    </service>
251 4 Adrian Georgescu
    <service uri="sip:marketing@example.com">
252 4 Adrian Georgescu
      <list name="marketing">
253 4 Adrian Georgescu
        <rl:entry uri="sip:joe@example.com"/>
254 4 Adrian Georgescu
        <rl:entry uri="sip:sudhir@example.com"/>
255 4 Adrian Georgescu
      </list>
256 4 Adrian Georgescu
      <packages>
257 4 Adrian Georgescu
        <package>presence</package>
258 4 Adrian Georgescu
      </packages>
259 4 Adrian Georgescu
    </service>
260 4 Adrian Georgescu
   </rls-services>
261 4 Adrian Georgescu
}}}
262 4 Adrian Georgescu
263 4 Adrian Georgescu
=== DELETE ===
264 4 Adrian Georgescu
265 4 Adrian Georgescu
{{{
266 4 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -a alice --app rls-services DELETE
267 4 Adrian Georgescu
delete https://xcap.sipthor.net/xcap-root/rls-services/users/sip:alice@example.com/index
268 4 Adrian Georgescu
200 OK
269 4 Adrian Georgescu
content-type: application/rls-services+xml
270 4 Adrian Georgescu
}}}