Equinox Integration 2/Tutorial Extension Point

From ADempiere ERP Wiki
Revision as of 00:14, 23 November 2010 by Red1 (talk | contribs) (credits to Joerg Viola)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

by Joerg Viola

If you want to extract some functionality out of the core and provide a new extension point so that plug-ins can provide an extension, read on.

Example: Let plugins implement how invoices are posted to FACT.

Replace core code by call to service[edit]

  • Navigate to Doc_Invoice.createFacts()
  • Insert the line IInvoicePoster invoicePoster = Service.locator().getInvoicePoster(). Eclipse will highlight some errors, we will repeatedly use Code assist (Ctrl-1) to proceed.
  • Position the cursor on IInvoicePoster, create new interface using code assist.
    • Create the interface in the package org.adempiere.base
    • In this package, all core interfaces should reside.
    • Create the (empty) interface and save.
  • Back to Doc_Invoice, position the cursor on getInvoicePoster(), create new method using code assist.
    • The new method is inserted in the interface IServiceLocator. Save it.
  • Back to Doc_Invoice, insert the line invoicePoster.post()
  • create new method post() using code assist.
    • The method is inserted into the new interface IInvoicePoster

Locate and define extension point[edit]

  • Notice there is now a compile error in EquinoxServiceLocator. This is the equinox implementation of IServiceLocator. It now lacks the implementation of getInvoicePoster().
    • We want to invoke an extension. So we look for extensions by an extension point id, say org.adempiere.base.InvoicePoster.
    • This is done by the ExtensionList (Beware! If more than one plugin will be installed providing extensions to InvoicePoster, only one will be executed this way. You can nevertheless iterate over all extension using ExtensionList, if you want.):
	public Callout getInvoicePoster() {
		ExtensionList<IInvoicePoster> list = 
                   new ExtensionList<IInvoicePoster>(IInvoicePoster.class, "org.adempiere.base.InvoicePoster");
		return list.first();
  • The last step is defining the extension point. Open base/META-INF/MANIFEST.MF, the description of the base Plugin.
    • Open the tab "Extension Points"
    • Click add.
    • Enter the id given above, fill the other fields an click Finish.
    • The extension point schema opens. Enter some explanation and open tab "Definition".
    • Click "New Element".
    • Add New Element
    • Name it client.
    • On client, add a New Attribute
    • Name it class, type is java, on implements, choose the interface IInvoicePoster
    • Select extension, add New Choice, from its context, add new client.
  • Save all files, you're ready.

Write the plugin[edit]

  • Now what is left? - We want the move code outside the core into a plugin. So lets do that.
  • Create a New project, from "Plug-in Development", choose "Plug-in project".
  • The manifest editor opens.
    • Open tab "Dependencies", add "org.adempiere.base" as a required plugin.
    • Open tab "Extensions", add "org.adempiere.base.InvoicePoster" extension point
    • On this point, add via context add a new "client"
    • Via click on the label of the class attribute, create a new implementation of the interface InvoicePoster, say MyInvoicePoster
    • look out! - it automagically has an empty post() method
  • Now Move the code from the original createFacts() method to the newly created post method.
    • This step may include a little more work on sorting out modularity issues.
  • Deploy your new plugin as well as the base plugin and watch it running.
  • Congratulations, ADempiere core is now more modular, thank you!

Return to ADempiere/Equinox Integration 2