Siva's Blog

In this post, you will learn to create REST enabled business services. We will create business service to call the Proxy Service created in previous post.

You can create Business Services directly using WADL if it’s available, or using REST binding wizard similar to Proxy Services. As mentioned earlier, REST Business services convert payload from SOAP to REST i.e. the internal interface is still based on WSDL, while the external business and proxy services expose REST endpoints.

Using WADL:

Drag REST binding into External Services swim lane in Service Bus overview editor as shown below.

Give name as EmployeeBS and Base URI and choose the option as shown below in Operation binding.

Select the WADL as shown below. You can also observe that you can choose resource from several places including MDS.

Click OK and verify that Operation Bindings are populated as shown below.

Click OK to finish the Business service creation.

Using REST Binding:

The steps for creating REST binding for business service are similar to Proxy Service. So follow the steps mentioned in section Creating REST Binding of previous post except giving the base URI.

Testing:

Run the business service and you will observe both SOAP and REST interfaces as shown below along with available operations.

/Employees Resource:

GET:

POST:

PUT:

/Employees/{employeeId} Resource:

GET:

DELETE:

Similarly, you can run SOAP interface of business service by choosing operation and observe the output.

Note: This post is based on SOA 12.1.3 release.

In this post, you will learn to expose Proxy Services as REST services. We will use Employees table and come up with REST API that can be used to perform CRUD operations.

This post assumes knowledge of DB connection pool setup and Pipelines.

Creating Business Service

Create the business service using DB Adapter with the help of following steps.

Click Finish and verify that business service has been created as shown below.

Refactor all the artifacts to BusinessService directory.

Now you can test business service alone to make sure that all operations are working fine as expected. You can refer to this post for detailed steps.

Creating REST Binding

We want our REST resource to support the following operations:

In Service Bus 12c, REST proxy services convert REST native payload to SOAP before invoking a pipeline or split-join, while REST business services convert payload from SOAP to REST. That means, the internal interface is still based on WSDL, while the external business and proxy services expose REST endpoints. This will be evident in later steps as service bus creates both WADL and WSDL files and each resource is mapped to different operations defined in WSDL.

Drag REST binding into Proxy Services swim lane in Service Bus overview editor as shown below.

This brings up Create REST binding window. Give the name as shown below.

Click + icon for Resources to add new resource and click OK.

Similarly add another resource /Employees/{employeeId}. Now your resources should look like below.

Now you have to create the corresponding Operation Bindings which in turn creates WSDL with these operations.

Operation Bindings for resource /Employees:

Use the following steps to create GET mapping.

Here we are selecting both XML and JSON as we want our API to support both content types. Click on highlighted icon to define schema on fly representing the output payload. Enter file name and give directory name as ProxyService as shown below.

Click Next and choose file type as JSON.

Click Next and give Target namespace and Root element as shown below and you can use the following JSON payload sample.

{
“Employee” : [{
“employeeId”: “100”,
“firstName”: “fname”,
“lastName”: “lname”,
“email”: “fn@gmail.com”,
“phoneNumber”: “9848012345”,
“jobId”: “100”,
“salary”: “100”,
“commissionPct”: “100”,
“managerId”: “100”,
“departmentId”: “100”
},
{
“employeeId”: “101”,
“firstName”: “fname1”,
“lastName”: “lname1”,
“email”: “fn1@gmail.com”,
“phoneNumber”: “9848012345”,
“jobId”: “100”,
“salary”: “100”,
“commissionPct”: “100”,
“managerId”: “101”,
“departmentId”: “101”
}]
}

Click Next and verify the schema that gets generated.

Click Next and Finish and verify that schema URL is populated in Response tab.

Click OK and verify Operation Bindings are populated as shown below.

Use the following steps to create POST mapping by reusing existing schema.

Similarly, finish mapping for PUT and use operation name as updateEmployee. Now your Create REST binding window should look like below.

Click OK. You will observe that Proxy Service, WADL and WSDL have been  created as expected.

You will also observe errors, as XSD file is created in ProxyService folder whereas WADL and WSDL got created in Resources folder. So open WADL and WSDL files and modify the XSD reference as shown below to resolve errors.

Operation Bindings for resource /Employees/{employeeId}:

You should reuse the schema created in above steps for this resource as well.

Now in Service Bus overview editor, right click EmployeeService and select Edit REST as shown below.

Use the following steps to create GET mapping.

