Propriétés du cSOAP Standard - 7.1

Apache CXF - Mediation

author
Talend Documentation Team
EnrichVersion
7.1
EnrichProdName
Talend Data Fabric
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for ESB
Talend Real-Time Big Data Platform
task
Création et développement > Systèmes tiers > Composants Apache CXF (Médiation)
Gouvernance de données > Systèmes tiers > Composants Apache CXF (Médiation)
Qualité et préparation de données > Systèmes tiers > Composants Apache CXF (Médiation)
EnrichPlatform
Studio Talend

Ces propriétés sont utilisées pour configurer le cSOAP s'exécutant dans le framework de Jobs Standard.

Le composant cSOAP Standard appartient à la famille Connectivity.

Basic settings

Address

URL de l'endpoint du service où le service Web est fourni.

Si le cSOAP est utilisé pour consommer un service Web et que le lookup de l'endpoint utilise le Service Locator (si la case Use Service Locator est cochée), l'URL doit être "locator://anyAddress/".

Type

Sélectionnez le type que vous souhaitez utiliser pour fournir le service Web entre wsdlURL et serviceClass.

wsdlURL : Sélectionnez ce type pour fournir le service Web à partir d'un fichier WSDL. Sélectionnez Repository ou File pour fournir le service Web à partir d'une ressource de Route ou du système de fichiers.

serviceClass : Sélectionnez ce type pour fournir le service Web à partir d'une classe Java SEI (Service Endpoint Interface).

WSDL File

Ce champ s'affiche lorsque le type de service wsdlURL est sélectionné. Si le fichier WSDL se trouve dans le système de fichiers, parcourez votre système ou saisissez le chemin d'accès à votre fichier WSDL. S'il provient d'une ressource de Route, cliquez sur le bouton [...] et sélectionnez la ressource dans l'arborescence. La liste Version apparaît et vous permet de sélectionner une version parmi toutes celles de la ressource de Route.

Service configuration

Cette option apparaît lorsque l'option wsdlURL est sélectionnée dans la liste Type. Cela vous permet de configurer les informations de l'endpoint du service. Cliquez sur [...] pour ouvrir l'assistant de configuration du service.

Le champ WSDL, dans l'assistant, est automatiquement renseigné grâce au fichier WSDL défini dans le champ WSDL File. Vous pouvez également configurer le fichier WSDL directement dans l'assistant de configuration du service, d'une des manières suivantes :

  • Cliquez sur Browse... pour parcourir votre système ou saisir le chemin d'accès au fichier WSDL dans le système de fichiers.

  • Cliquez sur Services pour sélectionner un service sous le nœud Services.

  • Cliquez sur Resources pour sélectionner un service sous le nœud Resources.

Après avoir configuré le fichier WSDL, cliquez sur pour afficher les port(s) et les opérations disponibles dans les champs Port Name et Operation, respectivement. Sélectionnez celui que vous souhaitez utiliser et cliquez sur Finish. La case Operation est disponible uniquement lorsque le composant cSOAP est utilisé pour consommer un Service Web.

Service Class

Ce champ s'affiche lorsque le type de service serviceClass est sélectionné. Saisissez le nom de la classe du service à utiliser pour fournir le service Web.

Dataformat

Style d'échange des données. POJO, PAYLOAD, RAW ou CXF_MESSAGE.

POJOs : (Plain Old Java Objects) paramètres Java de la méthode invoquée sur le serveur cible.

PAYLOAD : charge utile du message (payload), contenu de soap:body.

RAW : message brut reçu par la couche de transport sans support de Service Activity Monitoring.

CXF_MESSAGE : message brut reçu par la couche de transport, avec support de Service Activity Monitoring.

Use GZip Compress Cochez cette case pour compresser les messages entrants au format GZip avant envoi.
Service Name Nom du service que ce service implémente. Il mappe vers wsdl:service@name au format ns:SERVICE_NAMEns est un préfixe valide de l'espace de nommage du service. Le champ est automatiquement renseigné à la fin de l'étape Service Configuration.

Port Name

Nom de l'endpoint que ce service implémente. Il mappe vers wsdl:port@name, au format ns:PORT_NAMEns est un préfixe valide de l'espace de nommage du service. Le champ est automatiquement renseigné à la fin de l'étape Service Configuration.

Allow Streaming

Cette option est disponible lorsque l'option PAYLOAD est sélectionnée dans la liste Dataformat. Cochez cette case pour garder le payload en tant qu'objet javax.xml.transform.Source permettant la mise en flux et non en mémoire tampon. Si cette option est désactivée, le composant cSOAP parse les messages entrants en éléments DOM.

Operation Name

