8c2e62a8b7c74b80eca88cdf1fcd5decb69fdfdc
[ncclient] / ncclient / operations / retrieve.py
1 # Copyright 2009 Shikhar Bhushan
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 #    http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 from ncclient.rpc import RPC, RPCReply
16
17 def build_filter(spec, type, criteria):
18     filter = {
19         'tag': 'filter',
20         'attributes': {'type': type}
21     }
22     if type == 'subtree':
23         filter['children'] = [criteria]
24     elif type == 'xpath':
25         filter['attributes']['select'] = criteria
26     return filter
27
28 class Get(RPC): # xx
29     
30     SPEC = {
31         'tag': 'get',
32         'children': []
33     }
34     
35     REPLY_CLS = GetReply
36     
37     def request(self, filter=None):
38         spec = Get.SPEC.copy()
39         if filter is not None:
40             #if filter[0] == 'xpath':
41             #    self._assert(':xpath')
42             spec['children'].append(build_filter(*filter))
43         return self._request(spec)
44
45 class GetReply(RPCReply):
46     
47     def parse(self):
48         RPCReply.parse(self)
49
50 class GetConfig(RPC): # xx
51     
52     SPEC = {
53         'tag': 'get-config',
54         'children': [ { 'tag': 'source', 'children': {'tag': None } } ]
55     }
56     
57     REPLY_CLS = GetConfigReply
58     
59     def request(self, source=None, source_url=None, filter=None):
60         self._one_of(source, source_url)
61         spec = GetConfig.SPEC.copy()
62         if source is not None:
63             spec['children'][0]['children']['tag'] = source
64         if source_url is not None:
65             #self._assert(':url')
66             spec['children'][0]['children']['tag'] = 'url'
67             spec['children'][0]['children']['text'] = source_url        
68         if filter is not None:
69             #if filter[0] == 'xpath':
70             #    self._assert(':xpath')
71             spec['children'].append(build_filter(*filter))
72         return self._request(spec)
73
74 class GetReply(RPCReply):
75     
76     def parse(self):
77         RPCReply.parse(self)