Modificar un mensaje SOAP desde Java
Imaginemos que tenemos el siguiente mensaje SOAP para la llamada a un WebService:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<cabeceraSOAP xmlns="http://switchoffandletsgo.blogspot.com/">
<ipOrigen>string</ipOrigen>
</cabeceraSOAP>
</soap:Header>
<soap:Body>
<SumaNumeros xmlns="http://switchoffandletsgo.blogspot.com/">
<intNum1>int</intNum1>
<intNum2>int</intNum2>
</SumaNumeros >
</soap:Body>
</soap:Envelope>
Se puede observar que el WebService tiene un método SumaNumeros que recibe dos enteros y devolvería la suma de ambos. Además contiene una cabecera SOAP en la que se debe enviar la dirección IP de origen.
Al generar las clases necesarias para realizar la llamada utilizando el WSDL del WebService, NetBeans no es capaz de reconocer la cabecera del mensaje SOAP, con lo que no podemos establecer directamente la variable cabeceraSOAP. Por lo tanto, tendremos que agregar un Handler que intervenga antes de realizar la llamada, y añada al mensaje la cabecera que necesitemos.
Para ello creamos una nueva clase, por ejemplo SumaNumerosHandler y pedimos que implemente la clase SOAPHandler<SOAPMessageContext>:
public class SumaNumerosHandler implements SOAPHandler<SOAPMessageContext> {
}
Después le pedimos a NetBeans que realice los imports necesarios y que implemente los métodos abstractos, con lo que nos aparecerá la definición de los métodos que tenemos que implementar:
public Set<QName> getHeaders() {
throw new UnsupportedOperationException("Not supported yet.");
}
public boolean handleMessage(SOAPMessageContext arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
public boolean handleFault(SOAPMessageContext arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
public void close(MessageContext arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
En concreto vamos a centrarnos en el método handleMessage, que se ocupará de capturar la salida o entrada del mensaje SOAP. Para el resto de métodos que no nos ocupan, vamos a definir una serie de valores de retorno por defecto:
public Set<QName> getHeaders() {
return Collections.EMPTY_SET;
}
public boolean handleFault(SOAPMessageContext messageContext) {
return true;
}
public void close(MessageContext context) {
}
Método handleMessage
Como se puede observar, este método recibe un parámetro SOAPMessageContext. Esta interface da acceso al mensaje SOAP en cada petición o respuesta que se realiza en la comunicación, pudiendo modificar el contenido de este mensaje.
Para obtener el mensaje, llamamos al método getMessage():
SOAPMessage msg = messageContext.getMessage();
También necesitaremos conocer la dirección en la que viaja el mensaje, esto es, si se trata de un mensaje de salida o de entrada. En nuestro caso, necesitaremos modificar únicamente el mensaje de salida (petición). Podemos obtener esta información mediante el método get(), tal como se ilustra en el siguiente fragmento de código:
boolean bolMsgSalida= (Boolean) messageContext.get(MessageContext.MESSAGE_OUTBOUND_PROPERTY);
Por último, para añadir la cabecera a nuestro mensaje de salida, vamos a hacer uso de una serie de objetos que nos permitirán editar y modificar el mensaje SOAP:
// Obtenemos el contenedor del mensaje SOAP
SOAPPart sp = msg.getSOAPPart();
// A partir del contendor, obtenemos el nodo "Envelope"SOAPEnvelope env = sp.getEnvelope();
// Instanciamos un objeto SOAPFactory para crear cualquier elemento perteneciente a un mensaje SOAP, en nuestro caso, los nodos que formarán la cabeceraSOAPFactory soapFactory = SOAPFactory.newInstance();
// Definimos los elementos a incluir en el mensajeSOAPElement soapElementoCabecera = soapFactory.createElement("cabeceraSOAP","","http://switchoffandletsgo.blogspot.com/");
SOAPElement soapIpOrigen= soapFactory.createElement("ipOrigen","", "http://switchoffandletsgo.blogspot.com/");
// Rellenamos la información del nodo ipOrigensoapIpOrigen.addTextNode("192.168.0.1");
// Incluimos los elementos dentro de los objetos correspondientessoapElementoCabecera.addChildElement(soapIpOrigen);
SOAPHeader soapHeader = env.addHeader(); // Crea un elemento cabecera SOAP
soapHeader.addChildElement(soapElementoCabecera);
Si no se ha producido ninguna excepción, el método devolverá true.
Este manejador de mensajes SOAP, debería generar el siguiente nodo dentro del mensaje que se enviará al servidor:
<soap:Header>Finalmente, debemos asignar el nuevo manejador al Web Service que queremos consumir. Para ello, accederemos a la carpeta "Web Service References" de nuestro proyecto de NetBeans, y pulsaremos con el botón derecho sobre el Web Service que queremos asignar. En el menú desplegable aparecerá la opción "Configure Handlers...".
<cabeceraSOAP xmlns="http://switchoffandletsgo.blogspot.com/">
<ipOrigen>1921.168.0.1</ipOrigen>
</cabeceraSOAP>
</soap:Header>
Únicamente tendremos que añadir "Add..." nuestra clase SumaNumerosHandler y aceptar.
A partir de este ejemplo, las opciones son infinitas, podemos modificar cualquier parte del mensaje SOAP, entrante o saliente, según sean nuestras necesidades. En todo caso, siempre que sea posible, la mejor opción reside en utilizar las clases y métodos que genera NetBeans a partir del WSDL del Web Service.