root / ncclient / capabilities.py @ dd225c7a
History | View | Annotate | Download (3.8 kB)
1 | d095a59e | Shikhar Bhushan | # Copyright 2009 Shikhar Bhushan
|
---|---|---|---|
2 | d095a59e | Shikhar Bhushan | #
|
3 | d095a59e | Shikhar Bhushan | # Licensed under the Apache License, Version 2.0 (the "License");
|
4 | d095a59e | Shikhar Bhushan | # you may not use this file except in compliance with the License.
|
5 | d095a59e | Shikhar Bhushan | # You may obtain a copy of the License at
|
6 | d095a59e | Shikhar Bhushan | #
|
7 | d095a59e | Shikhar Bhushan | # http://www.apache.org/licenses/LICENSE-2.0
|
8 | d095a59e | Shikhar Bhushan | #
|
9 | d095a59e | Shikhar Bhushan | # Unless required by applicable law or agreed to in writing, software
|
10 | d095a59e | Shikhar Bhushan | # distributed under the License is distributed on an "AS IS" BASIS,
|
11 | d095a59e | Shikhar Bhushan | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12 | d095a59e | Shikhar Bhushan | # See the License for the specific language governing permissions and
|
13 | d095a59e | Shikhar Bhushan | # limitations under the License.
|
14 | d095a59e | Shikhar Bhushan | |
15 | dd225c7a | Shikhar Bhushan | _capability_map = { |
16 | dd225c7a | Shikhar Bhushan | 'urn:liberouter:params:netconf:capability:power-control:1.0':
|
17 | dd225c7a | Shikhar Bhushan | [':power-control', ':power-control:1.0'] |
18 | dd225c7a | Shikhar Bhushan | } |
19 | dd225c7a | Shikhar Bhushan | |
20 | 216bb34c | Shikhar Bhushan | def _abbreviate(uri): |
21 | 216bb34c | Shikhar Bhushan | if uri.startswith('urn:ietf:params:netconf:'): |
22 | 216bb34c | Shikhar Bhushan | splitted = uri.split(':')
|
23 | 216bb34c | Shikhar Bhushan | if ':capability:' in uri: |
24 | 216bb34c | Shikhar Bhushan | return [ ':' + splitted[5], ':' + splitted[5] + ':' + splitted[6] ] |
25 | 216bb34c | Shikhar Bhushan | elif ':base:' in uri: |
26 | 216bb34c | Shikhar Bhushan | return [ ':base', ':base' + ':'+ splitted[5] ] |
27 | dd225c7a | Shikhar Bhushan | elif uri in _capability_map: |
28 | dd225c7a | Shikhar Bhushan | return _capability_map[uri]
|
29 | dd225c7a | Shikhar Bhushan | return []
|
30 | 216bb34c | Shikhar Bhushan | |
31 | 216bb34c | Shikhar Bhushan | def schemes(url_uri): |
32 | 216bb34c | Shikhar Bhushan | """Given a URI that has a *scheme* query string (i.e. *:url* capability
|
33 | 216bb34c | Shikhar Bhushan | URI), will return a list of supported schemes.
|
34 | 216bb34c | Shikhar Bhushan | """
|
35 | 216bb34c | Shikhar Bhushan | return url_uri.partition("?scheme=")[2].split(',') |
36 | 78f6c132 | Shikhar Bhushan | |
37 | d095a59e | Shikhar Bhushan | class Capabilities: |
38 | a7cb58ce | Shikhar Bhushan | |
39 | 216bb34c | Shikhar Bhushan | """Represents the set of capabilities for a NETCONF client or server.
|
40 | 216bb34c | Shikhar Bhushan | Initialised with a list of capability URI's.
|
41 | 216bb34c | Shikhar Bhushan |
|
42 | 216bb34c | Shikhar Bhushan | Presence of a capability can be checked with the *in* operations. In addition
|
43 | 216bb34c | Shikhar Bhushan | to the URI, for capabilities of the form
|
44 | 216bb34c | Shikhar Bhushan | *urn:ietf:params:netconf:capability:$name:$version* their shorthand can be
|
45 | 216bb34c | Shikhar Bhushan | used as a key. For example, for
|
46 | 216bb34c | Shikhar Bhushan | *urn:ietf:params:netconf:capability:candidate:1.0* the shorthand would be
|
47 | 216bb34c | Shikhar Bhushan | *:candidate*. If version is significant, use *:candidate:1.0* as key.
|
48 | 216bb34c | Shikhar Bhushan | """
|
49 | 216bb34c | Shikhar Bhushan | |
50 | 216bb34c | Shikhar Bhushan | def __init__(self, capabilities): |
51 | d095a59e | Shikhar Bhushan | self._dict = {}
|
52 | 216bb34c | Shikhar Bhushan | for uri in capabilities: |
53 | 216bb34c | Shikhar Bhushan | self._dict[uri] = _abbreviate(uri)
|
54 | a7cb58ce | Shikhar Bhushan | |
55 | d095a59e | Shikhar Bhushan | def __contains__(self, key): |
56 | a7cb58ce | Shikhar Bhushan | if key in self._dict: |
57 | a7cb58ce | Shikhar Bhushan | return True |
58 | 216bb34c | Shikhar Bhushan | for abbrs in self._dict.values(): |
59 | 216bb34c | Shikhar Bhushan | if key in abbrs: |
60 | a7cb58ce | Shikhar Bhushan | return True |
61 | a7cb58ce | Shikhar Bhushan | return False |
62 | a7cb58ce | Shikhar Bhushan | |
63 | 216bb34c | Shikhar Bhushan | def __len__(self): |
64 | 216bb34c | Shikhar Bhushan | return len(self._dict) |
65 | 216bb34c | Shikhar Bhushan | |
66 | d095a59e | Shikhar Bhushan | def __iter__(self): |
67 | d095a59e | Shikhar Bhushan | return self._dict.keys().__iter__() |
68 | a7cb58ce | Shikhar Bhushan | |
69 | d095a59e | Shikhar Bhushan | def __repr__(self): |
70 | d095a59e | Shikhar Bhushan | return repr(self._dict.keys()) |
71 | a7cb58ce | Shikhar Bhushan | |
72 | 94803aaf | Shikhar Bhushan | def __list__(self): |
73 | 94803aaf | Shikhar Bhushan | return self._dict.keys() |
74 | a7cb58ce | Shikhar Bhushan | |
75 | 216bb34c | Shikhar Bhushan | def add(self, uri): |
76 | 216bb34c | Shikhar Bhushan | "Add a capability"
|
77 | 216bb34c | Shikhar Bhushan | self._dict[uri] = _abbreviate(uri)
|
78 | a7cb58ce | Shikhar Bhushan | |
79 | 216bb34c | Shikhar Bhushan | def remove(self, uri): |
80 | 216bb34c | Shikhar Bhushan | "Remove a capability"
|
81 | d095a59e | Shikhar Bhushan | if key in self._dict: |
82 | d095a59e | Shikhar Bhushan | del self._dict[key] |
83 | a7cb58ce | Shikhar Bhushan | |
84 | 216bb34c | Shikhar Bhushan | def check(self, key): |
85 | 216bb34c | Shikhar Bhushan | """Whether specified capability is present.
|
86 | 216bb34c | Shikhar Bhushan |
|
87 | 216bb34c | Shikhar Bhushan | :arg key: URI or shorthand
|
88 | 216bb34c | Shikhar Bhushan |
|
89 | 216bb34c | Shikhar Bhushan | .. note:
|
90 | 216bb34c | Shikhar Bhushan | The *in* operation is the preferred form.
|
91 | 216bb34c | Shikhar Bhushan | """
|
92 | 216bb34c | Shikhar Bhushan | return key in self |
93 | a7cb58ce | Shikhar Bhushan | |
94 | dd225c7a | Shikhar Bhushan | def get_uri(self, shorthand): |
95 | dd225c7a | Shikhar Bhushan | for uri, abbrs in self._dict.items(): |
96 | dd225c7a | Shikhar Bhushan | if shorthand in abbrs: |
97 | dd225c7a | Shikhar Bhushan | return uri
|
98 | a7cb58ce | Shikhar Bhushan | |
99 | 216bb34c | Shikhar Bhushan | #: :class:`Capabilities` object representing the capabilities currently supported by NCClient
|
100 | d095a59e | Shikhar Bhushan | CAPABILITIES = Capabilities([ |
101 | d6688264 | Shikhar Bhushan | 'urn:ietf:params:netconf:base:1.0',
|
102 | d6688264 | Shikhar Bhushan | 'urn:ietf:params:netconf:capability:writable-running:1.0',
|
103 | d6688264 | Shikhar Bhushan | 'urn:ietf:params:netconf:capability:candidate:1.0',
|
104 | d6688264 | Shikhar Bhushan | 'urn:ietf:params:netconf:capability:confirmed-commit:1.0',
|
105 | d6688264 | Shikhar Bhushan | 'urn:ietf:params:netconf:capability:rollback-on-error:1.0',
|
106 | d6688264 | Shikhar Bhushan | 'urn:ietf:params:netconf:capability:startup:1.0',
|
107 | 0cdb8b3c | Shikhar Bhushan | 'urn:ietf:params:netconf:capability:url:1.0?scheme=http,ftp,file,https,sftp',
|
108 | d6688264 | Shikhar Bhushan | 'urn:ietf:params:netconf:capability:validate:1.0',
|
109 | d6688264 | Shikhar Bhushan | 'urn:ietf:params:netconf:capability:xpath:1.0',
|
110 | dd225c7a | Shikhar Bhushan | 'urn:liberouter:params:netconf:capability:power-control:1.0'
|
111 | 0cdb8b3c | Shikhar Bhushan | #'urn:ietf:params:netconf:capability:notification:1.0', # TODO
|
112 | 0cdb8b3c | Shikhar Bhushan | #'urn:ietf:params:netconf:capability:interleave:1.0' # theoretically already supported
|
113 | a7cb58ce | Shikhar Bhushan | ]) |