cxf-codegen-plugin does not comply with cxf ValidationFeature

Question

According to ValidationFeature documentation in order for the validation to happen the operations input and output bindings must be annotated with @Valid

However, the webservice interface generated by cxf-codegen-plugin does not have these annotations, and I don't seem to find a command line argument or a plugin that allows to add them.

The @Valid annotations cannot be put in the implementation of the webservice interface without violating Liskov substitution principle: the reference implementation of JSR-349 (Hibernate Validator) in this case produces HV000151: A method overriding another method must not alter the parameter constraint configuration

Question: Is anybody aware of a way to annotate the cxf-generated webservice interface method parameters with @Valid?

I'm aware of the existance of the Annox plugin but this does not seems to be an easy task to accomplish with it. The easiest solution possible would be to manually add the @Valid annotation to the webservice interface but I'm not comfortable in modifying generated code

Example

pom.xml


    4.0.0
    org.example.www
    webservice-test-bval
    1.0.0-SNAPSHOT
    war
    Test bean validation on web service

    
        1.4.2.RELEASE
        1.5
        3.1.3
        3.0.1
    


    
        
            
                
                org.springframework.boot
                spring-boot-dependencies
                ${org.springframework.boot.version}
                pom
                import
            
        
    


    
        
        
            org.springframework.boot
            spring-boot-starter-web
        
        
            org.springframework.boot
            spring-boot-starter-tomcat
            provided
        
        
            org.springframework.boot
            spring-boot-starter-test
            test
        


        
        
            org.apache.cxf
            cxf-rt-frontend-jaxws
            ${org.apache.cxf.version}
        
        
            org.apache.cxf
            cxf-rt-transports-http
            ${org.apache.cxf.version}
        
        
        
            com.github.krasa
            krasa-jaxb-tools
            ${com.github.krasa.krasa-jaxb-tools}
            
                
                    javax.validation
                    validation-api
                
            
        
        
            org.hibernate
            hibernate-validator
        
    

    
        ${project.artifactId}
        

            
                org.apache.maven.plugins
                maven-compiler-plugin
                3.1
                
                    1.8
                    1.8
                
            
            
                org.springframework.boot
                spring-boot-maven-plugin
                ${org.springframework.boot.version}
            

            
                org.apache.maven.plugins
                maven-war-plugin
                
                    false
                
            

            
                org.apache.cxf
                cxf-codegen-plugin
                ${cxf-codegen-plugin.version}
                
                    
                        generate-sources
                        generate-sources
                        
                            ${project.build.directory}/generated/
                            
                                
                                    ${project.basedir}/src/main/resources/wsdl/test.wsdl
                                    classpath:wsdl/test.wsdl
                                    
                                        -xjc-XJsr303Annotations
                                    
                                
                            
                        
                        
                            wsdl2java
                        
                    
                
                
                    
                        com.github.krasa
                        krasa-jaxb-tools
                        ${com.github.krasa.krasa-jaxb-tools}

src/main/resources/wsdl/

test.wsdl

src/main/java/

org.example.test

package org.example.test;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.support.SpringBootServletInitializer;

@SpringBootApplication
public class Application extends SpringBootServletInitializer {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

package org.example.test;

import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;
import javax.jws.soap.SOAPBinding;
import javax.validation.Valid;
import javax.xml.bind.annotation.XmlSeeAlso;
import javax.xml.ws.RequestWrapper;
import javax.xml.ws.ResponseWrapper;

import org.example.test.ObjectFactory;

@WebService(targetNamespace = "http://www.example.org/test/", name = "testWS")
@XmlSeeAlso({ObjectFactory.class})
@SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE)
public interface TestWSValid {

    @WebMethod(operationName = "NewOperation", action = "http://www.example.org/test/NewOperation")
    @Valid @WebResult(name = "NewOperationResponse", targetNamespace = "http://www.example.org/test/", partName = "parameters")
    public NewOperationResponse newOperation(
            @Valid @WebParam(partName = "parameters", name = "NewOperation", targetNamespace = "http://www.example.org/test/")
        NewOperation parameters
    );
}

org.example.test.configuration

package org.example.test.configuration;

import javax.xml.ws.Endpoint;