Nom de l'opération que ce service implémente. Il mappe vers wsdl:operation@name, au format ns:OPERATION_NAMEns un préfixe valide de l'espace de nommage. Cette option est disponible lorsque le composant cSOAP utilisé consomme un service Web. Ce champ est automatiquement renseigné à l'a fin de l'étape Service configuration.

Use Service Registry

Cette option est disponible uniquement si vous avez souscrit à l'une des solutions Enterprise ESB de Talend .

Cochez cette case pour activer le registre de service. Cela permet une recherche d'endpoint dynamique et permet aux services d'être redirigés selon les informations récupérées du registre. Cela fonctionne uniquement dans le Runtime.

Lorsque le composant cSOAP est utilisé pour fournir un service Web, le service déployé dans le Runtime fonctionne avec le registre de service.

Lorsque le cSOAP est utilisé pour consommer un service Web :

Dans le champ Correlation Value, spécifiez un ID de corrélation ou laissez ce champ vide. Pour plus d'informations, lisez la description de l'option Use Business Correlation.

Dans les champs Username et Password, saisissez les informations d'authentification. Pour saisir le mot de passe, cliquez sur le bouton [...] à côté du champ Password, puis, dans la boîte de dialogue qui s'ouvre, saisissez le mot de passe entre guillemets doubles, puis cliquez sur OK afin de sauvegarder les paramètres.

Si un jeton SAML est enregistré dans le registre du service, vous devez spécifier le rôle du client dans le champ Role. Vous pouvez également cocher la case Propagate Credentials pour effectuer un appel si un utilisateur est déjà authentifié, en propageant les informations d'authentification. Vous pouvez saisir l'identifiant et le mot de passe d'authentification via STS afin de propager les informations d'authentification à l'aide de l'identifiant et du mot de passe, ou vous pouvez fournir l'alias, l'identifiant et le mot de passe à l'aide du certificat. Pour plus d'informations, consultez la description de l'option Use Authentication.

Pour plus d'informations concernant la configuration et l'utilisation du Service Registry, consultez le Guide utilisateur de Talend Administration Center et le Guide Talend ESB Infrastructure Services Configuration Guide (en anglais).

Use Service Locator
Fournit aux consommateurs de services un mécanisme pour découvrir les endpoints de service lors de l'exécution sans spécifier l'emplacement physique de l'endpoint. De plus, cela permet aux fournisseurs de services d'enregistrer et de supprimer du registre leurs endpoints de services dans le Service Locator.
Remarque :

Pour les consommateurs de services, l'URL doit être configurée comme "locator://anyAddress/" dans le champ CXF Configuration / Address.

La table Custom Properties apparaît lorsque la case Use Service Locator est cochée. Cliquez sur le bouton pour ajouter autant de propriétés que nécessaire dans la table. Saisissez le nom et la valeur de chaque propriété, respectivement dans les champs Property Name et Property Value, afin d'identifier le service. Pour plus d'informations concernant l'installation et la configuration du Service Locator, consultez le Guide Talend ESB Infrastructure Services Configuration Guide (en anglais).

Use Service Activity Monitor

Capture les événements et stocke les informations pour faciliter les analyses en profondeur de l'activité des services ainsi que suivre et tracer des messages via une transaction métier. Cette option peut être utilisée pour analyser les temps de réponse des services, identifier les modèles de transport, identifier les messages en entrée et en sortie des services et analyser les causes éventuelles de l'échec des appels du service, par exemple.

Cette fonctionnalité n'est pas supportée lorsque le mode de traitement utilisé est MESSAGE. Quand l'option MESSAGE est sélectionnée dans le champ Dataformat, la case Use Service Activity Monitor est décochée.

Cette option est également désactivée lorsque la case Use Service Registry est cochée, si vous avez souscrit à l'une des solutions Enterprise ESB de Talend .

Use Authentication

Cochez cette case pour activer l'option d'authentification. Sélectionnez Username Token, SAML Token (ESB runtime only), HTTP Basic ou HTTP Digest.

Lorsque le composant cSOAP est utilisé pour produire un service Web service, l'authentification via Username Token, SAML token ou HTTP Basic fonctionne uniquement dans le conteneur d'exécution. HTTP Digest n'est pas supporté. Lorsque l'option SAML Token (ESB runtime only) est sélectionnée, le cSOAP obtient le jeton SAML de l'en-tête de requête pour usage ultérieur dans le routage de message.

