# Copyright (c) 2016 Intracom S.A. Telecom Solutions. All rights reserved.
#
# This program and the accompanying materials are made available under the
# terms of the Eclipse Public License v1.0 which accompanies this distribution,
# and is available at http://www.eclipse.org/legal/epl-v10.html
"""
Implementation of custom controller exception classes."""
[docs]class CtrlError(Exception):
"""
Contains the exception handling concerning the Controller class
functionalities.
"""
def __init__(self, err_msg=None, err_code=1):
"""
Base-class for all controller exceptions raised by this module.
:param err_msg: the general error message.
:param err_code: the specific error code.
:type str
:type int
"""
self.err_code = err_code
if err_msg is None:
Exception.__init__(self, 'Controller generic exception')
self.err_msg = 'Controller generic exception'
else:
Exception.__init__(self, err_msg)
self.err_msg = err_msg
[docs]class CtrlNodeConnectionError(CtrlError):
"""
Contains the exception handling concerning the Controller connectivity.
"""
def __init__(self, additional_error_info='', err_code=1):
"""
A controller node connection error.
:param additional_error_info: the general error message.
:param err_code: the specific error code.
:type str
:type int
"""
CtrlError.__init__(self, 'Fail to establish ssh connection with '
'controller node. {0}'.
format(additional_error_info), err_code)
[docs]class CtrlBuildError(CtrlError):
"""
Contains the exception handling concerning the Controller building
functionality.
"""
def __init__(self, additional_error_info='', err_code=1):
"""
A controller build error
:param additional_error_info: the general error message.
:param err_code: the specific error code.
:type str
:type int
"""
CtrlError.__init__(self, 'Controller build failure. {0}'.
format(additional_error_info), err_code)
[docs]class CtrlGetError(CtrlError):
"""
Contains the exception handling concerning the Controller Get
functionality.
"""
def __init__(self, additional_error_info='', err_code=1):
"""
A controller get error
:param additional_error_info: the general error message.
:param err_code: the specific error code.
:type str
:type int
"""
CtrlError.__init__(self, 'Controller get failure. {0}'.
format(additional_error_info), err_code)
[docs]class CtrlStartError(CtrlError):
"""
Contains the exception handling concerning the Controller starting
functionality.
"""
def __init__(self, additional_error_info='', err_code=1):
"""
A controller start error.
:param additional_error_info: the general error message.
:param err_code: the specific error code.
:type str
:type int
"""
CtrlError.__init__(self, 'Controller start failure. {0}'.
format(additional_error_info), err_code)
[docs]class CtrlStopError(CtrlError):
"""
Contains the exception handling concerning the Controller stopping
functionality.
"""
def __init__(self, additional_error_info='', err_code=1):
"""
A controller stop error.
:param additional_error_info: the general error message.
:param err_code: the specific error code.
:type str
:type int
"""
CtrlError.__init__(self, 'Controller stop failure. {0}'.
format(additional_error_info), err_code)
[docs]class CtrlCleanupError(CtrlError):
"""
Contains the exception handling concerning the Controller cleaning
functionality.
"""
def __init__(self, additional_error_info='', err_code=1):
"""
A controller cleanup error.
:param additional_error_info: the general error message.
:param err_code: the specific error code.
:type str
:type int
"""
CtrlError.__init__(self, 'Controller cleanup failure. {0}'.
format(additional_error_info), err_code)
[docs]class CtrlStatusUnknownError(CtrlError):
"""
Contains the exception handling unknown errors on the Controller
"""
def __init__(self, additional_error_info='', err_code=1):
"""
A controller status unknown error.
:param additional_error_info: the general error message.
:param err_code: the specific error code.
:type str
:type int
"""
CtrlError.__init__(self, 'Controller fail to get status. {0}'.
format(additional_error_info), err_code)
[docs]class CtrlReadyStateError(CtrlError):
"""
Contains the exception handling concerning the controller readyness
"""
def __init__(self, additional_error_info='', err_code=1):
"""
A controller ready state error."""
CtrlError.__init__(self, 'Controller did not reach '
'ready state. {0}'.
format(additional_error_info), err_code)
[docs]class CtrlPortConflictError(CtrlError):
"""
Contains the exception handling concerning errors in the Southbound
port of the controller
"""
def __init__(self, additional_error_info='', err_code=1):
"""
A controller port conflict error.
:param additional_error_info: the general error message.
:param err_code: the specific error code.
:type str
:type int
"""
CtrlError.__init__(self, 'Controller SouthBound port is in '
'use by another process. {0}'.
format(additional_error_info), err_code)
[docs]class ODLXMLError(CtrlError):
"""
Contains the exception handling concerning the Opendaylight
Controller XML generation
"""
def __init__(self, additional_error_info='', err_code=1):
"""
ODL XML generation error.
:param additional_error_info: the general error message.
:param err_code: the specific error code.
:type str
:type int
"""
CtrlError.__init__(self, 'ODL Fail to generate XML files. {0}'.
format(additional_error_info), err_code)
[docs]class ODLDisablePersistenceError(CtrlError):
"""
Contains the exception handling concerning the Opendaylight
Controller changing persistence functionality
"""
def __init__(self, additional_error_info='', err_code=1):
"""
ODL fail to disable persistence error.
:param additional_error_info: the general error message.
:param err_code: the specific error code.
:type str
:type int
"""
CtrlError.__init__(self, 'ODL Fail to disable persistence mode. {0}'.
format(additional_error_info), err_code)
[docs]class ODLChangeStats(CtrlError):
"""
Contains the exception handling concerning the Opendaylight
Controller changing statistics period functionality
"""
def __init__(self, additional_error_info='', err_code=1):
"""
ODL fail to change statistics period error.
:param additional_error_info: the general error message.
:param err_code: the specific error code.
:type str
:type int
"""
CtrlError.__init__(self, 'ODL Fail to change statistics period. {0}'.
format(additional_error_info), err_code)
[docs]class ODLFlowModConfError(CtrlError):
"""
Contains the exception handling concerning the Opendaylight
Controller flow modification functionality
"""
def __init__(self, additional_error_info='', err_code=1):
"""
ODL fail to configure for flow modifications send error.
:param additional_error_info: the general error message.
:param err_code: the specific error code.
:type str
:type int
"""
CtrlError.__init__(self, 'ODL Fail to make configuration to send '
'flow modifications. {0}'.
format(additional_error_info), err_code)
[docs]class ODLGetOperHostsError(CtrlError):
"""
Contains the exception handling concerning the returned hosts from
Opendaylight Controller datastore
"""
def __init__(self, additional_error_info='', err_code=1):
"""
ODL fail to get hosts from operational datastore error.
:param additional_error_info: the general error message.
:param err_code: the specific error code.
:type str
:type int
"""
CtrlError.__init__(self, 'ODL fail to get hosts from '
'operational datastore. {0}'.
format(additional_error_info), err_code)
[docs]class ODLGetOperFlowsError(CtrlError):
"""
Contains the exception handling concerning the returned flows from
Opendaylight Controller datastore
"""
def __init__(self, additional_error_info='', err_code=1):
"""
ODL fail to get installed flows from operational datastore error.
:param additional_error_info: the general error message.
:param err_code: the specific error code.
:type str
:type int
"""
CtrlError.__init__(self, 'ODL fail to get installed flows from '
'operational datastore. {0}'.
format(additional_error_info), err_code)
[docs]class ODLGetOperSwitchesError(CtrlError):
"""
Contains the exception handling concerning the returned switches from
Opendaylight Controller datastore
"""
def __init__(self, additional_error_info='', err_code=1):
"""
ODL fail to get topology switches from operational datastore error.
:param additional_error_info: the general error message.
:param err_code: the specific error code.
:type str
:type int
"""
CtrlError.__init__(self, 'ODL fail to get topology switches from '
'operational datastore. {0}'.
format(additional_error_info), err_code)
[docs]class ODLGetOperLinksError(CtrlError):
"""
Contains the exception handling concerning the returned links from
Opendaylight Controller datastore
"""
def __init__(self, additional_error_info='', err_code=1):
"""
ODL fail to get topology links from operational datastore error.
:param additional_error_info: the general error message.
:param err_code: the specific error code.
:type str
:type int
"""
CtrlError.__init__(self, 'ODL fail to get topology links from '
'operational datastore. {0}'.
format(additional_error_info), err_code)
