The Latest Oracle E-Business Suite Technology News direct from
Oracle E-Business Suite Development & Product Management

Building Extensions Using E-Business Suite SDK for Java

Guest Author

Guest Author: Sara Woodhull

We’ve just released Version 2.0.1 of Oracle E-Business Suite SDK for Java.  This new version has several great enhancements added after I wrote about the first version of the SDK in 2010.  In addition to the AppsDataSource and Java Authentication and Authorization Service (JAAS) features that are in the first version, the Oracle E-Business Suite SDK for Java now provides:

  • Session management APIs, so you can share session information with Oracle E-Business Suite
  • Setup script for UNIX/Linux for AppsDataSource and JAAS on Oracle WebLogic Server
  • APIs for Message Dictionary, User Profiles, and NLS
  • Javadoc for the APIs (included with the patch)
  • Enhanced documentation included with Note 974949.1
Integration between custom apps and EBS

These features can be used with either Release 11i or Release 12. 


What's new in those references?

Note 974949.1 is the place to look for the latest information as we come out with new versions of the SDK.  The patch number changes for each release.  Version 2.0.1 is contained in Patch 13882058, which is for both Release 11i and Release 12.  Note 974949.1 includes the following topics:

  • Applying the latest patch
  • Using Oracle E-Business Suite Data Sources
  • Oracle E-Business Suite Implementation of Java Authentication and Authorization Service (JAAS)
  • Utilities
  • Error loggingSession management 
  • Message Dictionary
  • User profiles
  • Navigation to External Applications
  • Java EE Session Management Tutorial

For those of you using the SDK with Oracle ADF, besides some Oracle ADF-specific documentation in Note 974949.1, we also updated the ADF Integration FAQ as well.

EBS SDK for Java Use Cases

The uses of the Oracle E-Business Suite SDK for Java fall into two general scenarios for integrating external applications with Oracle E-Business Suite:

  1. Application sharing a session with Oracle E-Business Suite
  2. Independent application (not shared session)

With an independent application, the external application accesses Oracle E-Business  Suite data and server-side APIs, but it has a completely separate user interface. The external application may also launch pages from the Oracle E-Business Suite home page, but after the initial launch there is no further communication with the Oracle E-Business Suite user interface.

Shared session integration means that the external application uses an Oracle E-Business Suite session (ICX session), shares session context information with Oracle E-Business Suite, and accesses Oracle E-Business Suite data. The external application may also launch pages from the Oracle E-Business Suite home page, or regions or pages from the external application may be embedded as regions within Oracle Application Framework pages.

Both shared session applications and independent applications use the AppsDataSource feature of the Oracle E-Business Suite SDK for Java. Independent applications may also use the Java Authentication and Authorization (JAAS) and logging features of the SDK.

Applications that are sharing the Oracle E-Business Suite session use the session management feature (instead of the JAAS feature), and they may also use the logging, profiles, and Message Dictionary features of the SDK.  The session management APIs allow you to create, retrieve, validate and cancel an Oracle E-Business Suite session (ICX session) from your external application.  Session information and context can travel back and forth between Oracle E-Business Suite and your application, allowing you to share session context information across applications.

Note: Generally you would use the Java Authentication and Authorization (JAAS) feature of the SDK or the session management feature, but not both together.

Send us your feedback

Since the Oracle E-Business Suite SDK for Java is still pretty new, we’d like to know about who is using it and what you are trying to do with it.  We’d like to get this type of information:

  • customer name and brief use case
  • configuration and technologies (Oracle WebLogic Server or OC4J, plain Java, ADF, SOA Suite, and so on)
  • project status (proof of concept, development, production)
  • any other feedback you have about the SDK

You can send me your feedback directly at Sara dot Woodhull at Oracle dot com, or you can leave it in the comments below.  Please keep in mind that we cannot answer support questions, so if you are having specific issues, please log a service request with Oracle Support.

Happy coding!

Related Articles

Join the discussion

Comments ( 5 )
  • Amit Thursday, July 12, 2012

    Nice article.

  • guest Friday, September 21, 2012

    Steve - Thanks for the detailed Blog on this. We are on Oracle EBS 11.5.10 and at least an year away from R 12, however interim we loved ADF & would like to start use ADF (Weblogic) as standalone application, with possibility to :

    1. Have ADF Pages be Invoked from EBS defined Menu, Function based security ie. user should not ideally need to login twice.

    2. Possibility to come to back to EBiz Suite Home Page once user is done on ADF application.

    Can you please confirm if this could be possibility and if so detailed step by step guideline on what to be done to make this happen.

    Thanks much,


  • Manoj Friday, June 7, 2013


    Seems like the Login Module that comes with the FndExt.jar doesn't respect the IdentityAssertion (done by an OAM Asserter). It always requests for UserName and Password callbacks. Is there any way we can integrate the custom ADF app that is using the ExtAuthenticator to integrate with OAM SSO?



  • guest Thursday, September 12, 2013


    Just wondering how we would implement User Lockout functionality (or if this is built into the JAAS module and just needs activating) for our application?

    At the moment I am looking at extending the Login Bean of our ADF Application to track the number of attempts and then lock the EBS Account, however this just feels wrong (Security as I understand it is handled by Weblogic and the Apps defer to WL), I would hope that WL would be able to expire the EBS user accounts...

    Thanks for your blog post!


  • Jim Wednesday, March 4, 2015

    Will this work with the new ADF 12c or just 11g?

Please enter your name.Please provide a valid email address.Please enter a comment.CAPTCHA challenge response provided was incorrect. Please try again.