You can leave schema for request as it is so that it will be defaulted by the wizard.

Click OK and your Update Service window should look like below.

Similarly finish DELETE method by using operation name as deleteEmployee and now your Update Service window should look like below.

Click OK and observe the WADL and WSDL files that got updated with your new operation bindings. If you observe that WADL is not updated just do refresh as shown below.

WADL:

WSDL:

With this, you have finished the REST interface that is exposed to consumers.

Creating Pipeline:

Create new pipeline EmployeePipeline using EmployeeService.wsdl as shown below.

Connect EmployeeServcie proxy service with EmployeePipeline in Service Bus overview editor as shown below.

We will not discuss much about finishing the message flow in pipeline as it’s nothing different from regular scenario. You can find the Service Bus project here i.e. used for demonstration purpose in this post.

Testing:

In test console, you can observe that Accept http header shows both application/xml and application/json i.e. now your REST service supports both xml and json data formats.

GET With application/xml:

GET With application/json:

POST With application/xml:

POST With application/json:

You can observe that both records have been inserted as expected.

PUT With application/xml:

PUT With application/json:

You can observe that both records have been updated as expected.

Resource /Employees/{employeeId}:

GET With application/xml:

GET With application/json:

DELETE With application/xml:

DELETE With application/json:

You can observe that both records have been deleted as expected.

If you want to expose SOAP interface as well, then you just need to create another Proxy Service and join EmployeePipeline as shown below.

Notes:

• We did not talk about fault handling specific details here.
• It’s always recommended not to do blind GET as we may see performance issues when large number of records are there.
• As an exercise, you can come up with resource emulating QBE on db.

References:

https://docs.oracle.com/middleware/1213/osb/develop/GUID-C346DF7D-041D-4E10-BE1C-451F50719106.htm#OSBDV88210

Published following series of articles related Service Bus 12c. Hopefully it helps the people who want to get hands dirty.

• Creating Service Bus Application and Project
• Creating Business Services
• Creating Proxy Services
• Deploying and Testing
• Creating Pipeline Template
• Creating Proxy Service using Pipeline Template
• Using Domain Value Maps (DVM)
• Using XQuery map
• Using XSL map
• Creating Static Split-Join
• Securing Proxy Services
• REST enabled Proxy Services
• Mixing URI Parameters and Payload in REST Services
• REST enabled Business Services
• Error Handling
• MDS Support
• Deploying MDS
• 1-Way SSL
• 2-Way SSL
• Outbound SSL
• EDN with Service Bus

In Service Bus, Proxy Services provide an interface to Service Consumers. In this post, you will see different ways to create Proxy Servicse using JDeveloper based on a WSDL. And for demonstration purpose, we will consider Service Bus project and WSDL as shown below.

Method 1:

Right click Service Bus project and select New –> Proxy Service. You can also select Pipeline in this context menu and check the option Expose as a Proxy Service in step2 of wizard.

Give a meaningful name for Proxy Service as shown below.

Click Browse WSDLs icon and select CustomerService WSDL.

Click OK to go back to Create Proxy Service wizard. Retain Generate Pipeline selection so that wizard will create both Proxy Service and Pipeline for you.

Method 2:

Open the Service Bus overview file (file with same name as your project) and drag HTTP adapter into from Components –> Service Bus –> Technology –> HTTP into Proxy Services swim lane to bring up Create Proxy Service wizard as shown below.

Give meaningful name for Proxy Service and click Next. Select WSDL option and select WSDL as shown in previous method by clicking Browse WSDLs icon.

Method 3:

Right click WSDL in Service Bus project and select Service Bus –> Generate Proxy Service as shown below. You can also select Generate Pipeline in this context menu and check the option Expose as a Proxy Service in step2 of wizard.

Verify that Create Proxy Service wizard has come up showing WSDL and binding selected.

The following steps are common irrespective of above methods you choose to create Proxy Service.

Click Next and give Endpoint URI as /entity/CustomerService. So service consumers can access your proxy service using URL as given below.

:/entity/CustomerService”>http://:/entity/CustomerService

Click Finish to bring up CustomerPS.proxy window showing properties of your Proxy Service. Go to Message Handling tab and select SOAPAction Header as Selection Algorithm. This would enable proxy service to determine operation at runtime based on SOAP Action in HTTP headers. You can retain the default option SOAP Body Type unless no 2 operations share same payload structure.

Now your Service Bus project should show both Proxy Service and Pipeline as shown below.