Schema first approach with duplicate classnames

[Kenji Watanabe]

Hi,

I have got this problem with an external provided response.xsd and original.wsdl, where the generated (response)object contains a nested structure that looks simplified like

<outer>
    <person>
        <address></address>
        <members>
            <person><address></address></person>
        </members>
    </person>
</outer>

Using XSD as source with JAXB2-XJC, I have found a solution for this by renaming the duplicate elements in an external XJB binding file.




Now I need to do the proxy object generation using the original.wsdl as source with Apache-CXF. The complication is that the WSDL imports the xsd that I try to customize:

<?xml version="1.0" encoding="UTF-8"?>
<wsdl:definitions xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
	xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
	xmlns:http="http://schemas.xmlsoap.org/wsdl/http/"
	xmlns:xsd="http://www.w3.org/2001/XMLSchema"
	xmlns:rsp="http://schemas.mydomain.com/Messages/Response">

	<wsdl:types>
		<xsd:schema>
			<xsd:import namespace="http://schemas.mydomain.com/Messages/Response"
				schemaLocation="../schema/response.xsd"/>
		</xsd:schema>
	</wsdl:types>
...
</wsdl:definitions>

My custom.xjb:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jaxws:bindings xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
				xmlns:jaxws="http://java.sun.com/xml/ns/jaxws"
				xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" version="2.1"
				xmlns:xsd="http://www.w3.org/2001/XMLSchema"
				wsdlLocation="../wsdl/original.wsdl">

	<jaxws:bindings node="wsdl:definitions/wsdl:types/xsd:schema">

		<jaxb:bindings schemaLocation="../schema/response.xsd" node="/xsd:schema">

			<jaxb:bindings
			node="//xsd:element[@name='Outer']//xsd:element[@name='Person']/xsd:complexType">
				<jaxb:class name="PersonSecondary"/>
			</jaxb:bindings>

		</jaxb:bindings>

	</jaxws:bindings>

</jaxws:bindings>

The CXF part of my pom.xml:

	<plugin>
				<groupId>org.apache.cxf</groupId>
				<artifactId>cxf-codegen-plugin</artifactId>
				<version>${cxf.version}</version>
				<executions>
					<execution>
						<id>generate-sources</id>
						<phase>generate-sources</phase>
						<configuration>
							<sourceRoot>${basedir}/target/generated-sources/cxf</sourceRoot>
							<wsdlOptions>
								<wsdlOption>
									<wsdl>${basedir}/src/main/resources/wsdl/original.wsdl</wsdl>
									<extraargs>
										<extraarg>-autoNameResolution</extraarg>
										<extraarg>-validate</extraarg>
										<extraarg>-verbose</extraarg>
									</extraargs>
									<bindingFiles>
										<bindingFile>${basedir}/src/main/resources/custom/custom.xjb</bindingFile>
									</bindingFiles>
								</wsdlOption>
							</wsdlOptions>
						</configuration>
						<goals>
							<goal>wsdl2java</goal>
						</goals>
					</execution>
				</executions>
			</plugin>

The original.wsdl gets compiled but my custom.xjb binding file does not result in any class name modification.

mvn clean generate-sources gives as only logging

