How to Publish REST services using Oracle SOA Suite 12c

Hello and welcome!

 

Continuing our deep dive into the Oracle SOA Suite 12c, we will now explore the new REST adapter! That is something clients have been asking for a long time and it is finally here!

For our test I will create a REST POST web-service that will receive either XML, JSON or URL params and pass them to a BPEL process, so as always we will start creating a new SOA pŕoject:

 

ScreenshotRESTBPELCreate

After the process is created we will need to design our data structure for our example to work, to do that we will create a new XSD Schema file! Yes, we are creating a REST service, stay with me, we are going somewhere with this, here is my schema:


<?xml version="1.0" encoding="UTF-8" ?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:vrs="https://vrsbrazil.wordpress.com/RESTSchema"
targetNamespace="https://vrsbrazil.wordpress.com/RESTSchema" elementFormDefault="qualified">
<xsd:element name="restElement">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="name" type="xsd:string"/>
<xsd:element name="dateTime" type="xsd:dateTime"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:schema>

Important: If you want to create a schema from scratch like I am doing, on the “New Gallery” choose the “XML Schema” option not the “XSD Schema” this one is a wizard for creating XSDs based on file patterns, not covered on this post.

Next we drag a REST Adapter from the Components Palette into the Exposed Services column at the composite.xml, this will bring up the “Create REST Binding” wizard:

ScreenshotRESTBPELWSWizard

At the “Operation Bindings” section, click on the “green plus sign” and then click on  “Add operation binding”, this will bring up the “REST Operation Binding” wizard:

ScreenshotRESTOpBindingWz

At the “Request” tab you will see the options offered for payload: XML, JSON, URL-Encoded and No Payload, we are choosing all BUT No Payload.

You should have also noticed a Schema URL field available, we will click on that one’s search icon and select the  “restElement” element on the XSD we just created. The operation Name and HTTP verb is on the image below:

ScreenshotRESTOpWz2

At the “Request” screen, on the “Payload” section there is a cogs button, this button creates data examples for the payloads we have selected, here are those it created when I clicked:

XML:


<restElement xmlns="https://vrsbrazil.wordpress.com/RESTSchema">
   <name>name44</name>
   <dateTime>2014-07-22T16:06:58.416</dateTime>
</restElement>

JSON:

{
  "name" : "name43",
  "dateTime" : "2014-07-22T16:06:58.415"
}

URL-Encoded:

name=name45&dateTime=2014-07-22T16%3A06%3A58.416

If you want the wizard will save these generated code on your Adapters folder within the project, it can be useful!

Now for our response tab I will also choose our xsd element and choose all data available BUT “No payload” again:

ScreenshotRESTOpWzFinal

We are all set here, click OK to create the operation and OK again on the “Create REST binding” wizard.

ScreenshotRESTBdnCreated

Time to create our Synchronous BPEL process, drag a BPEL component to the composite.xml screen.
On the creation wizard, at the Input/Output section, select our XSD element for both and UNCHECK “Expose as a SOAP Service”:

ScreenshotRESTNewBPEL

Your composite should look like this:

ScreenshotRESTNewBPELComposite

A Mediator is all we need now to link both these guys:

ScreenshotRESTMediatorComp

Make sure you assign the payload values for input and output:

ScreenshotRESTMediatorAsgn

And do the same thing on your BPEL process:

ScreenshotRESTBPELAsgn

If your process looks like this you are probably all set:

ScreenshotRESTBPELProcess

Finally we can deploy and test it, lets start with the basic XML Request and XML Response:

ScreenshotRESTXMLXMLTest
ScreenshotRESTXMLXMLTestResponse

Looking good, how about a JSON/JSON Test:

ScreenshotRESTJSONJSONTest
ScreenshotRESTJSONJSONTestResponse

Let’s mix it up a little with a URL/JSON one:

ScreenshotRESTURLJSonTest

Well this is it, hope I could help you!

Thank you,

Advertisements

6 thoughts on “How to Publish REST services using Oracle SOA Suite 12c”

  1. Hi

    this is very nice article, I tried and getting perfect JSON response. But I want to write this response into a file by using FileAdapter. I tried but I was unable to write the response. Could you please help me on this how to write this JSON response into a file.

    thanks
    Suresh

  2. I have tried the above example of using rest adapter as it is but i was getting below issue when i test in em console.

    com.sun.jersey.api.client.ClientHandlerException: java.net.ProtocolException: unrecognized response from proxy: ‘HTTP/1.0 403 Tunnel or SSL Forbidden’
    java.lang.Exception: com.sun.jersey.api.client.ClientHandlerException: java.net.ProtocolException: unrecognized response from proxy: ‘HTTP/1.0 403 Tunnel or SSL Forbidden

  3. Really too good article. I am new to this REST services, after reading this article I got some idea how it works and how REST is useful as compared to SOAP. Thanks!!

  4. If only Oracle’s REST adapter would properly work with SSL outbound (i.e as a client)
    12.2.1.0. We applied 2 patches to make it work, then discovered that if we made 2 outbound calls in the same process flow i.e they are few milliseconds apart – the second call would always fail with javax.net.ssl.SSLException: Received fatal alert: unexpected_message.

    Turning on SSL debug revealed that the connection stays open and it tries to re-use it for the second call. It attempts to renegotiate the Cipher but this gets rejected by the server at the other end, which causes the unexpected message error to come.
    I worked around it by replacing the adapter with Java code that closes the connection when it is finished. My Java works perfectly, and under load.
    The Oracle REST adapter also gave the same error for single outbound calls in a process, when the process was called multiple times in quick succession.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

w

Connecting to %s