Apache CXF e MTOM

Nesse artigo vamos examinar um mecanismo eficiente de envio de dados bin�rios a Webservices conhecido por MTOM (Message Transmission Optimization Mechanism) e XOP (XML-Binary Optimization Packaging) e como � o suporte a essa funcionalidade dentro do framework Apache CXF.

Figura 1. Processamento utilizando MTOM

Se voc� olhar as informaç�es sobre MTOM no site do W3C pode ficar realmente confuso com a quantidade de especificaç�es e documentaç�es. Mas como sempre, basta dar uma olhada com calma para perceber que � mais simples do que parece. Resumidamente, vamos identificar as 3 especificaç�es que definem o que � MTOM e como ele deve funcionar:

SOAP Transmission Optmization Feature: descreve de forma abstrata como se otimizar a transmiss�o e o formato de uma mensagem SOAP atrav�s da codificaç�o seletiva de partes de suas partes sem falar exatamente qual o formato da serializaç�o em si. Se uma mensagem � transmitida entre v�rios n�s, os participantes podem escolher formas diferentes de otimizar a transmiss�o.
Optmized MIME Multipart/Related Serialization of SOAP Messages: � a implementaç�o da funcionalidade descrita acima, mas sem estar amarrado a um binding espec�fico (SOAP com HTTP ou outros). Para tanto, o XOP � utilizado. O XOP nada mais � do que uma convenç�o que define a melhor maneira de se serializar um XML Infoset. Mais detalhes aqui
HTTP SOAP Transmission Optimization Feature. usa a implementaç�o de �Optmized MIME Multipart/Related Serialization of SOAP Messages� para descrever como � o �SOAP Transmission Optmization Feature� em HTTP. Em termos simples, descreve como transmitir dados bin�rios utilizando SOAP e HTTP.

Agora ficou f�cil demais! Fica claro que os profissionais do W3C se preocuparam em criar definiç�es cujas implementaç�es pudessem ser evolu�das com o tempo, em novos protocolos ou formatos mais otimizados da� essa separaç�o em v�rias camadas.

Agora vamos ver o que o framework Apache CXF tem para n�s com relaç�o ao MTOM. Para maiores detalhes, vale a pena dar uma olhada nessa p�gina.

Antes de mais nada, vamos definir o nosso WebService utilizando JAX-WS.


package br.com.devmedia.helloworldservice;

import javax.jws.WebResult;
import javax.jws.WebService;
import javax.xml.ws.soap.MTOM;

@WebService(targetNamespace = HelloService.NS)
@MTOM(enabled=true)
@org.apache.cxf.interceptor.InInterceptors(interceptors = { 
"org.apache.cxf.interceptor.LoggingInInterceptor" })
@org.apache.cxf.interceptor.OutInterceptors(interceptors = { 
"org.apache.cxf.interceptor.LoggingOutInterceptor" })
public interface HelloService {
	String NS = "http://devmedia.sayhello";

	@WebResult(name = "response")
	public abstract PersonInfo digaOla(PersonInfo info) ;
}

Listagem 1. Serviço utilizando suporte MTOM

A primeira coisa que nos chama a atenç�o � a anotaç�o MTOM. Ao adiciona-la, informamos ao Apache CXF que esse serviço suporta o uso do padr�o. Na nossa operaç�o digaOla, recebemos um objeto complexo por par�metro do tipo PersonInfo. � esse objeto que encapsula as informaç�es bin�rias. Vamos ver como isso � implementado utilizando o JAXB (listagem 2).


import javax.activation.DataHandler;
import javax.xml.bind.annotation.XmlMimeType;
import javax.xml.bind.annotation.XmlType;


@XmlType
public class PersonInfo {
	
	private DataHandler binaryData;

	@XmlMimeType("application/octet-stream")
	public DataHandler getBinaryData() {
		return binaryData;
	}

	public void setBinaryData(DataHandler binaryData) {
		this.binaryData = binaryData;
	}
}

Listagem 2. Objeto que carrega informaç�es bin�rias

A classe PersonInfo � tamb�m muito simples e carrega apenas um atributo do tipo DataHandler. A classe DataHandler do pacote javax.activation � simplesmente uma abstraç�o que representa uma transfer�ncia de dados entre v�rias origens e em qualquer formato. Dessa forma, programadores n�o precisam se preocupar como ser� utilizado o XOP ou qualquer outra codificaç�o, pois isso fica por conta do Apache CXF.

