NF9 OSGi New Process Factory

From iDempiere en

Feature: New Process Factory and Process Annotations

Goal: Development

Developer: Hengsin (talk)


  • Implement a new process factory base class that's backed by Map and Lambda functional object.
  • Add org.adempiere.base.annotation.Process annotation and factory base class that discover and register classes with Process annotation.


With following process class:

public class MyTest extends SvrProcess {
       protected void prepare() {			

       protected String doIt() throws Exception {
           return null;

Developer can use one of the following approach:

1. At plugin Activator start method, register the process class.

public void start(BundleContext context) throws Exception {
   IMappedProcessFactory mappedFactory = Core.getMappedProcessFactory();
   mappedFactory.addMapping(MyTest.class.getName(), () -> new MyTest());

2. Create an osgi component, at the bind method for IMappedDocumentFactory service component.

public void bindService(IMappedProcessFactory factory) {
    factory.addMapping(MyTest.class.getName(), () -> new MyTest());

3. Create a subclass of MappedProcessFactory, register as IDocFactory service (DO NOT register as IMappedDocumentFactory service).

public class MyFactory extends MappedProcessFactory {	
    public MyFactory() {
        addMapping(MyTest.class.getName(), () -> new MyTest());

4. IDEMPIERE-5001 added scan(BundleContext context, String... packages) method to IMappedProcessFactory and MappedProcessFactory. Developer can call that at plugin Activator start method to register process classes with org.adempiere.base.annotation.Process annotation.

 public void start(BundleContext context) throws Exception {
      //replace org.idempiere.test.process with package name of your process classes
      Core.getMappedProcessFactory().scan(context, "org.idempiere.test.process");


1. org.adempiere.base.annotation.Process annotation with optional name parameter. A process class is always register to its fully qualify class name and the name parameter allow developer to add an alternate register name for the process class.

2. Plugin should either use the method 4 above or create a new OSGi component that extends the AnnotationBasedProcessFactory class (usually with @Component(immediate = true, service = IProcessFactory.class, property = {"service.ranking:Integer=1"}) component annotation).

  public class BPartnerValidate extends SvrProcess  {

Technical Info: IDEMPIERE-4689, IDEMPIERE-5001

Cookies help us deliver our services. By using our services, you agree to our use of cookies.