code.grnet.gr Git - ncclient/blob - ncclient/capabilities.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
  16 class Capabilities:
  17
  18     """Represent the capabilities of client or server. Also facilitates using
  19     abbreviated capability names in addition to complete URI.
  20     """
  21
  22     def __init__(self, capabilities=None):
  23         self._dict = {}
  24         if isinstance(capabilities, dict):
  25             self._dict = capabilities
  26         elif isinstance(capabilities, list):
  27             for uri in capabilities:
  28                 self._dict[uri] = Capabilities.guess_shorthand(uri)
  29
  30     def __contains__(self, key):
  31         return ( key in self._dict ) or ( key in self._dict.values() )
  32
  33     def __iter__(self):
  34         return self._dict.keys().__iter__()
  35
  36     def __repr__(self):
  37         return repr(self._dict.keys())
  38
  39     def __list__(self):
  40         return self._dict.keys()
  41
  42     def add(self, uri, shorthand=None):
  43         if shorthand is None:
  44             shorthand = Capabilities.guess_shorthand(uri)
  45         self._dict[uri] = shorthand
  46
  47     set = add
  48
  49     def remove(self, key):
  50         if key in self._dict:
  51             del self._dict[key]
  52         else:
  53             for uri in self._dict:
  54                 if self._dict[uri] == key:
  55                     del self._dict[uri]
  56                     break
  57
  58     @staticmethod
  59     def guess_shorthand(uri):
  60         if uri.startswith('urn:ietf:params:netconf:capability:'):
  61             return (':' + uri.split(':')[5])
  62
  63 CAPABILITIES = Capabilities([
  64     'urn:ietf:params:netconf:base:1.0',
  65     'urn:ietf:params:netconf:capability:writable-running:1.0',
  66     'urn:ietf:params:netconf:capability:candidate:1.0',
  67     'urn:ietf:params:netconf:capability:confirmed-commit:1.0',
  68     'urn:ietf:params:netconf:capability:rollback-on-error:1.0',
  69     'urn:ietf:params:netconf:capability:startup:1.0',
  70     'urn:ietf:params:netconf:capability:url:1.0?scheme=http,ftp,file',
  71     'urn:ietf:params:netconf:capability:validate:1.0',
  72     'urn:ietf:params:netconf:capability:xpath:1.0',
  73     'urn:ietf:params:netconf:capability:notification:1.0',
  74     'urn:ietf:params:netconf:capability:interleave:1.0'
  75 ])