rPath Appliance Platform Agent:API for Plugin Development
From rPath Wiki
rPath Appliance Platform --> Agent --> Plugins --> Plugin Development --> rAPA API for Plugin Development
rPath recommends that plugin developers reference the code in the rPath Appliance Platform Agent standard plugins for reference while developing new plugins. To learn more about what the code means, reference the rAPA 3.0 API documentation throughout the plugin development process. This page outlines rAPA modules and classes to reference during plugin development, including links to their associated pages in the API documentation.
| Class | Description |
|---|---|
| raa.authenticate 2.1 raa.authenticate 3.0 | Module that handles authenticating a rAPA user, determining what permissions the user has based on rAPA groups |
| raa.db.schedule 2.1 raa.db.schedule 3.0 | Module that controls task scheduling in rAPA |
| raa.lib.command 2.1 raa.lib.command 3.0 | Helper functions for executing external commands |
| raa.lib.conaryutils 2.1 raa.lib.conaryutils 3.0 | Helper functions and classes for interfacing with Conary |
| raa.lib.json 2.1 raa.lib.json 3.0 | Helper functions for using JSON |
| raa.lib.mount 2.1 raa.lib.mount 3.0 | Helper functions for mounting and unmounting file systems |
| raa.lib.notices 2.1 raa.lib.notices 3.0 | Helper functions for subscribing and unsubscribing to notices |
| raa.lib.repeatschedules 2.1 raa.lib.repeatschedules 3.0 | Helper functions for creating and querying repeating schedules |
| raa.lib.url 2.1 raa.lib.url 3.0 | Helper functions for handling URLs |
| raa.lib.validate 2.1 raa.lib.validate 3.0 | Helper functions for validating user input |
| raa.modules.raarpcplugin.rAARpcPlugin 2.1 raa.modules.raarpcplugin.rAARpcPlugin 3.0 | Base class for the facade layer of a plugin |
| raa.modules.raawebplugin.rAAWebPlugin 2.1 raa.modules.raawebplugin.rAAWebPlugin 3.0 | Base class for the web component for rAPA plugins |
| raa.web 2.1 raa.web 3.0 | Module with functions that control the web "front end" |
NOTE: Functions and classes whose name start with an underscore ("_") such as "_raa.example" are private and cannot be used by custom rAPA plugins. All other functions and classes are public.
 | TurboGears has been replaced by CherryPy in the rPath Appliance Platform Agent version 3.x and higher. Please see here for changes between 2.x and 3.x |