pyjen.utils.plugin_base module

Declaration for abstract base class to be used by all PyJen plugins

class pyjen.utils.plugin_base.PluginBase

Bases: object

Abstract base class common to all PyJen API plugins

All PyJen plugins must derive, directly or indirectly, from this class and implement its abstract interface

Most plugins will derive directly from this class, however plugins that extend the native Jenkins objects like views and jobs must derive from their appropriate base classes instead. Any class that supports such extensions will, themselves, derive from this class, including View and Job.

type

The Jenkins plugin descriptive name, used when instantiating objects of that type

Some examples from the built-in plugins are:

• “hudson.scm.NullSCM”
• “hudson.scm.SubversionSCM”
• “hudson.model.MyView”

These names can typically be copied verbatim from the XML node in the Jenkins config.xml for the entity that describes the plugin properties. The name should be defined by an XML attribute named “class”. Here is an example of the SVN plugin XML

<scm class="hudson.scm.SubversionSCM" plugin="subversion@2.3">

For plugins that extend Jenkins native objects like views and jobs the plugin name will be defined in the name of the tag itself, like this

<hudson.plugins.nested__view.NestedView plugin="nested-view@1.14">

TIP: When implementing this property on a concrete class, you will need to declare a static class attribute for the PyJen plugin API to work correctly, something like

class MyClass(PluginBase):
    type = "my.name.of.plugin"

Returns:Jenkins plugin descriptive name, used when instantiating objects of that type Return type:str