tRESTResponse - 6.1

Famille du composant

ESB/REST

Fonction

Le composant tRestResponse envoie une réponse HTTP et/ou HTTPS au client à la réception d'une requête HTTP et/ou HTTPS.

Objectif

Ce composant vous permet de retourner un code de statut HTTP spécifique au client comme réponse à une requête HTTP.

Basic settings

Return Body Type

Sélectionnez dans la liste le type du corps de la réponse, entre Document, String et Byte[].

Return status code

Sélectionnez un code de statut dans la liste pour indiquer le statut de la requête.

- <<Custom>> : Cette option vous permet de personnaliser le code de statut. Saisissez dans le champ le code de statut de votre choix.

- Bad Request (400) : La syntaxe de la requête est mauvaise ou la requête est impossible à effectuer.

- Internal Server Error (500) : Des conditions inattendues rencontrées par le serveur l'empêchent d'exécuter la requête.

- OK (200) : La requête a été exécutée.

- Resource Not Found (404) : Le serveur ne trouve aucune correspondance avec l'URI donnée.

Schema et Edit schema

Un schéma est une description de lignes, il définit le nombre de champs qui sont traités et passés au composant suivant.

Le schéma est en mode Built-in, c'est-à-dire créé et stocké localement pour ce composant.

Cliquez sur Edit schema pour modifier le schéma.

Le flux d'entrée est récupéré du composant connecté au tRESTResponse. Toute modification dans le flux d'entrée du tRESTResponse est automatiquement propagée au composant précédent.

Le flux de sortie du tRESTResponse est un champ codé en dur nommé body, dont le type est défini dans la liste Return Body Type.

Advanced settings

Response Headers

Saisissez la(les) paire(s) nom-valeur pour passer des réponses supplémentaires concernant la réponse. Pour plus d'informations concernant les en-têtes de réponses, consultez le site http://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html#sec6.2 (en anglais).

Drop JSON Response Root

Cochez cette case pour déposer l'élément JSON racine dans la réponse.

tStatCatcher Statistics

Cochez cette case pour collecter les données de log, aussi bien au niveau du Job qu'au niveau de chaque composant.

Global Variables

NB_LINE : nombre de lignes traitées. Cette variable est une variable After et retourne un entier.

ERROR_MESSAGE : message d'erreur généré par le composant lorsqu'une erreur survient. Cette variable est une variable After et retourne une chaîne de caractères. Cette variable fonctionne uniquement si la case Die on error est décochée, si le composant a cette option.

Une variable Flow fonctionne durant l'exécution d'un composant. Une variable After fonctionne après l'exécution d'un composant.

Pour renseigner un champ ou une expression à l'aide d'une variable, appuyez sur les touches Ctrl+Espace pour accéder à la liste des variables. A partir de cette liste, vous pouvez choisir la variable que vous souhaitez utiliser.

Pour plus d'informations concernant les variables, consultez le Guide utilisateur du Studio Talend.

Utilisation

Ce composant permet d'exposer un Job Talend en tant que service et de transmettre une requête à un service dans un Job puis retourne les résultats du Job en tant que réponse du service.

Le composant tRESTResponse doit être utilisé avec le tRESTRequest afin de fournir les résultats d'un Job en tant que réponse, dans le cas d'une communication de style requête-réponse.