walkthrough.adoc

Developer Lab 4 - SOAP to REST Transformation

In this lab, we will be using existing legacy SOAP service and wrap it with a new RESTful endpoint

Audience: Developers, Architects

Overview

Another important use case in developing API’s is to take an existing legacy SOAP service and wrap it with a new RESTful endpoint. This SOAP to REST transformation is implemented in the API service layer (Fuse). This lab will walk you through taking an existing SOAP contract (WSDL), converting it to Java POJO’s and exposing it using Camel REST DSL.

Why Red Hat?

CodeReady Workspaces, our online IDE, provides important functionality for implementing API services. In this lab you can see how our CodeReady Workspaces and Fuse can help with SOAP to REST transformation on OpenShift.

Skipping The Lab

If you are planning to follow to the next lab or are having trouble with this lab, you can reference the working project here

Credentials:

Your username is: {user-username}
Your password is: openshift

CodeReady

• CodeReady

OpenShift Console

• Console

Import the sample SOAP project into your OpenShift project

1. Navigate back to your CodeReady Workspaces workspace and open the terminal window.

2. Ensure you are using the OpenShift tools terminal and are logged in to your OpenShift console as in the last lab.

   

3. Ensure you are in the {user-username} project in openshift:

    oc project {user-username}

4. Build and deploy the SOAP application using source to image(S2i) template. Paste and run the command to the terminal. The app will take a couple of minutes to get deployed on OpenShift

    oc new-app s2i-fuse71-spring-boot-camel -p GIT_REPO=https://github.com/RedHat-Middleware-Workshops/dayinthelife-integration -p CONTEXT_DIR=/projects/location-soap -p APP_NAME=location-soap -p GIT_REF=master -n {user-username}

5. Once the build and deploy is complete, navigate back to your OpenShift web console and verify the project is running.

   

Were you able to build and deploy the SOAP application?

Try to redo this section, if any problem persists have your instructor check the Kubernetes pod that contains the SOAP application.

Modify the skeleton project

1. In the OpenShift console, click on the route associated with the location-soap deployment.

   

2. A pop-up will appear. Append the /ws/location?wsdl path to the URI and verify the WSDL appears. Make sure you use http instead of https for the rest of the lab. Copy the link to the clipboard.

   

   Note	The link from Code Ready Workspaces uses https protocol, change the URL to use http for the WSDL to load. Use the http endpoint for the rest of the lab.

3. Return to your CodeReady Workspaces workspace and open the dayintelife-import/location-soap2rest project. Open the pom.xml file and scroll to the bottom. Uncomment out the cxf-codegen-plugin entry at the bottom. Update the <wsdl> entry with your fully qualified WSDL URL e.g. http://location-soap-{user-username}.{openshift-app-host}/ws/location?wsdl.

   

4. We now need to generate the POJO objects from the WSDL contract.

5. Navigate to the following project in the Terminal:

   cd /projects/DILAgileIntegration/location-soap2rest

6. Run the following maven command from the Terminal:

   mvn generate-sources

7. Once the script has completed, navigate back to the Workspace view and open the src/main/java/com/redhat folder. Notice that there are a bunch of new POJO classes that were created by the Maven script.

   Common gotcha: If build fails due to used port, check if you are running with many instances of run spring-boot. You should only have 1 instance of run-spring-boot.

   

Were you able to generate the POJO classes?

Try to redo this section, if any problem persists have your instructor check the Kubernetes pod that contains the CodeReady Workspaces application.

Update the Camel Route

1. Open up the CamelRoutes.java file under 'src/main/java/com/redhat' folder. Notice that the existing implementation is barebones. First of all, we need to enter the SOAP service address and WSDL location for our CXF client to call.

    ...
   
    @Autowired
    private CamelContext camelContext;
   
    private static final String SERVICE_ADDRESS = "http://localhost:8080/ws/location";
    private static final String WSDL_URL = "http://localhost:8080/ws/location?wsdl";
   
    @Override
    public void configure() throws Exception {
   
    ...

2. Secondly, we need to create our Camel route implementation and create the RESTful endpoint(still in the CamelRoutes.java file). Make sure the values to (cxf:// URL): are correct

    ...
   
        rest("/location").description("Location information")
            .produces("application/json")
            .get("/contact/{id}").description("Location Contact Info")
                .responseMessage().code(200).message("Data successfully returned").endResponseMessage()
                .to("direct:getalllocationphone")
   
        ;
   
        from("direct:getalllocationphone")
            .setBody().simple("${headers.id}")
            .unmarshal().json(JsonLibrary.Jackson)
            .to("cxf://http://location-soap-{user-username}.{openshift-app-host}/ws/location?serviceClass=com.redhat.LocationDetailServicePortType&defaultOperationName=contact")
   
            .process(
                    new Processor(){
   
                        @Override
                        public void process(Exchange exchange) throws Exception {
                            //LocationDetail locationDetail = new LocationDetail();
                            //locationDetail.setId(Integer.valueOf((String)exchange.getIn().getHeader("id")));
   
                            MessageContentsList list = (MessageContentsList)exchange.getIn().getBody();
   
                            exchange.getOut().setBody((ContactInfo)list.get(0));
                        }
                    }
            )
   
        ;
   
    ...

3. Now that we have our API service implementation, we can try to test this locally. Navigate back to the Terminal and execute the following command:

   mvn spring-boot:run

   

4. Once the application starts, navigate to the Servers window and click on the URL corresponding to port 8080. A new tab should appear.

5. In the new tab, append the URL with the following URI: /location/contact/2. Make sure it’s http and not https . A contact should be returned:

   

6. Now that we’ve successfully tested our new SOAP to REST service locally, we can deploy it to OpenShift. Stop the running application by clicking Ctrl + C.

7. Run the following command in the terminal to deploy the application to OpenShift. The app will take a couple of minutes to get deployed on OpenShift:

   mvn fabric8:deploy

   

8. If the deployment script completes successfully, navigate back to your OpenShift web console and verify the pod is running

   

9. Click on the route link above the location-soap2rest pod and append /location/contact/2 to the URI. Make sure it’s http and not https. As a result, you should get a contact back.

Were you able to retrieve a contact?

Try to redo this section, if any problem persists have your instructor check the Kubernetes pod that contains the CodeReady Workspaces application.

Congratulations! You have created a SOAP to REST transformation API.

Overview

You have now successfully created a contract-first API using a SOAP WSDL contract together with generated Camel RESTdsl.

You can now proceed to Lab 5.