Usage of CDI in Oracle ADF - Part II - Enabling and using CDI

Hi,
I will bring some serie of posts about CDI usage within Oracle ADF:
Previously I have introduced Usage of CDI in Oracle ADF - Part I - Introduction. what are CDI Beans in Java EE 8 and why are them so important in Java Web Development.

Now, we are going to setup our ADF Project to be able to use CDI Beans.


How do I enable CDI in an ADF Application?

Important Update: Do not include CDI 2.0 or other Java Enterprise dependencies of higher versions that are shipped with Oracle WebLogic Server.

E.g.: Oracle WebLogic 12.2.1.3 is CDI 1.1. compatible

If you are using Maven or the classic JDeveloper Library manageemnt then add the Context and Dependency Injection library to your pom.xml



Also, you can add manually the CDI dependency as following:


            com.oracle.adf.library
            Contexts-and-Dependency-Injection
            12.2.1-3-0
            pom
            provided

Is it enough? No!!!, we need to create the beans.xml file.



So, not we are ready to use CDI Managed Beans and use the context and dependency injection from classes of other libraries!.

Remember, when using annotations such as @RequestScoped you must import the javax.enterprise.context.RequestScoped instead of the javax.faces.beans

You can find the code of this post in: https://github.com/DanielMerchan/adf


Test Cases


I have created the following classes:
  • CDI: RequestCDIBean, SessionCDIBean and ApplicationCDIBean are CDI Managed Beans

  • ADF: RequestJSFBean, SessionJSFBean and ApplicationJSFBean are ADF Managed Beans registered in adfc-config.xml and managed by ADF.

  • JSF: RequestJSFAnnBean and ApplicationJSFAnnBean are JSF Managed Beans registered using annotations. 

The RequestXXXBean are invoked from a button where you can test to @Inject or use @ManagedProperty annotation of JSF 2.2 to re-use Beans defined. 

As far as I remember the results of the research was:
  1. CDI Managed Bean could inject by using @Inject annotation all CDIs Beans (as expected) and... "JSF / ADF Managed Beans"?? Care and read below:

    However it is confusing!: By using @Inject in the attributes of type JSF / ADF Managed Bean were NOT really Injecting the Managed Bean defined using the JSF Scope Annotations. If you want to inject a JSF Managed Bean into a CDI Managed Bean you need to use the @ManagedProperty which is CDI compatible available in JSF 2.3+.

  2. JSF Managed Beans using annotations and managed by JSF 2.2 were able to @Inject the CDI Managed Beans by using the annotation, and @Inject the JSF / ADF Managed Beans by using @ManagedProperty annotation.

  3. ADF Managed Beans registered in adfc-config.xml could not use CDI Managed Beans (NullPointer) and cannot inject the ManageProperty using annotations.

Filling the gaps... workarounds and tips

  1.  If you have your Managed Beans defined in ADF configuration files such as adfc-config.xml or task-flow-definition.xml you cannot use @Inject for injecting CDI Managed Beans into them.

    Use OmniFaces 2.7 Beans Utility to get CDI Managed Beans inside of them:
    http://showcase.omnifaces.org/utils/Beans

    In the @PostConstruct method, use the Beans.getReference(YourCDIBean.class)
        /**
     * Post Construct which ensures the context-dependency injection is ready.
     */
    @PostConstruct
    public void init() {
        System.out.println("RequestJSFBean initiated");        
        // Get the CDI Managed Beans by using OmniFaces 2.7
        appCDIBean = Beans.getReference(ApplicationCDIBean.class);
    }
  2. Do NOT try to use ADF / JSF Managed Beans defined in adfc-config.xml / task-flow-definition.xml file in CDI Managed Beans.

Comments

Post a Comment

Popular posts from this blog

OJET: Inter-Module communication in TypeScript Template

Image
In this post I bring another example on how to Communicate Modules using the Oracle JET - TypeScript Template based on the Oracle JET Cookbook: InterModule Communication From now and so on will create multiple examples using TypeScript for those who are not familiar with it and wants to turn the Cookbook examples into TypeScript :). The example ( ojet-typescript-list-detail ) can be found as usual in my GitHub repository: https://github.com/DanielMerchan/ojet-examples This example is a bit different compared to the Cookbook example where the modules are not running at the same time within a Module. This example is built as described in the following images: Customers module acts as the Wrapper Module. It coordinates when to load the list and detail modules. Customers module makes use also of signals npm module for communication between Customers-List, Customers-Detail. Explanation of the Example customers.js is the coordinator responsible module for: initiali
Read more

OJET: Build and Deploy in an Application Server

Image
There are some other sources where an Oracle JET Application is packaged and deployed as a WAR in Oracle WebLogic Application Server (Arda Eralp) https://blogs.oracle.com/ardaeralp/deploy-oracle-jet-application-to-weblogic-server (Andrejus Baranovski's) http://andrejusb.blogspot.com/2016/07/serving-oracle-jet-application-from.html They may look bit old or maybe because they call directly grunt tasks by using the grunt-cli . In this post I will update a bit these posts in Oracle JET 6.1.0 and the usage of ojet build (instead of calling the grunt tasks) for also building the corresponding WAR file. The example can be found in my GIT repository: https://github.com/DanielMerchan/ojet-examples Let's start... Install grunt-war module in your Oracle JET Application. npm install grunt-war --save-dev Create a war.js (or call it whatever you want) in /scripts/grunt/config folder under your souce files. This is a sample code inside of it, check https://www.npmjs.com/packag
Read more

OJET: Select All options using only Checkboxset

Image
This is an example on how to select all other options by using another oj-checkboxset. GitHub: ojet-checkbockset-select-all The idea is to keep track of the selection and make use of the on-value-changed as described in the following code. self.colorOptions = ko.observableArray([ { id: "blueopt", value: "blue", color: "Blue" }, { id: "greenopt", value: "green", color: "Green" }, { id: "redopt", value: "red", color: "Red" }, { id: "limeopt", value: "lime", color: "Lime" }, { id: "aquaopt", value: "aqua", color: "Aqua" }, ]); self.selectAll = ko.observableArray([]); self.currentColor = ko.observableArray(["red"]); self.selectAllOptionChanged = (event) => { const newSelection = event.detail.value; if (newSelection.indexOf('all')
Read more