Skip to main content

Calling Synchronous WebServices Asynchronously from ADF Managed Bean

Recently I had to implement a SOAP webservice call from a af:commandButton action, but the requirement was to make it an asynchronous call. So that the user doesn't have to wait till the Webservice finish processing the request.

So I built :
  1. Interface which extends java.util.concurrent.Callable.
    • Interface so that I can use the same technique to call multiple Webservices, if required.
  2. A session scoped bean to invoke the above interface.
#1. Interface : WebserviceCallee

public interface WebserviceCallee<T> extends Callable<Boolean> {
    

    // Base URL of the Webservice to call
    public String getBaseUrl();
    public void setBaseUrl(String baseUrl);

    // To identify this object uniquely    
    public String getUniqueIdentifier();
}


#2. Implentation :  

public class WebServiceA implements WebserviceCallee<Boolean> {
   
    private static Log log = LogFactory.getLog(
WebServiceA.class);
   
    private String baseUrl;
    private Thread thread;

    private MyCustomObject myCustomObject;

    public
WebServiceA(MyCustomObject myCustomObject) {
         this.myCustomObject = myCustomObject;
         this.thread = Thread.currentThread();
    }

    public Boolean call() {
       
        Boolean callResult = Boolean.FALSE;
        

        // PLACE YOUR WEBSERVICE CALL HERE
        // MY WEBSERVICE RETURNED TRUE/FALSE, THAT'S WHY THIS METHOD RETURNS A Boolean
       
        return callResult;
    }
    

    public String getUniqueIdentifier() {
        return "
WebServiceA call for : " + myCustomObject.getUniqueID();
    }

    public void setBaseUrl(String baseUrl) {
        this.baseUrl = baseUrl;
    }

    public String getBaseUrl() {
        return baseUrl;
    }


#3. Session Scoped Bean : ExecutionService

public class ExecutionService {
   
    private static Log log = LogFactory.getLog(ExecutionService.class);
    private final ExecutorService executorService = Executors.newCachedThreadPool();
   
    Map<String, Future<Boolean>> submittedTasks = new SubmittedTaskMap<>();
   
    public ExecutionService() {
        super();
    }
   
    public static ExecutionService getInstance() {
       
        return (ExecutionService) JsfUtils.getExpressionValue("#{ExecutionService}");
    }
   
    public void submitCallables(WebserviceCallee<Boolean> webserviceCallee) {
       
        log.debug("thread spawnned for :" + webserviceCallee.getCalleeIdentity());
        Future<Boolean> future = executorService.submit(webserviceCallee);
        try {
            log.debug("thread result :" + future.get());
        } catch (ExecutionException e) {
            log.fatal(e);
        } catch (InterruptedException e) {
            log.fatal(e);
        }
        submittedTasks.put(webserviceCallee.getWorkorderNumber(), future);
    }

    public Map<String, Future<Boolean>> getSubmittedTasks() {
        return submittedTasks;
    }
   
    /**
     * Custom HashMap implementation to track the threads spawnned by WebService calls
     * @param <K>
     * @param <V>
     */
    public class SubmittedTaskMap<K,V> extends HashMap<String, Future<Boolean>> {
       
        public SubmittedTaskMap() {
            super();
        }
       
        /**
         * @param key
         * @return NULL if the thread has finished executing
         */
        @Override
        public Future<Boolean> get(Object key) {
            Future<Boolean> submittedTask = super.get(key);
            if(submittedTask != null) {
                if(submittedTask.isDone()) {
                    return null;
                }               
            }
            return submittedTask;
        }
    }
}
 
 


adfc-config.xml :
  <managed-bean id="es1">
    <managed-bean-name id="es2">ExecutionService</managed-bean-name>
    <managed-bean-class id="es3">my.bean.ExecutionService</managed-bean-class>
    <managed-bean-scope id="es4">session</managed-bean-scope>
  </managed-bean> 
 


#4. To invoke from ADF managed bean :

        WebServiceA webServiceA = new WebServiceA(myCustomObject);
        String baseUrl = ContextUtil.getContextProperty(FacesContext.getCurrentInstance(), WSBASEURL);
       
webServiceA.setBaseUrl(baseUrl);
        ExecutionService.getInstance().submitCallables(
webServiceA);  

NOTE :
This technique can also be used as a Singleton implementation. Just make the "ExecutionService" class Singleton. 
Please be aware about the thread usage and implementation, I have used "newCachedThreadPool" of Executors, please consult the documentation of  "java.util.concurrent.Executors" before implementing.

Comments

Popular posts from this blog

Rich Text Editor - Oracle JET

Oracle JET has a lot of excellent UI components, but according to Murphy's law, client always comes up with something which you don't have at your disposal. So, driven by one of my client's requirements, I created a Rich Text Editor or WYSIWYG editor for Oracle JET. This is based on Quill JS and fully customizable. Github project download: https://github.com/sohamda/JET-Web-Components/tree/master/rich-text-editor I will explain in this blog, on how to integrate it in your own Oracle JET project. 1. Create and initialize your JET application and then put the downloaded web component inside "src\js\jet-composites" folder. 2. Once copied update your viewModel first. Add a snippet for passing the default content to be displayed by the editor after load. 3. Update view to load this editor Above you can see the "toolbar-options" property, that controls which options you should display to user on the editor. Those are basically the forma

Create Micro CRUD services for Oracle Database Cloud using NodeJS

I will try to explain, how you can use NodeJS to create mirco services for the tables in your Oracle Database Cloud or on-premise Database. Complete Github project : https://github.com/sohamda/LeasifyAPIs You need to do "npm install" to download the node_modules. Step by Step guide : 1. NodeJS : either 32 or 64 bit. If you already have NodeJS installed, please check whether it is 64 or 32. Use below command to figure that out : C:\>node > require('os').arch() If you get : 'ia32' , then it is 32 bit installation. 2. Install oracle-db node module .  This was a lengthy and time consuming installation for me, because for Windows, it has a lot of pre-requisites. If you are a Mac user, you are lucky. :) I followed : https://community.oracle.com/docs/DOC-931127 There is also a detailed one in github : https://github.com/oracle/node-oracledb/blob/master/INSTALL.md 3. Config your DB Cloud Create a user and couple of tables on which we'

Layout Management & CSS Classes with Oracle JET

Oracle JET provides automatic responsive layout using CSS classes. So that, from large screens to small screens the application fits itself the best possible way. JET’s layout management are based on 2 types of CSS classes “Responsive Grid” and “Flex”. Responsive grid classes which deals with size, number of columns and functions of a particular <div>. Naming convention of these classes are oj- size - function - columns sizes can be: sm, md, lg, xl functions can be: hide, only-hide columns can be: any number between 1 to 12.   Just like Bootstrap, JET also divides the width of the available space into 12 columns, so for example, if you want a section of your page should take up atleast 5 columns if you divide the available screen into 12 columns, you need use : oj- size -5. Now comes the size part, you need to define that for each size of the screen, from hand-held mobile devices to large or extra large desktop screens. With combination with theses grid c