JAXB / JAX-WS / JAX-RS

• JDK 1.6.0 includes JAX-WS 2.0 API.
• JDK 1.6.0_04 includes JAXB and JAX-WS 2.1 API. It is back-compatible with JAX-WS 2.0. You can use v2.1.x XJC generator and with minor efforts port it to JAXB 2.0 API (@XmlElementRef was added an extra attribute, javax.xml.ws.Service implementations have more extended interface, …).
  • JDK 1.6.0_14 includes JAXB 2.1.10 and JAX-WS 2.1.6 runtime.
• JDK 7 includes JAXP 1.4.5, JAXB 2.2.4, JAX-WS 2.2.4.
• JDK 8 includes JAXB 2.2.8.

More information:

• JAXB 2.0 Changelog
• Migrating JAXB 2.0 applications to JavaSE 6

Alternative SOAP implementations are listed in Alternative to Sun SAAJ SOAP implementation.

• Developing client application with locally packaged WSDL
• Metro: JAX-WS catalogue
• Using XML Catalogs
• Resolve the schema location from the classpath for maven-jaxb2-plugin

JAX-WS generator generates the exception, and the JAXB generator generates the Java bean containing the exception's data.

• To use args configuration option to pass the setting correctly:

  <configuration>
      ...
      <args>
          <arg>-httpproxy:proxy:8080</arg>
      </args>
  </configuration>

• To define JVM-wide proxy at maven execution or define system property MAVEN_OPTS="-Dhttp.proxyHost=proxy -Dhttp.proxyPort=8080"

import javax.xml.ws.BindingProvider;
import com.sun.xml.ws.developer.JAXWSProperties;
 
// 3 seconds (in milliseconds) to open a connection:
private static final Integer CONNECT_TIMEOUT = Integer.valueOf(3000);
// 10 seconds (in milliseconds) to retrieve the data from connection:
private static final Integer REQUEST_TIMEOUT = Integer.valueOf(10000);
...
 
MyPortType myPort = new MyService().getMyPort();
 
Map<String, Object> context = ((BindingProvider) myPort).getResponseContext();
 
context.put(JAXWSProperties.CONNECT_TIMEOUT, CONNECT_TIMEOUT);
context.put(JAXWSProperties.REQUEST_TIMEOUT, REQUEST_TIMEOUT);

import javax.activation.DataHandler;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.handler.MessageContext;
 
MyPortType myPort = new MyService().getMyPort();
 
Map<String, DataHandler> attachments = (Map<String, DataHandler>) ((BindingProvider) myPort).getResponseContext().get(MessageContext.INBOUND_MESSAGE_ATTACHMENTS);
 
DataHandler dataHandler = attachments.values().iterator().next();
... = dataHandler.getInputStream();

• You can use Spring SimpleJaxWsServiceExporter helper bean to export your WebService endpoints for example:

  <?xml version="1.0"?>
  <beans
      xmlns="http://www.springframework.org/schema/beans"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.springframework.org/schema/beans    http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
   
      <!-- Instantiate the bean manually or you can use @Service annotation + <context:component-scan /> -->
      <bean name="providerWS" class="org.mycompany.ws.MyProviderImpl" />
   
      <!-- This utility bean will scan all context beans for @WebService annotation and publish them on the given port: -->
      <bean class="org.springframework.remoting.jaxws.SimpleJaxWsServiceExporter">
          <property name="baseAddress" value="http://localhost:8999/" />
      </bean>
   
      <!--
          The helper bean that is a factory of WS client instances that implement the given interface.
          Check WSDL file for concrete values for "serviceName" and "portName".
      -->
      <bean name="providerWSClient" class="org.springframework.remoting.jaxws.JaxWsPortProxyFactoryBean">
          <property name="serviceInterface" value="org.mycompany.ws.api.MyProviderAPI" />
          <property name="wsdlDocumentUrl" value="http://localhost:8999/" />
          <property name="namespaceUri" value="http://myservice.mycompany.org/" />
          <property name="serviceName" value="MyProviderImplService" />
          <property name="portName" value="MyProviderPort" />
      </bean>
  </beans>

  Internally above approach uses build-in HttpServer. You can benefit from it, if you have developed you WebServers using e.g. Axis.

  Starting from Spring 3.0.4, the default values are inherited from @WebService annotation on MyProviderAPI interface. But due to 890, the annotation meta-information should be manually enhanced to make everything working.

• You can use Jetty to deploy the backed WAR file + Spring for the client.

<jaxb:bindings
    schemaLocation="../wsdl/address.xsd"
    node="//xsd:schema[@targetNamespace='http://mycompany.com/service']">
    <jaxb:schemaBindings>
        <jaxb:package name="com.mycompany.project" />
        <jaxb:nameXmlTransform>
            <jaxb:typeName prefix="Foo" suffix="Type" />
            <jaxb:anonymousTypeName prefix="Foo" suffix="Type" />
            <jaxb:elementName prefix="Foo" suffix="Element" />
        </jaxb:nameXmlTransform>
    </jaxb:schemaBindings>
</jaxb:bindings>

<jaxb:globalBindings>
    <xjc:simple />
</jaxb:globalBindings>

From Can JAXB parse large XML files in chunks: Use custom XMLStreamReader or some logic around it to skip uninteresting elements.

Mark your property using @XmlReadOnly.

• Mark you parent class with @XmlTransient. In this case all class properties will be populated to parent classes, but class itself will be excluded from domain model (so you cannot marshall/unmarshall it).
• Mark you parent class with @XmlAccessorType(XmlAccessType.NONE). You will have to duplicate both property setters and getters in your child class:

  ChildDocument.java

  public String getComment() {
      return super.getComment();
  }
  public void setComment(String comment) {
      super.setComment(comment);
  }

  or one can create package-info.java with the following content:

  package-info.java

  @XmlAccessorType(XmlAccessType.NONE)
  package test.sub;
   
  import javax.xml.bind.annotation.XmlAccessType;
  import javax.xml.bind.annotation.XmlAccessorType;

• Modular Schema Compilation
• Separate schema compilation
• Separate compilation