Apache Synapse

Apache Synapse Présentation du produit 9 novembre 2007 Jean-François Hélie

Agenda

Responsabilité d’un ESB

Démo Apache Synapse

Web service et client Axis 2

Proxy HTTP

Traces

Haute disponibilité

Répartition de charges

Médiateur personnalisé

Gestion des erreurs

WS-Security

WS-Reliable Messaging

Questions

Responsabilité d’un ESB

Un ESB est un intermédiaire qui permet à des applications hétérogènes de communiquer au travers de protocole standards. Un ESB est un médiateur de messages dans différents protocoles

Principales responsabilités d’un ESB (extrait de « les ESB dans la soa » de Xebia ):

Réconcilier des mondes hétérogènes , à l'aide de standards d'interopérabilité ou de connecteurs spécialisés – c'est le rôle classique d'un middleware d'intégration.

Découpler consommateurs et fournisseurs de services : Un consommateur ne connaît que l'ESB et ne connaît ni les formats ni les protocoles d'échange spécifiques utilisés par le fournisseur du service.

Agréger des services de niveau N afin de construire des services de niveau N+1. Si l'agrégation est complexe, ou nécessite des structures de contrôle du flux d'exécution, un moteur d'orchestration, reposant par exemple sur le langage BPEL1, est mis à contribution.

Tracer les messages qui transitent. Devenant une zone de passage incontournable, l’ESB joue un rôle fondamental dans la traçabilité et le monitoring des traitements. Une telle fonctionnalité peut être fournie par l'ESB ou par une solution tierce adressant également les problématiques de SLA2, QoS3, BAM4, etc.

Démo Apache Synapse

Téléchargement d’Apache Synapse: http://apache.multidist.com/ws/synapse/1.0/synapse-1.0-bin.zip

Pré-requis: JDK 1.4.2+

Quick Start: http://ws.apache.org/synapse/Synapse_QuickStart.html

Exemples: http://ws.apache.org/synapse/Synapse_Samples.html

Gestion des Bugs: http:// issues.apache.org / jira / browse /SYNAPSE

La configuration d’Apache Synapse se fait dans un fichier XML: %SYNAPSE_HOME% epositoryconfsynapse.xml

Web service et client Axis 2

Création d’un web service Axis 2 de type JAX-RPC

package fr.jfhelie.axis2.sample;

import java.util.ArrayList;

import java.util.List;

public class UserManager {

public User getUser(String email) {

return new User("user1@gmail.com", "prénom1", "nom1");

}

public List<User> listUsers() {

List<User> users = new ArrayList<User>();

users.add(new User("user1@gmail.com", "prénom1", "nom1"));

users.add(new User("user2@gmail.com", "prénom2", "nom2"));

return users;

}

}

Fichier de déploiement services.xml :

<service>

<description>Exemple de web service</description>

<parameter name="ServiceClass">fr.jfhelie.axis2.sample.UserManager</parameter>

<operation name="getUser">

<messageReceiver class="org.apache.axis2.rpc.receivers.RPCMessageReceiver" />

</operation>

<operation name="listUsers">

<messageReceiver class="org.apache.axis2.rpc.receivers.RPCMessageReceiver" />

</operation>

</service>

Déploiement du fichier usermanager.aar dans le répertoire %AXIS2_HOME%/repository/services

Création du client avec l’outil Axis 2 Wsdl2Java

Proxy HTTP

Configuration d’Apache Synapse en proxy devant le serveur Axis 2

Configuration dans le fichier synapse.xml :

<definitions xmlns="http://ws.apache.org/ns/synapse">

<proxy name="usermanager">

<target>

<endpoint>

<address uri="http://localhost:8090/axis2/services/usermanager"/>

</endpoint>

<outSequence>

<send/>

</outSequence>

</target>

</proxy>

</definitions>

Erreur de fermeture des connexions HTTP 1.1 sous Windows:

http://issues.apache.org/jira/browse/SYNAPSE-136

java.io.IOException: Une connexion existante a dû être fermée par l'hôte distant

at sun.nio.ch.SocketDispatcher.read0(Native Method)

at sun.nio.ch.SocketDispatcher.read(SocketDispatcher.java:25)

at sun.nio.ch.IOUtil.readIntoNativeBuffer(IOUtil.java:233)

at sun.nio.ch.IOUtil.read(IOUtil.java:200)

Traces

Configuration dans le fichier synapse.xml pour tracer le message:

<target>

<endpoint>

</endpoint>

<outSequence>

<log level="full"/>

<send/>

</outSequence>

</target>

</proxy>

</definitions>

Résultat:

[HttpClientWorker-1] INFO LogMediator - To: http://www.w3.org/2005/08/addressing/anonymous, MessageID: urn:uuid:B5A12693538FF48E283728188451326-1728294687, Envelope:

<?xml version='1.0' encoding='utf-8'?>

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">

<soapenv:Body>

<ns:getUserResponse xmlns:ns="http://sample.axis2.jfhelie.fr">

<ns:return xmlns:ax210="http://sample.axis2.jfhelie.fr/xsd" type="fr.jfhelie.axis2.sample.User">

<ax210:email>user1@gmail.com</ax210:email>

<ax210:firstName>prÚnom1</ax210:firstName>

<ax210:lastName>nom1</ax210:lastName>

</ns:return>

</ns:getUserResponse>

</soapenv:Body>

</soapenv:Envelope>

Haute disponibilité (fail-over)

Configuration dans le fichier synapse.xml la haute disponibilité :

<target inSequence="in" outSequence="out"/>

</proxy>

<sequence name="out">

<send/>

</sequence>

<sequence name="in">

<send>

<endpoint>

<failover>

<endpoint>

<address uri="http://localhost:8090/axis2/services/usermanager">

<enableAddressing/>

<suspendDurationOnFailure>60</suspendDurationOnFailure>

</address>

</endpoint>

<endpoint>

<address uri="http://localhost:8091/axis2/services/usermanager2">

<enableAddressing/>

</address>

</endpoint>

</failover>

</endpoint>

</send>

</sequence>

</definitions>

Répartition de charges

Configuration dans le fichier synapse.xml :

</proxy>

<sequence name="out">

<send/>

</sequence>

<send>

<endpoint>

<loadbalance>

<endpoint>

<address uri="http://localhost:8090/axis2/services/usermanager">

<enableAddressing/>

</address>

</endpoint>

<endpoint>

<address uri="http://localhost:8091/axis2/services/usermanager2">

<enableAddressing/>

</address>

</endpoint>

</loadbalance>

</endpoint>

</send>

</sequence>

</definitions>

Médiateur personnalisé - 1/2

Création d’une classe qui implémente Mediator :

package fr.rsi.esb.mediator.synapse;

import javax.xml.namespace.QName;

import org.apache.synapse.Mediator;

import org.apache.synapse.MessageContext;

public class SampleMediator implements Mediator {

public boolean mediate(MessageContext mc) {

setLastName(mc, "nom-médiateur");

return true;

}

private void setLastName(MessageContext mc,String lastName) {

mc.getEnvelope().getBody().getFirstElement().getFirstElement()

.getFirstChildWithName(

new QName("http://sample.axis2.jfhelie.fr/xsd",

"lastName")).setText(lastName);

}

public int getTraceState() {

return 0;

}

public String getType() {

return null;

}

public void setTraceState(int traceState) {

}

}

Médiateur personnalisé - 2/2

Configuration du fichier synapse.xml :

<target>

<endpoint>

</endpoint>

<outSequence>

<class name="fr.rsi.esb.mediator.synapse.SampleMediator"/>

<send/>

</outSequence>

</target>

</proxy>

</definitions>

Gestion des erreurs

Configuration du fichier synapse.xml :

</proxy>

<send>

<endpoint>

</endpoint>

</send>

</sequence>

<sequence name="out" onError="fault">

<class name="fr.rsi.esb.mediator.synapse.SampleMediator"/>

<send/>

</sequence>

<sequence name="fault">

<log level="custom">

<property name="text" value="An unexpected error occured"/>

<property name="message" expression="get-property('ERROR_MESSAGE')"/>

</log>

<drop/>

</sequence>

</definitions>

WS-Security

WS-Security est une spécification qui permet de sécuriser des web services de manière intéropérable. La plupart des web services distribués dépendent du protocole pour les fonctions de sécurité, exemple: HTTPS, basic authentification. Cette approche est limitée car elle ne permet pas la distribution sur des protocoles non sécurisables et ne garantit pas que le message est sécurisé d'un point à un autre. WS-Security utilise des modèles de sécurité existants (comme Kerberos et X509)

WS-Security permet:

l'ajout d’un timestamp dans le header du message SOAP pour permettre la validation de sa durée de vie,

la signature d'une partie ou de la totalité du message pour garantir que le message n'a pas été corrompu par un tiers,

le chiffrement du message pour garantir la confidentialité des données échangées

Apache Synapse possède nativement un médiateur permettant de gérer les messages de type WS-Security

WS-Reliable Messaging

WS-Reliable Messaging (WSRM) est un protocole d’échanges fiables de messages de type web services. Les messages échangés en TCP/IP ne sont pas garantit d’être reçu à leur destinataire exactement une fois dans le bon ordre. WSRM permet de le garantir par l’intermédiaire de l’établissement d’une conversation et d’un système d’accusé de réception.