Xcapclient

Version 8 (Adrian Georgescu, 10/26/2008 02:10 pm)

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