Developing your plugin with Active Objects

Here you will find all the documentation you need to develop your Active Objects plugin. This documentation is composed of two main parts:

• The library, which describes how one would use the Active Objects library to persist, retrieve and manipulate data from a given database. This part should be independent of any usage of Active Objects within the plugin system.
• The plugin, which describes how one uses Active Objects in an Atlassian plugin. Principles learnt in the previous section should apply to plugins as well. There might be additional constraints when running within the plugin framework that will be clearly identified here.

For the impatient, there is getting started information that you can follow to create your first Active Objects plugin. It should give you the basics for writing your own plugin and then coming back to the rest of the documentation you should be able to augment the functionality of your plugin easily.

Of course, there is also an Active Objects FAQ with simple and straight to the point answers to the most commonly asked questions. Questions there will refer to other parts of the documentation for more comprehensive information about the topic at hand.

Here is a table of content of the documentation you can find:

• The Active Objects Library -- Using the Active Objects library
  • Creating an EntityManager
  • Creating Entities
  • Deleting Entities
  • Finding Entities
  • Getting entities by PK
  • ManyToMany Relationship
  • OneToMany Relationship
  • OneToOne Relationship
  • Testing
• Active Objects FAQ -- This page should answer the most commonly asked question about developing a plugin using Active Objects
  • Table names -- How are database tables named?
  • Column names -- How are database columns named?
  • Enabling SQL logging -- How do I enable/disable SQL logging for Active Objects, the library and the plugin?
• Testing a plugin that uses Active Objects
• Configuring the Plugin
  • Configuring your project
  • Adding the maven dependency
  • Active Objects Plugin Module -- The Active Objects plugin module allows you to use the Active Objects service to persist data using the Active Objects library http://activeobjects.java.net.
• Upgrading your plugin and handling data model updates -- Sometimes your data model will evolve. This page will describe how to handle upgrades for various use cases of model changes.
• Best practices for developing with Active Objects