svcutil generated unneccesary wrapper classes - wsdl

I am working on a project that uses the contract first approach. I was given a WSDL and three xsd's. When I use svcutil it generates a wrapper around the response class like so:
public partial class getDataByIdResponse1 {
public getDataByIdResponse getDataByIdResponse;
public getDataByIdResponse1() {
}
public getDataByIdResponse1(getDataByIdResponse getDataByIdResponse) {
this.getDataByIdResponse = getDataByIdResponse;
}
}
The getDataByIdResponse is wrapped inside a getDataByIdResponse1 object. This is done by svcutil and I have no idea why. The getDataByIdResponse1 object does not exist in the WSDL:
<wsdl:message name="getDataById">
<wsdl:part name="response" element="tns:getDataByIdResponse"/>
</wsdl:message>
<xs:element name="getDataByIdResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="data" type="sbc:DataType" minOccurs="1" maxOccurs="1" />
</xs:sequence>
</xs:complexType>
</xs:element>
Why is the type getDataByIdResponse wrapped in getDataByIdResponse1? Is there a switch for svcutil I should have used?

I'm in the same boat as you but I don't just want to live with it. I want to generate clean (unwrapped) contracts. If the wsdl and xsd's were given to you then there are some rules that your schema and wsdl need to follow in order for svc util to generate unwrapped code. These links helped me understand the issue a little better
http://pzf.fremantle.org/2007/05/handlign.html
http://mharbauer.wordpress.com/2007/10/19/wcf-datacontract-serializer-and-documentwrapped/
For now my schema and wsdl are small enough that I can tweak them to adhere to this rules.
However, like Ron, I've also been in situations where the easiest thing is just to live with it.
Hope this helps.

I am in the same situation (contract-first) and svcutil is generating this same kind of code for me but I just closed my eyes took a deep breath and accepted it :-)
Just use the types without the numeric postfix and it just works.

Related

Modifying Wsdl2Apex Generated Classes to Handle xs:extension and imported namespaces

I am having trouble with wsdl2apex code generation, mainly due to the use of xs:import namespace and xs:extension in my WSDL.
In particular, I am seeing the error System.CalloutException: Web service callout failed: Unable to parse callout response. Apex type not found for element . . .. The raw SOAP response returned by the web service looks as I would expect.
I would like to modify the generated Apex classes to work around this issue, as server-side changes to the web service is not an option.
The SOAP response looks like the below:
<ns:getAccountsResponse>
<ns:return xsi:type="ax1:AccountReturn">
<ax2:successful>true</ax2:successful>
<ax2:transactionId>1000</ax2:transactionId>
<ax1:Accounts xsi:type="ax1:Account">
And the WSDL looks like this for the ax1 target namespace:
<xs:complexType name="AccountReturn">
<xs:complexContent>
<xs:extension base="ax100:BaseReturnObject">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" name="Accounts" nillable="true" type="ax1:Account"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
And for the ax2 target namespace:
<xs:complexType name="BaseReturnObject">
<xs:sequence>
<xs:element minOccurs="0" name="successful" type="xs:boolean"/>
<xs:element minOccurs="0" name="transactionId" nillable="true" type="xs:integer"/>
</xs:sequence>
</xs:complexType>
The generated Apex Class which maps to AccountReturn only contains the fields for Accounts in ax1, but not the BaseReturnObject fields in ax2, since the wsdl2apex generation does not respect the use of xs:extension or the importing of namespaces (based on my research).
Is there anyway to modify the Apex Class to make this work? I tried adding the fields from BaseReturnObject to AccountReturn, and modifying field_order_type_info. However, it appears that apex_schema_type_info can only point to one namespace, and this may be the reason that the parsing of the callout response is still failing.
I've built a tool for automating the creation of the Apex classes. It includes support for xs:extension and xs:import (among other things).
In the case of an ex:extension, the tool will pull the required fields from the base class into the subclass and correctly configure the _type_info members.
You can get it for free - FuseIT SFDC Explorer. Currently in only runs directly in Windows. I've had reports of people running it successfully using Wine. (Disclosure: I work for the company that releases this tool).
Incidentally, the salesforce.stackexchange.com site is a great place to ask Salesforce specific questions.

