Monday, November 21, 2011

Invoking a web service from an ADF managed bean

In this post I describe how to invoke an external web service from an ADF managed bean.  The web service is represented by a web service proxy within the ADF Model project.  The proxy is exposed as a client method on the application module.  A method in a managed bean invokes the client method.

This example uses JDeveloper  The external web service is based on the Cue Cards example “Create a Web Service from a Java Class” found in the JDeveloper Help Center.

See Chapter 13 “Integrating Web Services Into a Fusion Web Application” in the Fusion Developer’s Guide for more information.

Create the proxy

1.       In the Model project, launch the Create Web Service Proxy wizard.

2.       Choose JAX-WS Style.

3.       Enter the WSDL URL and select Copy WSDL Into project.

4.       In the Specify Default Mapping Options window, enter package names that cleanly separate the proxy files from ADF BC components.  E.g., if your ADF BC components are under the package app1.model, then enter:
·         Package Name = app1.proxy.<proxy name>
·         Root Package for Generated Types = app1.proxy.<proxy name>.types

NOTE:  If the web service has asynchronous callback methods, the “Generate As Async” checkbox is enabled.  If you do not plan to use the callback methods, uncheck this box box.  Leaving the box checked creates un-needed web services and a WAR file in the project.

5.       If you do not use the asynchronous callback methods select “Don’t generate any asynchronous methods” in Step 6.

6.       Click Finish.

7.       The JDeveloper workspace looks like this.  Proxy files are cleanly separated from ADF BC components.  Note the jax-ws-catalog file under META-INF.  This is useful for editing the URL endpoint of the web service.

Create an application module method to invoke the proxy

1.       Generate an application module class and open it in the editor.  This is the <AppModule> file.

2.       Add a method that instantiates the proxy class and invokes the web service.  For example:

       public int getCreditRating(String ssn) {
           // Instantiate the proxy
           CreditRatingService svc = new CreditRatingService();
           CreditRating creditRating = svc.getCreditRatingSoap12HttpPort();
           // Invoke service
           int result;
           try {
               result = creditRating.processRating(ssn);
               System.out.println("  ==Got credit rating");
           } catch (Exception e) {
               result = -1;
               System.out.println("  ==Exception: " + e.getMessage());
           // Return result
           return result;

3.       Add the new method to the application module client interface

4.       Refresh the Data Control panel

5.       Open the page you want to invoke the method from > go to the Bindings tab > add the operation as an Action Binding

6.       You can now invoke the method from a managed bean, using code like this:

       public void onGetCreditRatingAction(ActionEvent actionEvent) {
           BindingContainer bc =
           OperationBinding ob = bc.getOperationBinding("getCreditRating");
           ob.getParamsMap().put("ssn", "123456789");
           System.out.println("  ==About to get credit rating ...");
           String result = (String)ob.execute();
           System.out.println("  ==Credit rating: " + result);

No comments:

Post a Comment