ncclient:NETCONF Python client

# Copyright 2009 Shikhar Bhushan

#

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.

# You may obtain a copy of the License at

#

#    http://www.apache.org/licenses/LICENSE-2.0

#

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS,

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

# See the License for the specific language governing permissions and

# limitations under the License.

from content import Creator, Parser

from threading import Thread

from listener import Subject, Listener

class SessionError(ncclientError): pass

class Session(Thread, Subject, Listener):

    CLIENT, SERVER = range(2)

    def __init__(self, capabilities=None, listeners=[]):

        Thread.__init__(self, name='session')

        listeners.append(self)

        Subject.__init__(self, listeners=listeners)

        Thread.setDaemon(True)

        self._capabilities = {

            CLIENT: capabilities,

            SERVER: None # yet

        }

        self._id = None # session-id

        self._connected = False

        self._initialised = False

        self._q = Queue.Queue()

    def _init(self, id, capabilities):

        if isinstance(id, int) and isinstance(capabilities, Capabilities):

            self.id = id

            self.capabilities[SERVER] = capabilities

            self.initialised = True

        else: # there was an error in parsing or such

            raise ValueError

    def _greet(self):

        hello = Creator()

        # ...

        self._q.add(hello)

    def _close(self):

        raise NotImplementedError

    def connect(self):

        raise NotImplementedError

    def send(self, message):

        if self.ready:

            self._q.add(message)

        else:

            raise SessionError('Session not ready')

    ### Thread methods

    def run(self):

        raise NotImplementedError

    ### Listener methods - these are relevant for the initial greeting only

    def reply(self, data):

        id, capabilities = None, None

        try:

            p = Parser()

            # ...

            self._init(id, capabilities)

        except: # ...

            pass

        finally:

            self.remove_listener(self)

    def error(self, data):

        self._close()

        raise SSHError('Session initialization failed')

    ### Getter methods and properties

    def get_capabilities(self, whose):

        return self._capabilities[whose]

    ready = property(lambda self: self._connected and self._initialised)

    id = property(lambda self: self._id)

    client_capabilities = property(lambda self: self._capabilities[CLIENT])

    server_capabilities = property(lambda self: self._capabilities[SERVER])