org.apache.cxf.wsdl11.WSDLServiceBuilder checkForWrapped
INFO: Operation {http://mydomain.com/Services/YadayadaOperation}YadayadaOperation
Operation cannot be unwrapped, input message must reference global element declaration with same localname as operation

[Stephan van Hulst]

Customizing the XSD simply is not the solution. Does CXF not generate a valid client from the original WSDL? If not, then you really need to take up this problem with the creators of the WSDL. Hacking around by redefining the data types WILL lead to more problems further down the road.

Can you not share the relevant parts of the XSD with us? We don't need everything, just the type definition of the outer Person type (including namespace declarations) and the nested elements up until the inner Person type. If possible, the entire XSD is preferable.

[Kenji Watanabe]

Hi Stephan,

No client generated but constructed manually.

For clarification of the structure I have included the real xsd here, after anonymization and shortcutting it because of the original size and complexity:

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema targetNamespace="http://schemas.mydomain.com/Messages/Accounting"
		elementFormDefault="qualified" attributeFormDefault="unqualified" version="1"
		xmlns:str="http://schemas.mydomain.com/Messages/Accounting"
		xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<xsd:element name="Accounting">
		<xsd:complexType>
			<xsd:sequence>
				<xsd:choice>
					<xsd:element name="DataSet">
						<xsd:complexType>
							<xsd:sequence>
								<xsd:element name="PrimaryPerson">
									<xsd:complexType>
										<xsd:sequence>
											<xsd:element name="Identification" type="xsd:double"/>
											<xsd:element name="Status" type="xsd:String" minOccurs="0"/>
											<xsd:element name="Relation" minOccurs="0" maxOccurs="unbounded">
												<xsd:complexType>
													<xsd:sequence>
														<xsd:element name="PrimaryPerson" minOccurs="0">
															<xsd:complexType>
																<xsd:sequence>
																	<xsd:element name="Initials" minOccurs="0" type="xsd:string"/>
																	<xsd:element name="FamilyName" minOccurs="0" type="xsd:string"/>
																	<xsd:element name="AddressCollection" minOccurs="0" maxOccurs="unbounded">
																		<xsd:complexType>
																			<xsd:sequence>
																				<xsd:choice>
																					<xsd:element name="Address1">
																						<xsd:complexType>
																							<xsd:sequence>
																								<xsd:element name="Zipcode" minOccurs="0" type="xsd:string"/>
																								<xsd:element name="City" minOccurs="0" type="xsd:string"/>
																								<xsd:element name="Location" minOccurs="0">
																									<xsd:complexType>
																										<xsd:sequence>
																											<xsd:element name="Street" minOccurs="0" type="xsd:string"/>
																											<xsd:element name="Number" minOccurs="0" type="xsd:string"/>
																										</xsd:sequence>
																									</xsd:complexType>
																								</xsd:element>
																							</xsd:sequence>
																						</xsd:complexType>
																					</xsd:element>
																					<xsd:element name="Address2">
																						<xsd:complexType>
																							<xsd:sequence>
																								<xsd:element name="Zipcode" minOccurs="0" type="xsd:string"/>
																								<xsd:element name="City" minOccurs="0" type="xsd:string"/>
																								<xsd:element name="Location" minOccurs="0">
																									<xsd:complexType>
																										<xsd:sequence>
																											<xsd:element name="Street" minOccurs="0" type="xsd:string"/>
																											<xsd:element name="Number" minOccurs="0" type="xsd:string"/>
																										</xsd:sequence>
																									</xsd:complexType>
																								</xsd:element>
																							</xsd:sequence>
																						</xsd:complexType>
																					</xsd:element>
																				</xsd:choice>
																			</xsd:sequence>
																		</xsd:complexType>
																	</xsd:element>
																</xsd:sequence>
															</xsd:complexType>
														</xsd:element>
													</xsd:sequence>
												</xsd:complexType>
											</xsd:element>
										</xsd:sequence>
									</xsd:complexType>
								</xsd:element>
								<xsd:element name="Unit8" minOccurs="0" maxOccurs="unbounded">
									<xsd:complexType>
										<xsd:sequence>
											<xsd:element name="Person" minOccurs="0" maxOccurs="unbounded">
												<xsd:complexType>
													<xsd:sequence>
														<xsd:choice>
															<xsd:element name="PrimaryPerson">
																<xsd:complexType>
																	<xsd:sequence>
																		<xsd:element name="Identification" minOccurs="0" type="xsd:string"/>
																		<xsd:element name="Initials" minOccurs="0" type="xsd:string"/>
																		<xsd:element name="FamilyName" minOccurs="0" type="xsd:string"/>
																	</xsd:sequence>
																</xsd:complexType>
															</xsd:element>
															<xsd:element name="SecundaryPerson">
																<xsd:complexType>
																	<xsd:sequence>
																		<xsd:element name="Identification" minOccurs="0" type="xsd:string"/>
																		<xsd:element name="RelationalType" minOccurs="0" type="xsd:string"/>
																	</xsd:sequence>
																</xsd:complexType>
															</xsd:element>															
														</xsd:choice>
													</xsd:sequence>
												</xsd:complexType>
											</xsd:element>
											<xsd:element name="AddressCollection" minOccurs="0" maxOccurs="unbounded">
												<xsd:complexType>
													<xsd:sequence>
														<xsd:choice>
															<xsd:element name="Address1">
																<xsd:complexType>
																	<xsd:sequence>
																		<xsd:element name="Zipcode" minOccurs="0" type="xsd:string"/>
																		<xsd:element name="City" minOccurs="0" type="xsd:string"/>
																		<xsd:element name="Location" minOccurs="0">
																			<xsd:complexType>
																				<xsd:sequence>
																					<xsd:element name="Street" minOccurs="0" type="xsd:string"/>
																					<xsd:element name="Number" minOccurs="0" type="xsd:string"/>
																				</xsd:sequence>
																			</xsd:complexType>
																		</xsd:element>
																	</xsd:sequence>
																</xsd:complexType>
															</xsd:element>
															<xsd:element name="Address2">
																<xsd:complexType>
																	<xsd:sequence>
																		<xsd:element name="Zipcode" minOccurs="0" type="xsd:string"/>
																		<xsd:element name="City" minOccurs="0" type="xsd:string"/>
																		<xsd:element name="Location" minOccurs="0">
																			<xsd:complexType>
																				<xsd:sequence>
																					<xsd:element name="Street" minOccurs="0" type="xsd:string"/>
																					<xsd:element name="Number" minOccurs="0" type="xsd:string"/>
																				</xsd:sequence>
																			</xsd:complexType>
																		</xsd:element>
																	</xsd:sequence>
																</xsd:complexType>
															</xsd:element>
														</xsd:choice>
													</xsd:sequence>
												</xsd:complexType>
											</xsd:element>
										</xsd:sequence>
									</xsd:complexType>
								</xsd:element>
							</xsd:sequence>
						</xsd:complexType>
					</xsd:element>
				</xsd:choice>
			</xsd:sequence>
		</xsd:complexType>
	</xsd:element>
</xsd:schema>

[Kenji Watanabe]

The wsdl:

<?xml version="1.0" encoding="UTF-8"?>
<wsdl:definitions xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
	xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
	xmlns:http="http://schemas.xmlsoap.org/wsdl/http/"
	xmlns:xsd="http://www.w3.org/2001/XMLSchema"
	xmlns:req="http://schemas.mydomain.com/Messages/Request"
	xmlns:rsp="http://schemas.mydomain.com/Messages/Response"
	xmlns:hdr="http://schemas.mydomain.com/Header"
	xmlns:flt="http://schemas.mydomain.com/ApplicationFault"
	xmlns:srv="http://schemas.mydomain.com/Services/Accounting"
	targetNamespace="http://schemas.mydomain.com/Services/Accounting">
	<wsdl:types>
		<xsd:schema>
			<xsd:import namespace="http://schemas.mydomain.com/Messages/Request"
				schemaLocation="request"/>
			<xsd:import namespace="http://schemas.mydomain.com/Messages/Response"
				schemaLocation="response.xsd"/>
			<xsd:import namespace="http://schemas.mydomain.com/Header"
				schemaLocation="header.xsd"/>
			<xsd:import namespace="http://schemas.mydomain.com/ApplicationFault"
				schemaLocation="applicationfault.xsd"/>
		</xsd:schema>
	</wsdl:types>
	<wsdl:message name="Request">
		<wsdl:part name="Request" element="req:Request"/>
	</wsdl:message>
	<wsdl:message name="Response">
		<wsdl:part name="Response" element="rsp:Response"/>
	</wsdl:message>
	<wsdl:message name="Header">
		<wsdl:part name="Header" element="hdr:Header"/>
	</wsdl:message>
	<wsdl:message name="Fault">
		<wsdl:part name="Fault" element="flt:ApplicationFault"/>
	</wsdl:message>
	<wsdl:portType name="WsPortType">
		<wsdl:operation name="Accounting">
			<wsdl:input message="srv:Request"/>
			<wsdl:output message="srv:Response"/>
			<wsdl:fault name="Fault" message="srv:Fault"/>
		</wsdl:operation>
	</wsdl:portType>
	<wsdl:binding name="HttpBinding" type="srv:WsPortType">
		<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
		<wsdl:operation name="Accounting">
			<soap:operation soapAction="" style="document"/>
			<wsdl:input>
				<soap:body use="literal"/>
				<soap:header message="srv:Header" part="Header" use="literal"/>
			</wsdl:input>
			<wsdl:output>
				<soap:body use="literal"/>
				<soap:header message="srv:Header" part="Header" use="literal"/>
			</wsdl:output>
			<wsdl:fault name="Fault">
				<soap:fault name="Fault" use="literal"/>
			</wsdl:fault>
		</wsdl:operation>
	</wsdl:binding>
	<wsdl:service name="AccountingService">
		<wsdl:port name="WsPort" binding="srv:HttpBinding">
			<soap:address location="https://webservices.mydomain.com/services/Accounting.soap"/>
		</wsdl:port>
	</wsdl:service>
</wsdl:definitions>

I have validated the wsdl and xsd's with XMLSpy.

When I worked with JAXB2-XJC directly I had a lot more duplication problems but I could fix them with a binding file on the response.xsd.

With Apache CFX the wsdl compiles without problems and only when using the Response object I see a problem with PrimaryPerson, so I would like to customize the name of that class for each occurrence,
but I don't know how I use XPath to get to the specific xsd in the binding file.

[Kenji Watanabe]

I think it's only down to the right XPath expression to get to the response.xsd where I am trying to modify the Person class name.
I did try an alternative binding but the schema node of the imported XSD can not be found:

[ERROR] Failed to execute goal org.apache.cxf:cxf-codegen-plugin:3.3.2:wsdl2java (generate-sources) on project 
accounting-service: Execution generate-sources of goal org.apache.cxf:cxf-codegen-plugin:3.3.2:wsdl2java failed: 
Could not find any node with the XPath expression: 
//wsdl:definitions/wsdl:types/xsd:schema[@targetNamespace='http://schemas.mydomain.com/Messages/Response'] -> [Help 1]

This is the result from my XJB

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jaxws:bindings xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
				xmlns:jaxws="http://java.sun.com/xml/ns/jaxws"
				xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" version="2.1"
				xmlns:xsd="http://www.w3.org/2001/XMLSchema"
				wsdlLocation="../wsdl/original.wsdl">

	<jaxws:bindings node="wsdl:definitions/wsdl:types/xsd:schema[@targetNamespace='http://schemas.mydomain.com/Messages/Response']">

		<jaxb:globalBindings localScoping="toplevel"/>

		<jaxb:bindings node="//xsd:element[@name='Relation']//xsd:element[@name='PrimaryPerson']/xsd:complexType">
			<jaxb:class name="PrimaryPersonRel"/>
		</jaxb:bindings>
		<jaxb:bindings node="//xsd:element[@name='Unit8']//xsd:element[@name='PrimaryPerson']/xsd:complexType">
			<jaxb:class name="PrimaryPersonU8"/>
		</jaxb:bindings>
	</jaxws:bindings>

</jaxws:bindings>

Background info: my directory structure is

└───resources
   │   application.yml
   │   logback.xml
   │
   ├───custom
   │      custom.xjb
   │
   ├───schema
   │      applicationfault.xsd
   │      header.xsd
   │      request.xsd
   │      response.xsd
   │
   └───wsdl
           original.wsdl

[Kenji Watanabe]

Ok, I got it solved.

You do not need to reference the import path in the wsdl, only include the path to the xsd in the external binding file:

<?xml version="1.0" encoding="UTF-8"?>
<jaxb:bindings xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema" jaxb:version="2.0">

	<jaxb:bindings	schemaLocation="../schema/response.xsd">

        <jaxb:bindings node="//xsd:element[@name='Relation']//xsd:element[@name='PrimaryPerson']/xsd:complexType">
            <jaxb:class name="PrimaryPersonRel"/>
        </jaxb:bindings>
        <jaxb:bindings node="//xsd:element[@name='Unit8']//xsd:element[@name='PrimaryPerson']/xsd:complexType">
            <jaxb:class name="PrimaryPersonU8"/>
        </jaxb:bindings>

    </jaxws:bindings>

</jaxb:bindings>