Statistics
| Branch: | Tag: | Revision:

root / ncclient / capabilities.py @ 0cdb8b3c

History | View | Annotate | Download (2.7 kB)

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
def abbreviate(uri):
16
    if uri.startswith('urn:ietf:params:netconf:capability:'):
17
        return (':' + uri.split(':')[5])
18

    
19
def schemes(uri):
20
    return uri.partition("?scheme=")[2].split(',')
21

    
22
class Capabilities:
23
    
24
    """Represent the capabilities of client or server. Also facilitates using
25
    abbreviated capability names in addition to complete URI.
26
    """
27
    
28
    def __init__(self, capabilities=None):
29
        self._dict = {}
30
        if isinstance(capabilities, dict):
31
            self._dict = capabilities
32
        elif isinstance(capabilities, list):
33
            for uri in capabilities:
34
                self._dict[uri] = abbreviate(uri)
35
    
36
    def __contains__(self, key):
37
        return ( key in self._dict ) or ( key in self._dict.values() )
38
    
39
    def __iter__(self):
40
        return self._dict.keys().__iter__()
41
    
42
    def __repr__(self):
43
        return repr(self._dict.keys())
44
    
45
    def __list__(self):
46
        return self._dict.keys()
47
    
48
    def add(self, uri, shorthand=None):
49
        if shorthand is None:
50
            shorthand = abbreviate(uri)
51
        self._dict[uri] = shorthand
52
    
53
    set = add
54
    
55
    def remove(self, key):
56
        if key in self._dict:
57
            del self._dict[key]
58
        else:
59
            for uri in self._dict:
60
                if self._dict[uri] == key:
61
                    del self._dict[uri]
62
                    break
63

    
64
# : the capabilities currently supported by ncclient
65
CAPABILITIES = Capabilities([
66
    'urn:ietf:params:netconf:base:1.0',
67
    'urn:ietf:params:netconf:capability:writable-running:1.0',
68
    'urn:ietf:params:netconf:capability:candidate:1.0',
69
    'urn:ietf:params:netconf:capability:confirmed-commit:1.0',
70
    'urn:ietf:params:netconf:capability:rollback-on-error:1.0',
71
    'urn:ietf:params:netconf:capability:startup:1.0',
72
    'urn:ietf:params:netconf:capability:url:1.0?scheme=http,ftp,file,https,sftp',
73
    'urn:ietf:params:netconf:capability:validate:1.0',
74
    'urn:ietf:params:netconf:capability:xpath:1.0',
75
    #'urn:ietf:params:netconf:capability:notification:1.0', # TODO
76
    #'urn:ietf:params:netconf:capability:interleave:1.0' # theoretically already supported
77
])