none

1 Eylül 2009 Salı

bpel fault handling

Understanding fault handling mechanism of bpel took time for me, so lets note down the issue..

i want to explain bpel fault handling in 2 steps.. In step 1, there is a bpel process which does nothing except for throwing an exception. In step 2, there is a sample web service throwing a user defined exception and bpel catches and throws that exception..

Process without web service :

Here are the files for the bpel module:

FaultWsdl.wsdl

<?xml version="1.0" encoding="UTF-8"?>

<definitions name="wsdl" targetNamespace="http://j2ee.netbeans.org/wsdl/wsdl"

xmlns="http://schemas.xmlsoap.org/wsdl/"

xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:tns="http://j2ee.netbeans.org/wsdl/wsdl"

xmlns:plnk="http://docs.oasis-open.org/wsbpel/2.0/plnktype"

xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:ns0="http://xml.netbeans.org/schema/schema">

<types>

<xsd:schema targetNamespace="http://j2ee.netbeans.org/wsdl/wsdl">

<xsd:import schemaLocation="schema.xsd" namespace="http://xml.netbeans.org/schema/schema"/>

</xsd:schema>

</types>

</message>

</message>

</message>

</operation>

</portType>

<soap:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http"/>

<soap:operation/>

<soap:body use="literal" namespace="http://j2ee.netbeans.org/wsdl/wsdl"/>

</input>

<soap:body use="literal" namespace="http://j2ee.netbeans.org/wsdl/wsdl"/>

</output>

<soap:fault use="literal" name="fault1" namespace="http://j2ee.netbeans.org/wsdl/wsdl"/>

</fault>

</operation>

</binding>

<soap:address location="http://localhost:${HttpDefaultPort}/wsdlService/wsdlPort"/>

</port>

</service>

<plnk:partnerLinkType name="wsdl">

<!-- A partner link type is automatically generated when a new port type is added. Partner link types are used by BPEL processes.

In a BPEL process, a partner link represents the interaction between the BPEL process and a partner service. Each partner link is associated with a partner link type.

A partner link type characterizes the conversational relationship between two services. The partner link type can have one or two roles.-->

<plnk:role name="wsdlPortTypeRole" portType="tns:wsdlPortType"/>

</plnk:partnerLinkType>

</definitions>

schema.xsd i think jaxws wants the schema in a seperate file than the wsdl, at least netbeans web service client generation wizard does!

<?xml version="1.0" encoding="UTF-8"?>

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"

targetNamespace="http://xml.netbeans.org/schema/schema"

xmlns:tns="http://xml.netbeans.org/schema/schema"

elementFormDefault="qualified">

<xsd:element name="faultstr" type="xsd:string"></xsd:element>

</xsd:schema>

FaultProcess.bpel

<?xml version="1.0" encoding="UTF-8"?>

<process

name="FaultProcess"

targetNamespace="http://enterprise.netbeans.org/bpel/BpelFault1/Process1"

xmlns="http://docs.oasis-open.org/wsbpel/2.0/process/executable"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:sxt="http://www.sun.com/wsbpel/2.0/process/executable/SUNExtension/Trace"

xmlns:sxed="http://www.sun.com/wsbpel/2.0/process/executable/SUNExtension/Editor"

xmlns:tns="http://enterprise.netbeans.org/bpel/BpelFault1/Process1">

</partnerLinks>

</variables>

<copy>

<from>'This error is thrown from the bpel process'</from>

</copy>

<copy>

</copy>

</assign>

</sequence>

</process>

and offcourse the client call code:

try {

org.netbeans.j2ee.wsdl.wsdl.WsdlService service = new org.netbeans.j2ee.wsdl.wsdl.WsdlService();

org.netbeans.j2ee.wsdl.wsdl.WsdlPortType port = service.getWsdlPort();

javax.xml.ws.Holder part1 = new javax.xml.ws.Holder();

part1.value = new String("test");

port.wsdlOperation(part1);

} catch (org.netbeans.j2ee.wsdl.wsdl.WsdlOperationFault ex) {

System.out.println("fault: " + ex.getFaultInfo() );

}

The expected output is :

fault: This error is thrown from the bpel process