Lorsque le composant cSOAP est utilisé pour consommer un service Web, l'authentification via Username Token, HTTP Basic ou HTTP Digest fonctionne dans le studio et dans le conteneur d'exécution. L'authentification via SAML token fonctionne uniquement dans le conteneur d'exécution. Saisissez un nom d'utilisateur et un mot de passe dans les champs correspondants. Pour saisir le mot de passe, cliquez sur le bouton [...] à côté du champ Password, puis, dans la boîte de dialogue qui s'ouvre, saisissez le mot de passe entre guillemets doubles, puis cliquez sur OK afin de sauvegarder les paramètres.

Lorsque l'option SAML Token (ESB runtime only) est sélectionnée, vous pouvez fournir les informations d'authentification pour envoyer la requête ou effectuer l'appel si un utilisateur est authentifié, en propageant les informations d'authentification. Sélectionnez :

- : Saisissez l'identifiant et le mot de passe dans les champs correspondants afin d'accéder au service.

Propagate using U/P : Saisissez l'identifiant et le mot de passe utilisés pour vous authentifier via STS.

Propagate using Certificate : Saisissez l'alias et le mot de passe utilisés pour vous authentifier via STS.

Cette case disparaît lorsque la case Use Service Registry est cochée.

Use Authorization

Cette option est disponible uniquement si vous avez souscrit à l'une des solutions Enterprise ESB de Talend . Elle apparaît lorsque l'option SAML Token (ESB runtime only) est sélectionnée dans la liste Use Authentication.

Lorsque le composant cSOAP est utilisé pour fournir un service Web, cochez cette case pour activer l'autorisation.

Lorsque le composant cSOAP est utilisé pour consommer un service Web, cochez cette case pour invoquer les appels autorisés et spécifier le rôle du client dans le champ Role.

Pour plus d'informations concernant la gestion des rôles et et des droits des utilisateurs, consultez le Guide utilisateur de Talend Administration Center et le Guide Talend ESB Infrastructure Services Configuration Guide (en anglais).

Use Business Correlation

Cochez cette case pour activer l'option de corrélation afin que les services en chaîne soient groupés sous le même ID de corrélation.

Lorsque le cSOAP est utilisé pour fournir un service Web :

Le cSOAP extrait l'ID de corrélation du message de requête.

Si le message de requête ne contient pas d'ID de corrélation, le fournisseur crée automatiquement un ID de corrélation dans l'en-tête SOAP.

Lorsque le cSOAP est utilisé pour consommer un service Web :

Vous pouvez spécifier un ID de corrélation dans le champ Correlation Value à l'aide d'une chaîne de caractères ou d'une expression simple. Si vous laissez ce champ vide, cette valeur est générée automatiquement lors de l'exécution. L'ID de corrélation est créé dans l'en-tête SOAP personnalisé du message de requête et passée au service appelé.

Cette case disparaît lorsque la case Use Service Registry est cochée ou si l'option RAW est sélectionnée dans la liste Dataformat.

Advanced settings

Arguments Configurez les arguments facultatifs dans la table correspondante. Cliquez sur le bouton [+] autant de fois que nécessaire pour ajouter des arguments à la table. Cliquez ensuite sur le champ Value correspondant pour saisir une valeur. Consultez le site http://camel.apache.org/cxf.html (en anglais) pour voir les options d'URI disponibles.

Utilisation

Règle d'utilisation

Le composant cSOAP peut être un composant de début, un composant intermédiaire ou un composant de fin dans une Route.

Limitation

Du fait d'une incompatibilité de licence, un ou plusieurs Jar requis pour utiliser ce composant ne sont pas fournis. Vous pouvez installer les Jar manquants pour ce composant en cliquant sur le bouton Install dans l'onglet Component. Vous pouvez également trouver les Jar manquants et les ajouter dans l'onglet Modules de la perspective Integration de votre Studio. Pour plus d'informations, consultez la page Installation de modules externes.

L'utilisation de plusieurs composants cSOAP ayant le même nom dans une route n'est pas supportée.

Lorsque le composant cSOAP est utilisé pour consommer un service Web, si vous utilisez le format de données CXF_MESSAGE, le type du corps de la requête doit être javax.xml.transform.Source.class, ou bien le corps de cette requête sera vide.

Pour des exemples d'utilisation simple avec un proxy, par exemple, d'un cSOAP à un cProcessor à un cSOAP, vous devez utiliser le format de données RAW, sinon, le corps de la requête sera réinitialisé. S'il est affiché par le cProcessor, le corps de la requête en sortie sera vide.

Lorsque le cSOAP est utilisé pour consommer un service Web et que le format de données est POJO, PAYLOAD, ou CXF_MESSAGE, si une réponse Fault est retournée, le routage du message s'arrête. Dans ce cas, il est recommandé d'utiliser le composant cErrorHandler pour capturer le message Fault. Pour plus d'informations concernant le cErrorHandler, consultez cErrorHandler.