O nosso serviço j� consegue receber e transmitir grandes volumes de informaç�o bin�ria. Vamos examinar na listagem 3 para ver como � a implementaç�o de um cliente simples para o nosso serviço.


HelloService hello = service.getPort(portName, HelloService.class);
SOAPBinding binding = (SOAPBinding) ((BindingProvider)hello).getBinding();
binding.setMTOMEnabled(true);

PersonInfo info = new PersonInfo();
File f;
try {
	f = new File(SimpleNormalHelloService.class.getResource("/java.png").toURI());
	DataSource ds = new FileDataSource(f);
	DataHandler dh = new DataHandler(ds);
	info.setBinaryData(dh);
	PersonInfo result = hello.digaOla(info);
	result.getBinaryData();
	Assert.assertNotNull(result);
} catch (URISyntaxException e) {
	e.printStackTrace();
}

Listagem 3. Cliente para serviço HelloService

No nosso cliente, vemos dois aspectos interessantes: primeiro o MTOM habilitado no Binding. Isso far� com que o cliente mande requisiç�es com o formato otimizado. Em segundo, de forma bem simples criamos um DataHandler que encapsula as informaç�es bin�rias que desejamos enviar para o serviço. Para finalizar, vamos dar uma olhada como ficou a requisiç�o SOAP na listagem 4.


Address: http://localhost:9292/hello
Encoding: UTF-8
Http-Method: POST
Content-Type: multipart/related; type="application/xop+xml"; 
boundary="uuid:0b2e9c8c-3b23-49bc-a925-b2b0435616af"; 
start="<root.message@cxf.apache.org>"; start-info="text/xml"
Headers: {Accept=[*/*], SOAPAction=[""]}
Payload: 
--uuid:0b2e9c8c-3b23-49bc-a925-b2b0435616af
Content-Type: application/xop+xml; charset=UTF-8; type="text/xml";
Content-Transfer-Encoding: binary
Content-ID: <root.message@cxf.apache.org>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:digaOla xmlns:ns2="http://devmedia.sayhello">
<arg0>
<binaryData>
<xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" 
href="cid:784823ae-1a42-4ed1-a07e-153fb671c7ef-1@cxf.apache.org"/>
</binaryData>
</arg0>
</ns2:digaOla></soap:Body>
</soap:Envelope>
--uuid:0b2e9c8c-3b23-49bc-a925-b2b0435616af
Content-Type: application/octet-stream
Content-Transfer-Encoding: binary
Content-ID: <784823ae-1a42-4ed1-a07e-153fb671c7ef-1@cxf.apache.org>
Content-Disposition: attachment;name="java.png"

?PNG (binary data)

Listagem 4. Requisiç�o SOAP otimizada com MTOM

Vemos claramente na requisiç�o que o conte�do representado pelo cabeçalho Content-Type � o xop+xml. No payload SOAP, vemos na seç�o body a tag binaryData com um ID: 784823ae-1a42-4ed1-a07e-153fb671c7ef. Esse ID � uma refer�ncia ao conte�do bin�rio que est� um pouco mais abaixo do cabeçalho �Content-ID�.

Se � t�o f�cil e t�o otimizado, por que n�o mandar tudo utilizando isso? O overhead do uso do MTOM � consideravelmente alto j� que o conte�do bin�rio � codificado em base64, que faz com que o tamanho da mensagem aumente em cerca de 30%. Isso o torna ineficaz para mensagens pequenas. Al�m do mais, existe o XML FastInfoset que j� � um padr�o eficiente para mensagens menores.

Pessoal, com esse artigo conseguimos de uma maneira muito simples entender o que � MTOM e ver como � extremamente simples enviar conte�do bin�rio para um WebService. N�o se esqueçam de dar uma olhada no projeto completo no GitHub.

Apache CXF e MTOM

Veja neste artigo um mecanismo eficiente de envio de dados binários a Webservices conhecido por MTOM (Message Transmission Optimization Mechanism) e XOP (XML-Binary Optimization Packaging) e como é o suporte a eles dentro do Apache CXF.

Artigos relacionados