Lab 04 - SOAP to REST (Optional)

Return to Workshop

Lab 4

SOAP to REST (Optional)

Contract-first API development wrapping an existing SOAP service, implemented using Eclipse Che


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?

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

Lab Instructions (Optional)

Step 1: Import the sample SOAP project into your Openshift project

  1. Navigate back to your Eclipse Che workspace and open the terminal window.

  2. Log into the Openshift console:

  3. Obtain your user login command by clicking on your username on the top right hand corner and select Copy Login Command

  4. Paste the login command for Openshift via the Terminal window. Use the double check the {OPENSHIFT_APP_URL} matches the environment given to you by the instructor

    oc login  {OPENSHIFT_APP_URL} --token=XXXXX
  5. Build and deploy the SOAP application using source to image(S2i) template. Paste the commend to the terminal.

    oc new-app s2i-fuse71-spring-boot-camel -p GIT_REPO= -p CONTEXT_DIR=/projects/location-soap -p APP_NAME=location-soap -p GIT_REF=master -n [OCPPROJECT]

    *Remember to replace the [OCPPROJECT] with the OpenShift project(NameSpace) you used in last lab. [OCPPROJECT] should be your username*

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

Step 2: Modify the skeleton location-soap2rest project

  1. In the OpenShift console, click on the route associated with the location-soap deployment. A pop-up will appear. Append the /ws/location?wsdl path to the URI and verify the WSDL appears. Copy the link to the clipboard.

  2. Return to your Eclipse Che 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.
    • Be sure to replace userX with your username.

  3. We now need to generate the POJO objects from the WSDL contract. To do this, change to the Manage commands view and double-click the run generate-sources script. Click Run to execute the script.

  4. 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.

  5. Open up the file. 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 after the camelContext and before the @Override.

    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";
    public void configure() throws Exception {
  6. Next after the restConfiguration() method, we need to create our Camel route implementation and create the RESTful endpoint.

    • To do this, include the following code (making sure to update the {YOUR_NAME_SPACE}, {OPENSHIFT_APP_URL} and username values in the to("cxf:// URL):
    • For example YOUR_NAME_SPACE should be userX and {OPENSHIFT_APP_URL} could be
    • Check with your instructor if you are not sure.

      rest("/location").description("Location information")
          .get("/contact/{id}").description("Location Contact Info")
              .responseMessage().code(200).message("Data successfully returned").endResponseMessage()
                  new Processor(){
                      public void process(Exchange exchange) throws Exception {
                          //LocationDetail locationDetail = new LocationDetail();
                          MessageContentsList list = (MessageContentsList)exchange.getIn().getBody();
  7. Now that we have our API service implementation, we can try to test this locally. Navigate back to the Manage commands view and execute the run spring-boot script.

    • Make sure any previous runs from prior labs are stopped
    • Click the Run button.

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

  9. In the new tab, append the URL with the following URI: /location/contact/2

    • A contact should be returned:

  10. 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 Cancel.

  11. Open the fabic8:deploy script and hit the Run button to deploy it to OpenShift.

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

  13. Click on the route link above the location-soap2rest pod and append /location/contact/2 to the URI. As a result, you should get a contact back.

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


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

Return to Workshop