cxf-spring-boot-starter-jaxws.md

Spring Boot : JAX-WS : How to use cxf-spring-boot-starter-jaxws

ℹ️ Official documentation http://cxf.apache.org/docs/springboot.html#SpringBoot-SpringBootCXFJAX-WSStarter

...a little bit poor...

💡 This is a code first approach unlike spring-boot-starter-web-services explained here https://spring.io/guides/gs/producing-web-service/ that proposes a more complicated contract first approach.

Step 1: add a single dependency

In your pom.xml file (I let you deduce equivalence for Gradle) :

<dependency>
  <groupId>org.apache.cxf</groupId>
  <artifactId>cxf-spring-boot-starter-jaxws</artifactId>
  <version>3.2.4</version>
</dependency>

Step 2: optional configuration

In your application.properties file (I let you deduce equivalence for Yaml) :

cxf.path=/ws
cxf.servlet.load-on-startup=1
cxf.servlet.init.service-list-title=My App

ℹ️ cxf.path defaults to /services

Step 3: implement endpoints

Exemple package com.mycompany.myapp.soap.endpoint :

@Component
@javax.jws.WebService(serviceName = "SampleSoapService", portName = "SampleSoapPort", targetNamespace = "http://soap.myapp.mycompany.com/sample/")
public class SampleSoapService {
  private final MyService sampleService;
  public SampleSoapService(MyService sampleService) {
    this.sampleService = sampleService;
  }

  @WebResult(name = "version")
  public String wsVersion() {
    return "1.0";
  }

  @WebResult(name = "sample")
  public SampleDTO getEntityById(@WebParam(name = "idSample") @XmlElement(required = true) Long id) {
    return sampleService.getSampleEntity(id);
  }
}

Step 4: declare endpoints

I write a single @Configuration class to centralize the declarations :

@Configuration
public class WebServicePublisher {
  private static final String LOG_MSG_PATTERN = "Publishing CXF Webservice {}";
  private static final Logger LOGGER = LoggerFactory.getLogger(WebServicePublisher.class);

  @Autowired
  private SpringBus springBus;
  // inject here all endpoints
  @Autowired
  private SampleSoapService sampleSoapService;
  @Autowired
  private AnotherSampleSoapService anotherSampleSoapService;

  @Bean
  public Endpoint publishSampleEndpoint() {
    LOGGER.info(LOG_MSG_PATTERN, sampleSoapService);
    EndpointImpl endpoint = new EndpointImpl(springBus, sampleSoapService);
    endpoint.publish("/sample");
    return endpoint;
  }

  @Bean
  public Endpoint publishAnotherSampleEndpoint() {
    LOGGER.info(LOG_MSG_PATTERN, anotherSampleSoapService);
    EndpointImpl endpoint = new EndpointImpl(springBus, anotherSampleSoapService);
    endpoint.publish("/other");
    return endpoint;
  }

  // ... and more
}

Step 5: add some security

As usual use Spring Security :

@Configuration
@EnableWebSecurity
public class WebSecurityConfig extends WebSecurityConfigurerAdapter {
  @Override
  public void configure(AuthenticationManagerBuilder auth) throws Exception {
    auth.inMemoryAuthentication().withUser("admin-ws").password("{noop}secret").authorities("G_ADMIN_WS");
    //auth.authenticationProvider(your_custom_auth_provider);
  }

  @Override
  protected void configure(HttpSecurity http) throws Exception {
    // Avoid 403 - Could not verify the provided CSRF token because your session was not found.
    http.csrf().disable();
    // Secure each service with a single role
    http.authorizeRequests().anyRequest().hasAuthority("G_ADMIN_WS").and().httpBasic();
  }

  @Override
  public void configure(WebSecurity web) throws Exception {
    // let access everyone to the WSDL, the services list and CXF generated stylesheets or some unsecured endpoints
    web.ignoring().antMatchers("/ws", "/ws/unsecured").regexMatchers(".*\\?wsdl").regexMatchers(".*\\?stylesheet=.*");
  }
}

Step 6: add some JUnit tests

Simple test

Simply inject the endpoint and call methods :

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = WebEnvironment.NONE)
public class SampleSoapServiceTest {

  @Autowired
  private SampleSoapService endpoint;

  @Test
  public void test_wsVersion() {
    String version = endpoint.wsVersion();
    Assert.assertNotNull(version);
    Assert.assertTrue(version.length() > 0);
  }

  @Test
  public void test_getEntityById() {
    MyEntity entity = endpoint.getEntityById();
    Assert.assertNotNull(entity);
    // others assertions
  }
}

SOAP test

TODO

Step 7: Run & tests

• Access the endpoints list http://localhost:8080/myapp/ws
• Access a particular endpoint WSDL http://localhost:8080/myapp/ws/sample?wsdl
• Test your endpoints with SoapUI