import org.apache.cxf.Bus;
import org.apache.cxf.feature.Feature;
import org.apache.cxf.jaxws.EndpointImpl;
import org.apache.cxf.transport.servlet.CXFServlet;
import org.apache.cxf.validation.BeanValidationFeature;
import org.example.test.services.TestWSImpl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.ImportResource;

@Configuration
@ImportResource({ "classpath:META-INF/cxf/cxf.xml", "classpath:META-INF/cxf/cxf-servlet.xml" })
@ComponentScan({ "org.example.test" })
public class ApplicationConfiguration {

    @Autowired
    private Bus cxfBus;

    @Bean
    public Endpoint testWSEndpoint() {
        EndpointImpl endpoint = new EndpointImpl(cxfBus, new TestWSImpl());
        endpoint.setAddress("/testws");
        endpoint.publish();
        return endpoint;
    }

    @Bean
    public ServletRegistrationBean cxfServlet() {
        ServletRegistrationBean servlet = new ServletRegistrationBean(new CXFServlet(), "/services/*");
        servlet.setLoadOnStartup(1);
        return servlet;
    }

    @Bean
    public Feature validationFeature() {
        Feature validationFeature = new BeanValidationFeature();
        validationFeature.initialize(cxfBus);
        cxfBus.getFeatures().add(validationFeature);
        ConstraintViolationInterceptor interceptor = new ConstraintViolationInterceptor();
        cxfBus.getInFaultInterceptors().add(interceptor);
        cxfBus.getOutFaultInterceptors().add(interceptor);
        cxfBus.getProperties().put("exceptionMessageCauseEnabled", true);
        return validationFeature;
    }
}

package org.example.test.configuration;

import java.text.MessageFormat;
import java.util.stream.Collectors;

import javax.validation.ConstraintViolationException;

import org.apache.cxf.binding.soap.SoapMessage;
import org.apache.cxf.binding.soap.interceptor.AbstractSoapInterceptor;
import org.apache.cxf.binding.soap.interceptor.Soap11FaultOutInterceptor;
import org.apache.cxf.interceptor.Fault;
import org.apache.cxf.phase.Phase;

public class ConstraintViolationInterceptor extends AbstractSoapInterceptor {

    public ConstraintViolationInterceptor() {
        super(Phase.MARSHAL);
        getBefore().add(Soap11FaultOutInterceptor.class.getName());
    }

    private static final String TEMPLATE = "[{0}] {1} : {2}";

    @Override
    public void handleMessage(SoapMessage message) throws Fault {
        Fault fault = (Fault) message.getContent(Exception.class);
        Throwable exception = fault.getCause();
        if (exception instanceof ConstraintViolationException) {
            fault.setMessage(processConstraints((ConstraintViolationException) exception));
        }
    }

    private String processConstraints(ConstraintViolationException exception) {
        return exception.getConstraintViolations().stream().map((error) -> {
            return MessageFormat.format(TEMPLATE, error.getPropertyPath(), error.getMessage(), error.getInvalidValue());
        }).collect(Collectors.joining(System.lineSeparator()));
    }

}

org.example.test.services

package org.example.test.services;

import javax.jws.WebService;

import org.example.test.NewOperation;
import org.example.test.NewOperationResponse;
import org.example.test.ObjectFactory;
import org.example.test.TestWS;

@WebService(endpointInterface = "org.example.test.TestWS", portName = "TestWSPort", serviceName = "TestWS", targetNamespace = "http://www.example.org/test/")
public class TestWSImpl implements TestWS {

    @Override
    public NewOperationResponse newOperation(NewOperation parameters) {
        int in = parameters.getIn();
        NewOperationResponse response = new ObjectFactory().createNewOperationResponse();
        if (in < 10 || in > 20) {
            response.setOut("no no no");
        } else {
            response.setOut("OK");
        }
        return response;
    }

}

With reference to the project above, you can test that as long as TestWSImpl implements TestWS (the generated class) there is no validation occurring, but if TestWSImpl implements TestWSValid (the class that contains the generated code with the @Valid addition) then the validation works as expected

Babl · Accepted Answer

