Home | Trees | Indices | Help |
|
---|
|
Version class represents the version of a onePK component. The component could be the client-side package version or the server-side version. For onePK applications to work, the server-side and the client-side versioning have to be compatible. onePK has foundation package and optional packages (e.g. LISP, VTY etc) Each of these packages have a server side which resides on the Network Element and a client side which resides in the application in any of the hosting models. The client side corresponds to the SDK package used by application. The onePK server side as well as client-side versions are identified with a version number in the form of: "<b><i>major.minor.maintenance</i></b>" Any "major" release upgrade is not backward compatible, whereas any "minor" or "maintenance" release upgrade is backward compatible. - Major version number reflects the main version of the package and changes only when API signatures changes in non-compatible way. - Minor version numbers changes when new functionalities are added, such as addition of new API, or addition of a new parameter to an API in backward-compatible way. - Maintenance version numbers changes with bug fixes, document changes or support library changes. The usage of versioning by applications is described below. Consider the case where the application client side is running a higher minor version than the server side. Case 1: Application does no version checking. In this case calling a method not supported on the connected Network Element will result in application runtime fault (application will receive exception specifying the method is not supported, causing it to abort). Case 2: Application checks versions and exits gracefully. In this case there is no runtime fault and application can exit gracefully. Case 3: Application checks versions, and continues. When Application knows that it only uses Network Element-supported methods there is no problem. When Application uses methods not supported on the connected Network Element, it would need to set a condition that causes the application to synthesize the missing functionality using only the Network Element supported methods instead.
Instance Methods | |||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from |
Class Methods | |||
|
|||
|
|||
|
Class Variables | |
VersionCompare = enum('ONEP_VERSION_NCP', 'ONEP_VERSION_MATCH' The VersionCompare enum describes the comparison values when the * versions of SDK and Network Element are compared using the * version check methods in Version class. |
Instance Variables | |
major Major version of the Version object |
|
minor Minor version of the Version object |
|
maintenance Maintenance version of the Version object |
Properties | |
Inherited from |
Method Details |
Constructor for internal use only.
|
This method gets the package (Service Set) version which this client program is currently using.
|
This method gets the Service Set version of the given Network Element.
|
This method checks version compatibility between the a given Network Element and this client program. The result of the compatibility check is provided in the form of VersionCompare enum values. The specified Network Element should be in the connected state for the API to validate the compatibility check. The results of the comparison should be interpreted as follows:
|
This method checks if the Version instance matches a given specific major number.
|
This method checks if the Version instance matches a given specific minor number.
|
This method checks if the Version instance matches a given specific maintenance number.
|
This method checks if this Version instance matches a given specific major, minor and maintenance number.
|
str(x)
|
Class Variable Details |
VersionCompareThe VersionCompare enum describes the comparison values when the * versions of SDK and Network Element are compared using the * version check methods in Version class.
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Mon Aug 18 09:17:27 2014 | http://epydoc.sourceforge.net |