Usage of CDI in Oracle ADF - Part I - Introduction

Hi,

I will bring some serie of posts about CDI usage within Oracle ADF:
In this series of post I will bring a common topic around development in Oracle ADF 12cR2 for Java EE / Jakarta EE developers who has been using also JSF 2.3.

Some history on JSF and Managed Beans

Looooong time ago... JSF as other frameworks introduced a way on how the objects are created, injected and used without the need of making explicit new in our code for memory optimisation etc...

In JSF, JSF Managed Beans are defined in the faces-config.xml and managed by the JSF Framework.
Remember that Annotations for JSF Managed Beans were introduced in JSF 2.0 allowing us to declare the JSF Managed Beans within the class itself instead of registering in a faces config file.


Note: The JSF annotations are located under javax.faces.beans package. However, they have been deprecated in JSF 2.3 and possibily in the future they will be removed.
So the recommendation is to use CDI beans in JSF world!.

CDI vs JSF Managed Beans. Why CDI? 

Just some comments:
  • CDI allows a complete Java EE / Jakarta EE-wide application injection (included POJOs) where JSF only allows a subset in terms of injection.

  • JSF Beans are managed by JSF and CDI is managed by the app container.

  • JSF Managed Beans are deprecated since JSF 2.3. So they will be removed!. So CDI will be the only one to manage and decide when to create and destroy Managed Beans.

CDI Managed Beans vs ADF Managed Beans 

Those are the Scopes available in CDI and ADF.


ADF Managed Bean Scope
CDI Scope
Common used for…
Backing Bean Scope
-
Usually used within in Oracle ADF for managing UI Components, Events and Actions that can be taken in a specific fragment or screen.

There is not Backing Bean equivalent in CDI.
Request Scope
RequestScoped
(javax.enterprise.context)
Uses in ADF for a Managed Bean for a single request but can be shared by multiple Task Flow or components within the same request (little bit wider than Backing Bean Scope).

In CDI used for Managed Beans which are not required to persist longer than a request.
View Scope
ViewScoped
(java.faces.view)
Used to keep the information within the same view across multiple requests.

The ADF View Scope and the CDI ViewScoped are different. An ADF View Scope can be scoped to a specific fragment of af:region (which is not accessible from the parent page).
Page Flow Scope
FlowScoped
(javax.faces.flow)
Used to keep the information during a flow of fragments / pages.

The ADF Page Flow Scope is for being used in ADF Task Flows and the JSF Flow Scope and not compatible as is intented to be used within JSF Page Flows.
Session Scope
SessionScoped
(javax.enterprise.context)
Used to keep beans / information alive within all the user session.
Application Scope
ApplicationScoped
(javax.enterprise.context)
Used to keep beans alive for the entire application and shared by multiple sessions.
-
ConversationScoped
(javax.enterprise.context)
A developer can start / destroy a Managed Bean in ConversationScoped.

For example if a Managed Bean is only needed for a certain steps of the JSF Lifecycle


As you can see, ViewScoped and FlowScoped remains in a separate faces package as they are special for Java Server Faces Development. But, they are 100% CDI compatible.

In addition, I have omitted some pseudo-scopes like Dependant or Singleton. You can find more and better information online of them!

The question is... I am in ADF... Can I use CDI in Oracle ADF?


Yes, but with limitations or workarounds in some cases:
  • Oracle ADF still uses its own Page Flow Scope definition which differs from the FlowScoped of CDI. So the Flow Scoped scope and the FlowMap.

  • Oracle ADF defines its own ViewScope which differs from the ViewScoped of CDI.

  • Injection. In Oracle ADF you cannot use the ManagedProperty CDI compatible implementation due to is included as part of JSF 2.3+. If you want to @Inject a CDI in an ADF Managed Bean you can use OmniFaces Beans utility to get the CDI Bean!. http://showcase.omnifaces.org/utils/Beans  

  • CDI version: Oracle WebLogic 12.2.1.3 is shipped with CDI 1.1, so 1.2 and 2.0 capabilities such as Asynchronous events are not supported!.

I will extend this information with examples in the following posts, this is just an introduction!

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