and done :) However, when web service thrown exceptions are considered, not so easy :(

Process catching exception thrown by invoked web service:

The sample web service:

MyWebService.java

package ws;

import javax.jws.WebMethod;

import javax.jws.WebParam;

import javax.jws.WebService;

@WebService()

public class MyWebService {

@WebMethod(operationName = "operation")

public String operation(@WebParam(name = "parameter")

String parameter) throws MyException {

throw new MyException("Exception thrown from web service :) ");

}

and the exception class..

MyException.java

package ws;

public class MyException extends Exception {

private String errorCode;

public MyException() {

}

public MyException(String msg) {

super(msg);

}

public String getErrorCode() {

return errorCode;

}

public void setErrorCode(String errorCode) {

this.errorCode = errorCode;

}

Now the bpel module files:

FaultCatchProcess.bpel

<?xml version="1.0" encoding="UTF-8"?>

<process

name="FaultCatchProcess"

targetNamespace="http://enterprise.netbeans.org/bpel/BpelFault2/FaultCatchProcess"

xmlns="http://docs.oasis-open.org/wsbpel/2.0/process/executable"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:sxt="http://www.sun.com/wsbpel/2.0/process/executable/SUNExtension/Trace"

xmlns:sxed="http://www.sun.com/wsbpel/2.0/process/executable/SUNExtension/Editor"

xmlns:tns="http://enterprise.netbeans.org/bpel/BpelFault2/FaultCatchProcess" xmlns:ns0="http://ws/">

</partnerLinks>

</variables>

<copy>

</copy>

</assign>

</sequence>

</catch>

</faultHandlers>

<copy>

</copy>

</assign>

<copy>

</copy>

</assign>

</sequence>

</process>

FaultCatchWsdl.wsdl

<?xml version="1.0" encoding="UTF-8"?>

<definitions name="FaultCatchWsdl" targetNamespace="http://j2ee.netbeans.org/wsdl/FaultCatchWsdl"

xmlns="http://schemas.xmlsoap.org/wsdl/"

xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"

xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://j2ee.netbeans.org/wsdl/FaultCatchWsdl" xmlns:ns="http://ws/" xmlns:plnk="http://docs.oasis-open.org/wsbpel/2.0/plnktype" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/">

<types>

<xsd:schema targetNamespace="http://j2ee.netbeans.org/wsdl/FaultCatchWsdl">

<xsd:import namespace="http://ws/" schemaLocation="MyWebServiceService.xsd"/>

</xsd:schema>

</types>

</message>

</message>

</message>

</operation>

</portType>

<soap:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http"/>

<soap:operation/>

<soap:body use="literal" namespace="http://j2ee.netbeans.org/wsdl/FaultCatchWsdl"/>

</input>

<soap:body use="literal" namespace="http://j2ee.netbeans.org/wsdl/FaultCatchWsdl"/>

</output>

<soap:fault use="literal" name="fault1" namespace="http://j2ee.netbeans.org/wsdl/FaultCatchWsdl"/>

</fault>

</operation>

</binding>

<soap:address location="http://localhost:${HttpDefaultPort}/FaultCatchWsdlService/FaultCatchWsdlPort"/>

</port>

</service>

<plnk:partnerLinkType name="FaultCatchWsdl">

<!-- A partner link type is automatically generated when a new port type is added. Partner link types are used by BPEL processes.

In a BPEL process, a partner link represents the interaction between the BPEL process and a partner service. Each partner link is associated with a partner link type.

A partner link type characterizes the conversational relationship between two services. The partner link type can have one or two roles.-->

<plnk:role name="FaultCatchWsdlPortTypeRole" portType="tns:FaultCatchWsdlPortType"/>

</plnk:partnerLinkType>

</definitions>

The following wsdl and xsd are local copies for the web service wsdl..

MyWebServiceService.wsdl

<?xml version="1.0" encoding="UTF-8"?>

<types>

<xsd:schema>

<xsd:import namespace="http://ws/" schemaLocation="MyWebServiceService.xsd"></xsd:import>

</xsd:schema>

</types>

</message>

</message>

</message>

</operation>

</portType>

<soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"></soap:binding>

<soap:operation soapAction=""></soap:operation>

<input>

<soap:body use="literal"></soap:body>

</input>

<soap:body use="literal"></soap:body>

</output>

<soap:fault name="MyException" use="literal"></soap:fault>

</fault>

</operation>

</binding>

<soap:address location="http://localhost:8080/BpelFaultWS1/MyWebServiceService"></soap:address>

</port>

</service>

</definitions>

MyWebServiceService.xsd

<?xml version="1.0" encoding="UTF-8"?>

<xs:schema xmlns:tns="http://ws/" xmlns:xs="http://www.w3.org/2001/XMLSchema" version="1.0" targetNamespace="http://ws/">

<xs:element name="MyException" type="tns:MyException"></xs:element>

<xs:element name="operation" type="tns:operation"></xs:element>

<xs:element name="operationResponse" type="tns:operationResponse"></xs:element>

<xs:complexType name="operation">

<xs:sequence>

<xs:element name="parameter" type="xs:string" minOccurs="0"></xs:element>

</xs:sequence>

</xs:complexType>

<xs:complexType name="operationResponse">

<xs:sequence>

<xs:element name="return" type="xs:string" minOccurs="0"></xs:element>

</xs:sequence>

</xs:complexType>

<xs:complexType name="MyException">

<xs:sequence>

<xs:element name="errorCode" type="xs:string" minOccurs="0"></xs:element>

<xs:element name="message" type="xs:string" minOccurs="0"></xs:element>

</xs:sequence>

</xs:complexType>

</xs:schema>

MyWebServiceServiceWrapper.wsdl

<?xml version="1.0" encoding="UTF-8"?>

<definitions

xmlns="http://schemas.xmlsoap.org/wsdl/"

xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"

xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"

xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="MyWebServiceServiceWrapper" targetNamespace="http://enterprise.netbeans.org/bpel/MyWebServiceServiceWrapper" xmlns:tns="http://enterprise.netbeans.org/bpel/MyWebServiceServiceWrapper" xmlns:plnk="http://docs.oasis-open.org/wsbpel/2.0/plnktype" xmlns:ns="http://ws/">

<plnk:partnerLinkType name="MyWebServiceLinkType">

<plnk:role name="MyWebServiceRole" portType="ns:MyWebService"/>

</plnk:partnerLinkType>

</definitions>

However, i think there is a bug here when bpel called from a java or web client.. Yes, the exception thrown by the web service is caught properly, but the detail info just disappears :( While testing via test module of the composite app, there is not such bug..

Here is the test with xml:

input

<soapenv:Envelope xsi:schemaLocation="http://schemas.xmlsoap.org/soap/envelope/ http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:faul="http://j2ee.netbeans.org/wsdl/FaultCatchWsdl">

<soapenv:Body>

<faul:FaultCatchWsdlOperation>

<part1>

</part1>

</faul:FaultCatchWsdlOperation>

</soapenv:Body>

</soapenv:Envelope>

output

<?xml version="1.0" encoding="UTF-8"?>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://schemas.xmlsoap.org/soap/envelope/ http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Body>

<SOAP-ENV:Fault>

<faultcode xmlns="">SOAP-ENV:Client</faultcode>

<faultstring xmlns="">fault1</faultstring>

<message>Exception thrown from web service :) </message>

</MyException>

</detail>

</SOAP-ENV:Fault>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

here the client call:

try {

org.netbeans.j2ee.wsdl.faultcatchwsdl.FaultCatchWsdlService service = new org.netbeans.j2ee.wsdl.faultcatchwsdl.FaultCatchWsdlService();

org.netbeans.j2ee.wsdl.faultcatchwsdl.FaultCatchWsdlPortType port = service.getFaultCatchWsdlPort();

ws.Operation part1 = new ws.Operation();

part1.setParameter("test");

ws.OperationResponse result = port.faultCatchWsdlOperation(part1);

System.out.println("Result = "+result);

} catch (org.netbeans.j2ee.wsdl.faultcatchwsdl.FaultCatchWsdlOperationFault ex) {

System.out.println("My exception is : " + ex.getFaultInfo().getMessage());

}

and the output:

My exception is : null

PS: i wrote down whole files to make trying the code easier..

You know, most portions of the files are automatically generated..

Btw, my ide is Netbeans 6.5 and i deploy to glassfish v2, and i use openesb for bpel..

Ooohh, done finally :)

Edit on 03/09/2009, 12:07 : The format of the post was a mess, so it is fixed by now..
The next post is about the bug mentioned here (in red)..

21 Ağustos 2009 Cuma

wrong port used for xsd in wsdl (openesb)

the environment is openesb (with netbeans 6.5.1) and glassfish server.
when the composite app with bpel processes is deployed, the wsdls for the processes include wrong ports in imports of inner schema files (in this case, 8080 instead of 9080).
here is a description of the problem http://n2.nabble.com/Wrong-Port-Used-When-Generating-Web-Service-Client-td3388707.html and the issue https://open-esb.dev.java.net/issues/show_bug.cgi?id=2204
Actually, the issue had been solved in the internal trunk, however the solution won't be available till next release :(
so, what to do ??

the workaround is

download the wsdls and all dependent schema files,
edit all imports (of used schema files) manually and
use the local wsdl in order to generate stubs at client side .

Thus, the stubs will be generated without any error :)

btw, deploying the business processes to apache ode is also tried. however, the same problem remained :(

19 Ağustos 2009 Çarşamba

converting java classes to schema: schemagen

schemagen tool comes with jaxb reference implementation and can be used to generate schemas from java classes. here is the command line version http://java.sun.com/webservices/docs/2.0/jaxb/schemagen.html and ant version https://jaxb.dev.java.net/jaxb20-ea/docs/schemagenTask.html When command line version is used, the names of the generated schema files are given automatically as schema1.xsd, schema2.xsd,.. etc. (one schema file per namespace). However, controlling names of files is possible when ant task is used, so i prefer using ant task.
Here is my sample schemagen ant file:


<?xml version="1.0" encoding="UTF-8"?>
<project name="projectname" default="generate-schema" basedir=".">

<path id="classpath">
    <pathelement location="path/to/classes"/>
    <fileset dir="/path/to/jaxb/lib">
        <include name="**/*.jar"/>
    </fileset>
</path>

<taskdef name="schemagen" classname="com.sun.tools.jxc.SchemaGenTask">
    <classpath refid="classpath"/>
</taskdef>

<target name="generate-schema">
    <schemagen srcdir="path/to/src" destdir="path/to/generatedfiles">
        <classpath refid="classpath"/>
        <schema namespace="http://namespace" file="nameOfMySchema.xsd" />
    </schemagen>
</target>

</project>

However, if java classes contains jpa specific annotations, the apt tool could not handle this and throw annotation specific exceptions when the lib coming with jaxb ri is used in the classpath.
Annotations for Persistence part on http://www.devx.com/Java/Article/34069/0/page/1 solves this. download sample code on http://assets.devx.com/sourcecode/18778.zip and use the lib coming with the sample on path 18778/JAXB/lib. Actually, the above ant file is a simplified version of 18778/JAXB/3-JAXB and JPA/build.xml coming with the example..

So, it is ok for now :)

17 Ağustos 2009 Pazartesi

sharing same classes with multiple web services (jaxws)

Problem Definition:
In the default case all the class definitions under a web service are generated in the namespace of the web service. For instance let the web service endpoint SampleWS class is under package org.first and let this web service returns a org.second.SampleType. When the web service is deployed and stubs are generated in the client side, SampleType is also under org.first package. When org.second.SampleType is a shared class amongst multiple web services, this leads to problem, since there will be multiple SampleType classes under multiple packages.

Solution:
The specified problem could be solved at the client side by providing wsimport with a binding file specifying actual namespaces for all shared classes. https://jax-ws.dev.java.net/guide/Compiling_multiple_WSDLs_that_share_a_common_schema.html

However, it is also possible to solve the situation at server side by forcing to put all shared classes in their actual packages by adding namespace definition via XmlType annotation as follows:


import javax.xml.bind.annotation.XmlType;

@XmlType(namespace="http://org.example.hilal")
public class Calc {
private int result;

public int getResult() {
  return result;
}

public void setResult(int result) {
  this.result = result;
}
}

i prefer the second way, solving problems at server side always seems better to me :)

14 Ağustos 2009 Cuma

configuring service endpoint at runtime

i want to keep my generated stubs when the web service deployment point changes. here is how to configure service end point at runtime: http://tugdualgrall.blogspot.com/2009/02/jax-ws-how-to-configure-service-end_17.html
i prefer the second method:


 org.me.calculator.CalculatorWSService service = new org.me.calculator.CalculatorWSService(
                    new URL("http://10.1.70.59:9080/CalculatorApp/CalculatorWSService?wsdl"), new QName("http://calculator.me.org/", "CalculatorWSService"));

            org.me.calculator.CalculatorWS port = service.getCalculatorWSPort();