I received queries from some of the readers on OSB’s fault handling behaviour recently. I thought best way to explain would be through an example and here we go …
Above example, deals with two look up services: Airport and Currency. These would be installed in BPEL as SOAP services. Oracle Service Bus will then invoke these services with the help of appropriate business services and a common proxy service. If either currency or airport code is not found, BPEL webservices will throw InvalidCurrencyFault and InvalidAirportFault respectively. These Faults are captured at OSB’s proxy stage with the help of Error Handler defined at “Route Node” stage. OSB then transforms these faults into appropriate common faults and sends response back to the client. For more details on Routing and Transformation in OSB, please refer to this example.
Let us look at each step in detail.
Step 0: Client invokes Common Lookup Proxy Service available from OSB.
- Common Lookup Proxy Service, with the help of a Routing Table, invokes Airport Lookup Business Service.
- Common Lookup Proxy Service, with the help of a Routing Table, invokes Currency Lookup Business Service.
- Airport Lookup Business Service will invoke corresponding lookup service hosted in BPEL.
- Currency Lookup Business Service will invoke corresponding lookup service hosted in BPEL.
- BPEL throws InvalidAirportFault when the airport code is not found. In this case, only ‘LHR’ is recognized.
- BPEL throws InvalidCurrencyFault when the currency code is not found. In this case, only ‘GBP’ is supported.
- Error Handler defined at “Route Node” stage of the proxy service will catch InvalidAirportFault exception and transforms into CommonLookupAirportFault.
- Error Handler defined at “Route Node” stage of the proxy service will catch InvalidCurrencyFault exception and transforms into CommonLookupCurrencyFault.
Step 9: Client receives CommonLookupAirportFault & CommonLookupCurrencyFault from OSB.
Steps to install and test the Example:
- Download BPEL Lookup Service composite and install. This composite also includes a Mediator component, just to demonstrate similar exception handling can also be done in Composite. LookupMediator also transforms BPEL business faults into Common Faults. However, AirportLookupService and CurrencyLookupService can also be independently invoked and tested as webservices. Complete JDeveloper project is available from here.
Test BPEL Lookup Services:
- Ensure this service has three end points: currencylookupservice_client_ep, LookupMeditator_ep and airportlookupservice_client_ep.
- Click on currencylookupservice_client_ep from Test menu as shown above.
- Enter code=GBP and value=GBP and hit Test Web Service.
- Ensure output is British Pound.
- Test lookup service for code=INR and value=INR. This should result into InvalidCurrency exception as shown below.
- Similarly, airportlookupservice_client_ep should pass successfully for code=LHR, value=LHR, but should fail for code=BLR, value=BLR.
Install OSB Lookup Service:
- Download OSB Lookup Service and save to your local folder. Login to OSB console, go to “System Administration-> Import Resources”and select osb_LookupService_1.0.jar from previous folder. Click Next.
- Click on Import to import the OSBLookupService project.
- From project explorer navigate to OSBLookupService->business folder. Edit AirportLookupBS and CurrencyLookupBS to modify endpoints of match your BPEL server’s name and port number. For example, default end points look like:
- Given below is the snapshot of OSB Lookup Service, taken from Weblogic Workshop, that shows Proxy Service, Routing Table, Error Handler etc.,
Test OSB Lookup Service:
- Navigate from Project Explorer to OSBLookupService->proxy folder. Click on Launch Test Console for CommonLookupProxy.
- Enter following XML in payload and hit on Execute-Save.
<ebm:lookupRequest xmlns:ebm="http://www.orafmwschool.com/training/lookup/common/ebm">
<ebm:type>AIRPORT</ebm:type>
<ebm:code>LHR</ebm:code>
</ebm:lookupRequest>
- London Heathrow will be populated in response.
- Now, try an invalid AIPORT lookup code to see CommonAirportLookupFault. Enter following payload and hit on Execute-Save.
<ebm:lookupRequest xmlns:ebm="http://www.orafmwschool.com/training/lookup/common/ebm">
<ebm:type>AIRPORT</ebm:type>
<ebm:code>BLR</ebm:code>
</ebm:lookupRequest>
- Observe BPEL log messages from server console.
- Similarly try following two payloads and observe the output and fault messages.
<ebm:lookupRequest xmlns:ebm="http://www.orafmwschool.com/training/lookup/common/ebm">
<ebm:type>CURRENCY</ebm:type>
<ebm:code>GBP</ebm:code>
</ebm:lookupRequest>
<ebm:lookupRequest xmlns:ebm="http://www.orafmwschool.com/training/lookup/common/ebm">
<ebm:type>CURRENCY</ebm:type>
<ebm:code>INR</ebm:code>
</ebm:lookupRequest>
Hi Amjad,
How does this example change if the two bpel processes are ASYNCHRONOUS instead of SYNCHRONOUS. We have a requirement of an ASYNCHRONOUS mediator connected to an ASYNCHRONOUS bpel process and ASYNCHRONOUS bpel process is throwing faults. Can we handle these faults in the mediator routing rules and how?
Regards.
Asynchronous fault is equivalent to an asynchronous response call back. You can create routing rule in Mediator to capture this asynchronous fault. We can create an example demonstrating this use-case. Please look at our support services if you are interested.
http://www.orafmwschool.com/training/#support
Thank you ADMIN,
I have modified the wsdl file and added an operation for the fault in the CallBack portType and it looks fine, so there shall be two responses back from the bpel service one based on normal response and the other based on a fault. However in asynchronous based mediator, there is no way of creating an additional callback response. For synchronous based mediator, there is a way of creating an additional fault in the routing rule.
Thanks.