How to extend BPMN 2.0

Currently, I'm investigating the ways to extend BPMN. I want to create a new task type with less properties than a task and also with some non-BPMN properties and a new type of pool.
Until now I saw that people mentioned of two ways, using Extension Points and using an external schema. Unfortunately in Internet, I could not find that many resources to understand these methods extensively.
What I understood from these methods:
Extension Points: There are some standard extension points provided by BPMN engine vendors (Aktiviti, jBPM, etc...). For instance in Activiti there is a Custom Service Task which can be extended with user desired properties but I did not find any resources if this newly created extension task can be deployed on the Aktiviti workflow engine and also it would be nice to see the new BPMN schema for this extension.
Using an external schema: Defining desired properties in an external schema and referencing this schema from Semantic.xsd. In this case we will also need to adapt our Workflow Engine but it's more flexible than the method I mentioned before or am I missing missing something?
The only thing that is not clear is this method does not extend directly task definition so these properties can be used by every element in BPMN?
An example external schema is:
<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema elementFormDefault="qualified" attributeFormDefault="unqualified"
xmlns="http://myproject.org//bpmn/extensions/NEWTask"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL"
xmlns:exvar="http://myproject.org/externalDefs"
targetNamespace="http://myproject.org//bpmn/extensions/NEWTask"
>
<xsd:import namespace="http://www.omg.org/spec/BPMN/20100524/MODEL" schemaLocation="BPMN20.xsd"/>
<xsd:import schemaLocation="externalDefs.xsd" namespace="http://myproject.org/externalDefs" />
<xsd:complexType name="tProperty1" abstract="false">
<xsd:sequence>
<xsd:any namespace="##any" processContents="lax" minOccurs="0" />
</xsd:sequence>
</xsd:complexType>
<xsd:group id="tNEWTask" name="tNEWTask">
<xsd:sequence>
<xsd:element name="Property2" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="Property1" type="tProperty1" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="Property2" type="exvar:Varaible1" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:group>
</xsd:schema>
Are there any other methods for extending BPMN or any resources that you can point me so that I can have a better insight about this topic?
Any help will be appreciated, thanks in advance!
There's this tool developed by a brazilian researcher: http://code.google.com/p/bpmnx/
it works on extension points as far as i remember.
As you are not talking about any concrete BPMN implementation (activiti, jbpm), and you are talking about your own process engine I assume that what you want to do is extend the XML in accordance to BPMN rules.
That said, you can look at BPMN 2.0 specification (I think it's very long, and probably boring) or you can try to look at some bpmn book. BPMN method & style book has a part about implementing BPMN, so maybe that's useful to you.
Note: When there's a standard like BPMN, which has a lot of support, sometimes it's useful if you really need to extended. Is it worth extending something standard, which hasn't been considered? (Not saying you can't do it, but you should think what it brings to you and if couldn't you do it with the regular stuff).
Here is some discussion of this topic on the Activiti Forums and on the MDT Eclipse plugin forum.
Unfortunately, with some simple testing I have not been able to implement a new namespace
(e.g. xmlns:newns="http://www.mynewns.com/newns in
<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:activiti="http://activiti.org/bpmn"
xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI"
xmlns:omgdc="http://www.omg.org/spec/DD/20100524/DC"
xmlns:omgdi="http://www.omg.org/spec/DD/20100524/DI"
typeLanguage="http://www.w3.org/2001/XMLSchema"
xmlns:newns="http://www.mynewns.com/newns"
expressionLanguage="http://www.w3.org/1999/XPath"
targetNamespace="http://www.activiti.org/bpmn2.0">
and an element like <userTask newns:ownerID="owner1">).
Custom elements in my Activiti diagram don't work either -- the Eclipse plugin seems to discard my custom namespace and ignore my elements. Don't know why; still researching.
You can take a look at the Eclipse BPMN2 Modeler.
There are some tutorials available (e.g. extending the runtime and creating a custom task).

custom binding to force Inner class creation or getters/setters for xs:element

I have a schema declaration as follow from a third-party provider.
<xs:complexType name="GroupParameterType">
<xs:sequence minOccurs="0" maxOccurs="4">
<xs:element name="name" type="xs:string">
<xs:annotation>
<xs:documentation>The name of the parameter.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="value" type="xs:string">
<xs:annotation>
<xs:documentation>The value of the parameter.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
Above is the schema that i CANNOT change. I am trying to write a custom binding for jaxb 2.0 such that I can refer to name as GroupParameterType.Name or GroupParameterType.Value in java code.
Current default binding generates List for me i.e. getNameandValueList, but I want separate getters and setters for name and value respectively.
I tried putting in a custom binding like the following :
<jxb:bindings schemaLocation="GroupParameter.xsd" node="xs:element[#name='name']">
<jxb:globalBindings localScoping="toplevel" generateIsSetMethod="true"/>
</jxb:bindings>
<jxb:bindings schemaLocation="GroupParameter.xsd" node="xs:element[#name='value']">
<jxb:globalBindings localScoping="toplevel" generateIsSetMethod="true"/>
</jxb:bindings>
and it did nothing to change the default class generation. Can anyone give me some pointers as so what else can I try next ? I am looking to have the default List generation ALONG WITH the getters/setters for name and value OR have name and value as Inner Classes. If i remove the maxOccurs=4 option, I can generate getters/setters but since I can't modify the schema, I am trying to get that behavior using external binding file.
Thanks
Shon
You can't get this behaviour unless you modify your schema. You do have a schema model which maps to a heterogeneous element property, and you can't change it with a customization.
You can try the code injection plugin as the last retreat.

Importing schema with XMLmapper in Delphi?

I try to import some valid schema (for xmlspy and oxygen) with XMLMapper in delphi and I have this error
"Error Flux if:InfofileType unknown".
I use namespace and this type is define in another file.
Is there a way to solve this ?
(I also try with Delphi 2010 demo and it still not work)
<?xml version="1.0" encoding="UTF-8" ?>
- <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:if="http://www.gtest.fr/Apps/InfoFile" xmlns:ca="http://www.gtest.fr/Apps/CommandAnswer" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:import namespace="http://www.gtest.fr/Apps/InfoFile" schemaLocation="InfoFile.xsd" />
<xs:import namespace="http://www.gtest.fr/Apps/CommandAnswer" schemaLocation="CommandAnswer.xsd" />
- <xs:element name="ServerAnswer">
- <xs:annotation>
<xs:documentation>Reponse serveur socket</xs:documentation>
</xs:annotation>
- <xs:complexType>
- <xs:sequence>
<xs:element name="InfoFile" type="if:InfoFileType" />
<xs:element name="Command" type="ca:CommandAnswerType" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
reported in QC : http://qc.embarcadero.com/wc/qcmain.aspx?d=80124
I would still try to grab a Delphi 2010 (trial) and see if it works there.
I know there has been significant work done there in D2009 and D2010. It was notoriously bad at doing imports and includes.
Much better now...
If you cannot solve this, I would recommend to manually edit the schemas to remove the include/import and build a big fat XSD without the external file. It should work better.
That's how I did with a rather intricate set of schemas that even .Net lib would choke on.
Update: Could you try to replace the if:InfoFile by another symbol to avoid any clash with the if reserved word; i.e. search 'n' replace if in the schemas by _if_ or anything else... The XML mapper is supposed to care of this but, ya know...
Eric Thorniley finally give me the way to go here.
It seems XML Mapper does not
understand the namespaces correctly.
You can however coax it into life by
adding an extra namespace definition
into the imported files. This is, I am
sure, not right.
So, for instance, in your
Insurance.xsd you declare
xmlns:Utils="http://www.gtest.fr/Apps/Utils"
If you add exactly the same definition
into Utils.xsd, XML Mapper imports it
correctly (I think!)
Ther is a fair chance that XML Spy
would strip out my modifications -
certainly Enterprise Architect ignores
them completely.
I'd like to see the message that Eric Thorniley pointed you to, but it is no longer there. I might be able to find it in an archive somewhere, if I had the subject of the message. I tried a Google search but all I found were duplicate copies of this post on different sites.
Thanks

axis wsdl generation

I'm using Axis to model a sample WebService. What I'm doing now is trying to understand which are the limitations of the automated wsdl and code generation.
Now for some server side code:
this is the skeleton of the sample web service:
public class TestWebService {
public AbstractAttribute[] testCall( AbstractAttribute someAttribute ) {
....
and my data classes:
public abstract class AbstractAttribute {
String name;
/*get/set for name*/
public abstract T getValue();
public abstract void setValue(T value);
}
public class IntAttribute extends AbstractAttribute<Integer> {
Integer value;
public Integer getValue(){ return value; }
public void setValue(Integer value){ this.value = value; }
}
public class StringAttribute extends AbstractAttribute<String> {
String value;
/* ok, you got the point, get/set for value field */
}
The eclipse tool for Axis2 is quite happy to generate a wsdl from these sources, including the schema for the attribute classes, which is:
<xs:complexType name="AbstractAttribute">
<xs:sequence>
<xs:element minOccurs="0" name="name" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="value" nillable="true" type="xs:anyType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="IntAttribute">
<xs:complexContent>
<xs:extension base="xsd:AbstractAttribute">
<xs:sequence>
<xs:element minOccurs="0" name="value" nillable="true" type="xs:int"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="StringAttribute">
<xs:complexContent>
<xs:extension base="xsd:AbstractAttribute">
<xs:sequence>
<xs:element minOccurs="0" name="value" nillable="true" type="xs:string"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
now, if see something strange here, AbstractAttribute hasn't the ** abstract="true" ** attribute, and define an anyType value element, which get rewrite in IntAttribute and StirngAttribute. I don't even know if this is a legal schema (I don't think it's legal, by the way).
More, if I try to generate a client from this wsdl (always using the eclipse tools) the generated sources won't compile, because AbstractAttribute defines an
Object localValue;
field and Int/String Attribute defines
int localValue;
and
String localValue;
..I tried to "accomodate" the sources (without many hopes, obviously), and the results are that the server try to instantiate an AbstractAttribute instance (throwing an InstantiationException).
So my question is: there is a way to model something like the data model above, or web services and XML schemas' in general are not the best tools to use for this particular case?
To explain the problem you are encountering, it helps to think of what Axis needs to do when your service is called.
Axis is simply a java web-application...when it receives a request for a service, it will look up the mapping that you've defined for it. If it finds a mapping, it tries to create an instance of the necessary classes you've defined to service the request.
If you've defined the classes as abstract or as interfaces then you'll get InstantiationExceptions since these types can't be created. When Axis tried to create the wsdl, it won't be able to figure out what type to put so it will use "anyType."
To answer your question: you CAN use the the model you have above in your code, but you won't be able to use these classes with Axis. What we have typically done in our projects is:
Define the classes we need, as we would in a typical Object-Oriented application
Define "transport-only" classes that are used for web services. These classes are composed of simple types and can be easily created. They are only used for exchanging web-service messages. We use these classes with Axis.
Find some way for these two types of classes to easily share/exchange information. You can have interfaces that are shared by both (but Axis doesn't know about) or even use BeanUtils.copyProperites to keep two different objects in sync.
Hope that answers your question.

Resources