Apache CXF's wsdl2java support is pluggable. There is a META-INF/tools-plugin.xml descriptor that allows you to define custom generators ("frontend profiles"). So if you need a @Valid annotation on all cxf-generated webservice interfaces, you can just plug-in a custom SEIGenerator. Apache CXF uses Velocity templates to generate the SEI interfaces. So you just need to overwrite the default template with the custom one.

So instead of using the Anox or Krasa you can just create a simple cxf-codegen-plugin overwrite.

So lets create a separate project, still you can put it in the same project but in different module, but for better reusability I would say a new project.

pom.xml




    org.example.test
    valid-cxf
    1.0-SNAPSHOT
    4.0.0

    
        
            org.apache.cxf
            cxf-codegen-plugin
            ${org.apache.cxf.version}

Lets use service loader to define new default SEI generator.

src/main/resources/META-INF/tools-plugin.xml

Here we have defined a new SEIGenerator with name CustomSEIGenerator from the package com.example.plugin

Next lets define a velocity template with all of our overwrites (in our case just hardcoded @Valid annotation on web service interface) This one is based on the official CXF sei.vm

src/main/resources/valid-sei.vm

#if ($intf.packageJavaDoc != "")
/**
$intf.packageJavaDoc
 */
#end
package $intf.PackageName;

#if ($mark-generated == "true")
import javax.annotation.Generated;
#end
import javax.validation.Valid;
#foreach ($import in $intf.Imports)
import ${import};
#end

/**
#if ($intf.classJavaDoc != "")
 $intf.classJavaDoc
 *
 #end
 * This class was generated by $fullversion
 * $currentdate
 * Generated source version: $version
 * 
 */
#foreach ($annotation in $intf.Annotations)
 $annotation
#end
#if ($mark-generated == "true")
@Generated(value = "org.apache.cxf.tools.wsdlto.WSDLToJava", date =     "$currentdate", comments = "$fullversion")
#end
public interface $intf.Name ${sei-superinterface-string}{
#foreach ($method in $intf.Methods)

#if ($method.JavaDoc != "")
    /**
${method.JavaDoc}
     */
#end
#foreach ($annotation in $method.Annotations)
    $annotation
#end
@Valid
#if ($mark-generated == "true")
    @Generated(value = "org.apache.cxf.tools.wsdlto.WSDLToJava", date = "$currentdate")
#end
    public $method.returnValue ${method.Name}(#if($method.ParameterList.size() == 0))#end
#if($method.ParameterList.size() != 0)

#foreach ($param in ${method.ParameterList})
    $param
#end
)#end#if($method.Exceptions.size() > 0) throws#foreach($exception in $method.Exceptions) $exception.ClassName#if($method.Exceptions.size() != $velocityCount),#end#end#end;
#end
}

And at the end lets create the CustomSEIGenerator which will use our velocity template.

package org.example.test;

import org.apache.cxf.tools.common.ToolException;
import org.apache.cxf.tools.wsdlto.frontend.jaxws.generators.SEIGenerator;

import java.io.Writer;

/**
 * Just a sample custom generator which use custom velocity template to generate SEI
 *
 */
public class CustomSEIGenerator extends SEIGenerator {

    @Override
    protected void doWrite(String templateName, Writer outputs) throws ToolException {

        if (templateName.endsWith("/sei.vm")) {
            templateName = "valid-sei.vm";
        }

        super.doWrite(templateName, outputs);
    }
}

Assuming you have build the plugin overwrite and published to your local maven repo, next you just need to add a dependency information to your project pom.xml. So the pom from the question will remain the same only the cxf-codegen-plugin will get a new dependency.

In your pom.xml


        org.apache.cxf
        cxf-codegen-plugin
        ${cxf-codegen-plugin.version}
        
            
                generate-sources
                generate-sources
                
                        ${project.build.directory}/generated/
                        
                            
                                ${project.basedir}/src/main/resources/wsdl/test.wsdl
                                classpath:wsdl/test.wsdl
                            
                            
                                -fe
                                sample
                            
                        
                    
                    
                        wsdl2java
                    
                
            
            
                
                org.example.test                      
                valid-cxf
                1.0-SNAPSHOT

Thats it, now you can fully manage what and how is generated from your wsdl.

A fully working example can be found at this repo https://github.com/babltiga/cxf-valid-sample

cxf-codegen-plugin does not comply with cxf ValidationFeature

Answers (2)

Related Questions