Utilisation du protocole de transfert HTTP avec ICS

WebSphere Partner Gateway vous permet d'échanger des documents avec WebSphere InterChange Server (ICS) via le protocole de transfert HTTP.

Remarque : Si vous échangez des documents SOAP via le protocole HTTP, voir Envoi de documents SOAP sur HTTP/S.

Cette section fournit les informations suivantes sur la manière de configurer InterChange Server et les adaptateurs appropriés en vue de leur utilisation avec WebSphere Partner Gateway sur HTTP :

Composants requis pour les documents envoyés à ICS sur HTTP

Pour que WebSphere Partner Gateway puisse communiquer avec InterChange Server via le protocole HTTP, vous devez configurer ces deux composants. tableau 41 résume ces étapes de configuration.

Tableau 41. Configuration de WebSphere Partner Gateway et d'InterChange Server
Composant Version Pour plus d'informations
WebSphere Partner Gateway 6.0

Configuration pour l'envoi de documents à ICS via le protocole de transfert HTTP

Configuration pour la réception de documents depuis ICS via le protocole de transfert HTTP

WebSphere InterChange Server 4.2.2 ou supérieure Création d'artefacts ICS pour HTTP

Pour échanger un document entre WebSphere Partner Gateway et InterChange Server via le protocole HTTP, vous devez utiliser les composants répertoriés dans le tableau 42.

Tableau 42. Composants requis pour envoyer des documents à l'aide d'InterChange Server via HTTP
Composant Description Remarques et limitations

WebSphere Business Integration Adapter for HTTP

(Adapter for HTTP)

Ce composant permet à InterChange Server d'échanger des objets métier avec des applications qui envoient ou reçoivent des données sous la forme de flux HTTP.

Utilisez la version 4.2.1 de d'Adapter for HTTP.
Un gestionnaire de données utiles Ce gestionnaire de données convertit les données utiles du document (généralement au format XML) en représentation d'objet métier. Ce gestionnaire de données est indispensable et doit prendre en charge le type MIME du document contenant les données utiles.
Attachment Data Handler

Ce gestionnaire de données traite les documents en pièce jointe de votre message.

Ce gestionnaire de données est nécessaire uniquement si votre document contient des pièces jointes.

Les sections suivantes décrivent la façon dont les composants répertoriés dans le tableau 42 fonctionnent conjointement pour permettre l'échange de documents entre WebSphere Partner Gateway et InterChange Server via le protocole HTTP.

Envoi de documents à ICS via HTTP

Pour que WebSphere Partner Gateway envoie un document à InterChange Server par le biais du protocole HTTP, vous devez utiliser le composant Adapter for HTTP afin de récupérer le document que WebSphere Partner Gateway a envoyé sous la forme d'un flux HTTP. L'adaptateur achemine ensuite le document vers InterChange Server. La figure 18 illustre comment WebSphere Partner Gateway envoie des documents à InterChange Server via le protocole HTTP.

Figure 18. Flux de messages entre WebSphere Partner Gateway et une collaboration via HTTP
Cette figure montre comment un document est envoyé à WebSphere Partner Gateway, comment WebSphere Partner Gateway envoie le message de demande HTTP à Adapter for HTTP, comment Adapter for HTTP appelle le gestionnaire de données utiles et envoie l'objet métier résultant à une collaboration.

Réception de documents à partir d'ICS via HTTP

Pour que WebSphere Partner Gateway puisse recevoir un document issu d'InterChange Server par le biais du protocole HTTP, vous devez utiliser le composant Adapter for HTTP qui envoie le message reçu depuis InterChange Server sous la forme d'un flux HTTP que WebSphere Partner Gateway peut extraire. La figure 19 illustre comment WebSphere Partner Gateway reçoit des documents à partir d'InterChange Server via le protocole HTTP.

Figure 19. Flux de messages entre une collaboration et WebSphere Partner Gateway via HTTP
Cette figure montre comment un objet métier est envoyé depuis unecollaboration à Adapter for HTTP, comment Adapter for HTTP appelle le gestionnaire de données utiles et envoie le fluxHTTP résultant à WebSphere Partner Gateway.

Configuration de l'environnement requis pour HTTP avec ICS

Etant donné que l'échange de documents sur InterChange Server nécessite l'utilisation d'adaptateurs et de gestionnaires de données, vous devez effectuer les tâches d'installation et de configuration sur le Adapter for HTTP. Pour plus d'informations sur la manière de configurer WebSphere Partner Gateway pour une utilisation avec InterChange Server via HTTP, voir Configuration de WebSphere Partner Gateway pour InterChange Server.

Adapter for HTTP permet à WebSphere Partner Gateway d'échanger des documents avec InterChange Server sous la forme de messages HTTP. Il prend en charge les interactions suivantes avec InterChange Server :

Important : WebSphere Partner Gateway n'intègre pas WebSphere Business Integration Adapter for HTTP. Vous devez vous procurer ce produit séparément et l'installer conformément aux instructions figurant dans le document Adapter for HTTP User Guide. Reportez-vous à la documentation relative à l'adaptateur pour vérifier que la version de l'adaptateur est compatible avec la version d'InterChange Server que vous utilisez.

Lorsque vous avez configuré Adapter for HTTP pour communiquer avec InterChange Server, suivez les étapes décrites dans ces sections afin de configurer cet adaptateur pour qu'il soit à l'écoute des messages HTTP envoyés par WebSphere Partner Gateway :

Spécification du gestionnaire de données utiles

Comme l'illustre la figure 19, Adapter for HTTP utilise un gestionnaire de données pour convertir les objets métier reçus depuis InterChange Server dans un flux HTTP approprié.

Remarque : Le gestionnaire de données que le composant Adapter for HTTP appelle convertit les données utiles du document. Si votre document est encapsulé dans une enveloppe de transfert XML (il contient des pièces jointes ou l'Indicateur d'enveloppe a pour valeur Oui), configurez le composant Attachment Data Handler en tant que gestionnaire de données utiles. Pour plus d'informations, voir Gestion des documents contenant des pièces jointes.

Pour indiquer quel gestionnaire de données utiliser pour convertir les données utiles, vous devez procéder comme indiqué dans la section Conversion d'objet métier. Par ailleurs, vous devez configurer le composant Adapter for HTTP pour utiliser ce gestionnaire de données utiles. Vous pouvez définir le gestionnaire de données utiles de l'une des façons suivantes :

Configuration du nom des modules du gestionnaire de protocole

Le composant Adapter for HTTP utilise la propriété de configuration du connecteur JavaProtocolHandlerPackages pour identifier le nom des modules du gestionnaire de protocole Java. Pour permettre l'intégration avec WebSphere Partner Gateway, assurez-vous que la propriété JavaProtocolHandlerPackage est définie sur sa valeur par défaut :

com.ibm.net.ssl.internal.www.protocol

Configuration du programme d'écoute du protocole HTTP

Le composant Adapter for HTTP prend en charge les propriétés de configuration hiérarchiques pour obtenir les informations dont il a besoin pour configurer ses programmes d'écoute de protocole. La propriété de configuration de niveau supérieur s'appelle ProtocolListenerFramework. Cette propriété de niveau supérieur comporte plusieurs niveaux de sous-propriétés. Pour configurer les gestionnaires de protocole en vue de leur utilisation avec le module Adapter for HTTP, assurez-vous que les propriétés sont configurées dans la propriété ProtocolListener, comme décrit dans la procédure suivante :

  1. Configurez un programme d'écoute de protocole avec des sous-propriétés situées sous la propriété de configuration suivante :
    ProtocolListenerFramework
        ProtocolListeners
           HttpListener1

    Pour configurer votre programme d'écoute de protocole, définissez les sous-propriétés répertoriées dans le tableau 43.

    Tableau 43. Configuration du programme d'écoute de protocole
    Propriété Description Valeur
    Protocol

    Type de programme d'écoute de protocole :

    • HTTP
    • HTTPS

    http ou https

    Host Adresse IP sur laquelle le programme d'écoute de protocole est à l'écoute Adresse IP de l'ordinateur local sur lequel est exécuté WebSphere Partner Gateway
    Port Port sur lequel le programme d'écoute est à l'écoute des requêtes 8080
  2. Configurez les configurations d'URL que le programme d'écoute de protocole prend en charge avec des sous-propriétés situées en dessous de la propriété de configuration suivante :
    ProtocolListenerFramework
        ProtocolListeners
           HttpListener1
              URLsConfiguration
                 URL1

    Définissez la propriété ContextPath en lui affectant comme valeur l'identificateur URI des requêtes HTTP que le programme d'écoute de protocole reçoit.

    Remarque : Ce répertoire doit être le même que celui spécifié par WebSphere Partner Gateway comme identificateur URI cible. Pour plus d'informations, voir Configuration pour l'envoi de documents à ICS via le protocole de transfert HTTP.
  3. Si votre document contient des pièces jointes, vous devez configurer une transformation pour le programme d'écoute de protocole en définissant des sous-propriétés pour la propriété de configuration suivante :
    ProtocolListenerFramework
        ProtocolListeners
           HttpListener1
              URLsConfiguration
                 URL1
                    TransformationRules
                       TransformationRule1

    Pour configurer la transformation des pièces jointes pour votre programme d'écoute de protocole, définissez les sous-propriétés répertoriées dans le tableau 44. Vous avez besoin d'une règle de transformation pour chaque instance du composant Attachment Data Handler que vous utilisez. Pour plus d'informations sur le composant Attachment Data Handler, voir Gestion des documents contenant des pièces jointes.

    Tableau 44. Configuration de la transformation des pièces jointes pour le programme d'écoute de protocole
    Propriété Description Valeur
    ContentType Type de contenu des données à transformer à l'aide d'un gestionnaire de données Type de contenu associé aux données relatives aux pièces jointe
    MimeType Type MIME à utiliser pour identifier le gestionnaire de données à appeler Type MIME associé à l'instance du composant Attachment Data Handler
    Charset Jeu de caractères à utiliser lors de la transformation des données du type de contenu spécifié Jeu de caractères pour les données relatives aux pièces jointes

Pour plus d'informations sur ces propriétés, voir le document Adapter for HTTP User Guide.

Création de définitions d'objet métier pour ICS sur HTTP

Le composant Adapter for HTTP envoie votre document à InterChange Server et le reçoit sous la forme d'un objet métier de données utiles. Adapter for HTTP appelle le gestionnaire de données utiles pour gérer cet objet métier lorsqu'il reçoit ou envoie un document de WebSphere Partner Gateway, comme suit :

Par conséquent, vous devez créer des définitions d'objet métier comme illustré dans le tableau 45 pour représenter la structure d'objet métier de données utiles que le composant Adapter for HTTP attend.

Tableau 45. Définitions d'objets métier pour Adapter for HTTP
Condition Définition d'objet métier Pour plus d'informations
Si vous utilisez Aucun regroupement ou un Regroupement d'intégration dorsale pour votre message et si vos documents ne possèdent pas de pièces jointes

Objet métier de données utiles :

  • objet métier de niveau supérieur
  • objet métier de requête
  • un objet métier de réponse (facultatif)
  • un objet métier d'échec (facultatif)
Création de la structure d'objet métier de données utiles pour ICS sur HTTP
Si vous utilisez le regroupement d'intégration dorsale pour votre message.

Ajoutez à l'objet métier de données utiles les objets métier destinés à contenir les informations d'en-tête du message :

  • métaobjet dynamique
  • objet métier Propriétés HTTP
Création d'informations d'en-tête de niveau de transfert HTTP pour ICS.
Si le document contient des pièces jointes Vous devez également créer des objets métier supplémentaires pour représenter les pièces jointes. Création de définitions d'objets métier liées aux pièces jointes

Création de la structure d'objet métier de données utiles pour ICS sur HTTP

Le Adapter for HTTP attend une structure d'objet métier de données utiles qui comprend les objets métier suivants :

La figure 20 illustre un exemple de structure d'objet métier correspondant à la définition d'un objet métier de données utiles à utiliser avec InterChange Server via le protocole HTTP.

Remarque : Pour obtenir une description détaillée de cette structure d'objet métier, voir le document Adapter for HTTP User Guide.
Figure 20. Structure d'objet métier pour l'objet métier de données utiles HTTP pour ICS
Cette figure montre un objet métier de niveau supérieur pointant sur un objet métier de demande et un objet métier de réponse.
Objet métier de niveau supérieur

L'objet métier de niveau supérieur est un encapsuleur des objets métier de requête et de réponse. Vous devez créer une définition d'objet métier pour cet objet métier. Le tableau 46 contient les attributs de la définition de l'objet métier de niveau supérieur.

Tableau 46. Attributs de l'objet métier de niveau supérieur
Attribut Type d'attribut Description
MimeType Chaîne

Définit le type de contenu et le format des données qui sont transmises à l'URL.

Charset Chaîne

Utilisé pour déterminer quel gestionnaire de données appeler.

Request Objet métier Objet métier enfant qui représente le message de requête. L'objectif de cet objet métier dépend de sa participation ou non au traitement des requêtes ou à la notification des événements. Pour plus d'informations sur la structure de l'objet métier, voir Objet métier de requête.
Réponse Objet métier Objet métier enfant qui représente le message de réponse (si vous attendez une réponse). L'objectif de cet objet métier dépend de sa participation ou non au traitement des requêtes ou à la notification des événements. Pour plus d'informations sur la structure de l'objet métier, voir Objet métier de réponse.
Remarque : Lorsque vous utilisez le composant Adapter for HTTP avec WebSphere Partner Gateway, vous n'avez pas besoin d'inclure d'objets métier d'échec dans votre objet métier de niveau supérieur.

Le tableau 47 récapitule les informations spécifiques à l'application que la définition d'objet métier de niveau supérieur peut contenir.

Tableau 47. Informations spécifiques à l'application relatives à la définition d'objet métier de niveau supérieur
Informations spécifiques à l'application Code Description
Niveau d'objet métier ws_mode Définit si l'interaction est synchrone ou asynchrone
Niveau de l'attribut ws_botype Définit l'attribut qui contient l'objet métier de requête ou de réponse

Pour obtenir une description complète de la structure de l'objet métier de niveau supérieur et les informations spécifiques à l'application qui lui sont associées, voir le document Adapter for HTTP User Guide.

Objet métier de requête

L'objet métier de requête contient les données à transmettre à l'URL. Il représente le message de requête HTTP. L'objectif de cet objet métier de requête dépend de la tâche à laquelle InterChange Server participe, par exemple :

Remarque : L'objet métier de niveau supérieur identifie ses objets métier enfant comme des objets métier de requête et de réponse. Toutefois, cette structure est utilisée à la fois dans le traitement des requêtes et la notification d'événements.

Pour obtenir une description de la structure de l'objet métier de requête, voir le document Adapter for HTTP User Guide. Pour l'utiliser avec WebSphere Partner Gateway, vous devez effectuer deux personnalisations de la structure de la définition de l'objet métier de requête :

Tableau 48. Codes contenus dans les informations d'application sur l'objet métier de requête
Code des informations spécifiques à l'application Description Obligatoire ?
ws_tloname Donne le nom de l'objet métier de niveau supérieur Obligatoire uniquement si la définition d'objet métier participe à la notification d'événements
cw_mo_http Indique le métaobjet de configuration de protocole HTTP, qui contient les zones d'en-tête de transfert HTTP. Pour plus d'informations, voir Création d'informations d'en-tête de niveau de transfert HTTP pour ICS. Obligatoire uniquement si vous utilisez le regroupement d'intégration dorsale

Remarque : Si vous utilisez le composant Attachment Data Handler pour traiter des documents encapsulés dans une enveloppe de transfert XML, vous devez modifier votre objet métier de requête pour qu'il contienne les pièces jointes, comme décrit dans Création de définitions d'objets métier liées aux pièces jointes.
Objet métier de réponse

L'objet métier de réponse contient les données à recevoir depuis l'URL. Il contient les attributs des différents codes XML utilisés dans le message de réponse. L'objectif de cet objet métier de réponse dépend de la tâche à laquelle InterChange Server participe, par exemple :

Que la réponse ait lieu dans le cadre du traitement des requêtes ou de la notification d'événements, un objet métier de réponse est envoyé uniquement si l'échange entre WebSphere Partner Gateway et InterChange Server est synchrone et qu'un objet métier est attendu en réponse à la requête.

Pour obtenir une description de la structure de l'objet métier d'échec, voir le document Adapter for HTTP User Guide. Pour l'utiliser avec WebSphere Partner Gateway, vous devez effectuer des personnalisations de la structure de la définition de l'objet métier de requête :

Si l'échange entre WebSphere Partner Gateway et InterChange Server est asynchrone, WebSphere Partner Gateway n'attend pas de réponse et vous n'avez donc pas besoin de créer un objet métier de réponse.

Création d'informations d'en-tête de niveau de transfert HTTP pour ICS

Si vous envoyez des documents avec le regroupement d'intégration dorsale sur le protocole de transfert HTTP, votre objet métier de requête doit contenir des informations d'en-tête de transfert personnalisé. Le composant Adapter for HTTP s'attend à ce que les informations d'en-tête personnalisé soient contenues dans un métaobjet dynamique.

La figure 21 illustre la structure de l'objet métier définie pour un objet métier de requête qui représente un document WebSphere Partner Gateway utilisant le regroupement d'intégration dorsale via le protocole HTTP.

Figure 21. Relation entre l'objet métier de requête et le métaobjet de configuration de protocole HTTP
Cette figure montre un objet métier de requête  pointant sur un objet de type HttpConfigMO_BusObj, qui pointe sur un objet métier de type HttpProps_BusObj, représentant les en-têtes de niveau de transfert.

Assurez-vous que la structure de l'objet métier inclut un métaobjet de configuration de protocole HTTP en procédant comme suit :

  1. Créez une définition d'objet métier destinée à contenir les propriétés HTTP requises par le regroupement d'intégration dorsale.
  2. Créez une définition d'objet métier pour le métaobjet de configuration de protocole HTTP.
  3. Modifiez la définition d'objet métier pour votre objet métier de requête afin d'inclure un attribut pour le métaobjet de configuration de protocole HTTP.

Chaque étape est décrite dans les sections ci-dessous.

Création de l'objet métier des propriétés définies par l'utilisateur

Le composant Adapter for HTTP prend en charge un objet métier des propriétés définies par l'utilisateur qui contient les propriétés personnalisées dans le métaobjet de configuration de protocole HTTP. WebSphere Partner Gateway utilise cet objet métier pour inclure les propriétés HTTP requises par le regroupement d'intégration dorsale. Il peut également contenir l'attribut Content-Type, qui spécifie l'en-tête du type de contenu à définir dans le message de requête ainsi que l'attribut de longueur du contenu qui détermine la longueur du message, en octets. Le tableau 5 décrit chaque zone valide de l'en-tête de transfert.

Pour créer une définition d'objet métier des propriétés définies par l'utilisateur pour les zones d'en-tête HTTP, procédez comme suit :

  1. Créez un attribut au sein de la définition de l'objet métier pour chaque zone d'en-tête de transfert.

    Tous les attributs doivent comporter un type d'attribut Chaîne. Vous pouvez affecter à l'attribut le même nom que la propriété HTTP (comme indiqué dans la colonne de la zone En-tête du tableau 5).

  2. Pour chacun des attributs contenus dans l'objet métier Propriétés HTTP, ajoutez les informations spécifiques à l'application qui permettent d'identifier l'objectif de l'attribut associé.

    Ces informations spécifiques à l'application au niveau de l'attribut ont le format suivant :

    ws_prop_name=HTTPproperty

    HTTPproperty est l'une des valeurs contenues dans la colonne zone En-tête du tableau 5.

Dans la figure 21, la définition de l'objet métier HttpProps_BusObj contient des attributs pour les différentes zones d'en-tête de transfert. Ces attributs possèdent tous des informations spécifiques à l'application au niveau des attributs afin de spécifier le nom de l'en-tête du protocole associé. Par exemple, les informations spécifiques à l'application de l'attribut x-aux-sender-id sont définies comme suit :

ws_prop_name=x-aux-sender-id
Création du métaobjet de configuration de protocole HTTP

Pour la notification d'événements, l'objet métier de requête, de réponse ou d'échec peut contenir un métaobjet dynamique appelé métaobjet de configuration de protocole HTTP destiné à contenir les informations de configuration (telles que les informations d'en-tête).

Pour obtenir une description de la structure de l'objet métier de configuration de protocole HTTP, voir le document Adapter for HTTP User Guide. Pour l'utiliser avec WebSphere Partner Gateway, vous devez effectuer les personnalisations suivantes de la structure de la définition de l'objet métier de configuration de protocole HTTP :

  1. Créez un attribut au sein de la définition de l'objet métier pour chaque zone requise.

    Tous les attributs doivent comporter un type d'attribut Chaîne.

    Remarque : Pour obtenir la liste complète des attributs contenus dans le métaobjet de configuration du protocole HTTP, voir le document Adapter for HTTP User Guide.
  2. Ajoutez l'attribut UserDefinedProperties à cette définition d'objet métier.

    Le type de cet attribut est la définition de l'objet métier des propriétés définies par l'utilisateur (voir Création de l'objet métier des propriétés définies par l'utilisateur).

Par exemple, dans la figure 21, la définition de l'objet métier HttpConfigMO_BusObj contient l'attribut UserDefinedProperties, de type HttpProps_BusObj.

Modification de la définition de l'objet métier de requête

La définition de l'objet métier de requête représente les informations demandées à WebSphere Partner Gateway. Pour plus d'informations sur la création d'un objet métier de requête, voir Objet métier de requête. Pour intégrer le métaobjet dynamique à votre structure d'objet métier de données utiles, vous devez effectuer les modifications suivantes dans la définition d'objet métier de requête :

  1. Ajoutez un attribut à votre définition d'objet métier de requête afin qu'il contienne le métaobjet de configuration de protocole HTTP.

    Le type de cet attribut est la définition d'objet métier du métaobjet de configuration de protocole HTTP (voir Création du métaobjet de configuration de protocole HTTP).

  2. Ajoutez le code cw_mo_http aux informations spécifiques à l'application au niveau de l'objet métier de votre définition d'objet métier de requête afin d'identifier l'attribut qui contient le métaobjet de configuration de protocole HTTP.

    Le code cw_mo_http a le format suivant :

    cw_mo_http=HttpConfigMetaObjAttr

    HttpConfigMetaObjAttr est le nom de l'attribut dans l'objet métier de requête qui contient le métaobjet de configuration de protocole HTTP.

Par exemple, dans la figure 21, un attribut nommé HttpConfigMO a été ajouté à la définition d'objet métier de requête, hub_HttpRequest_BusObj. Cet attribut contient le métaobjet dynamique, qui est un objet métier enfant du type HttpConfigMO_BusObj. Par ailleurs, les informations spécifiques à l'application de l'objet métier de requête ont été modifiées pour inclure le code cw_mo_http suivant afin d'identifier ce métaobjet dynamique :

cw_mo_http=HttpConfigMO

Création d'artefacts ICS pour HTTP

Pour configurer un InterChange Server pour qu'il communique avec WebSphere Partner Gateway via le protocole HTTP, vous devez créer les artefacts InterChange Server indiqués dans le tableau 49.

Tableau 49. Artefacts pour la communication avec ICS via le protocole HTTP
Artefact ICS Fonction Pour plus d'informations
Définitions d'objet métier Représentent le document Création de définitions d'objet métier pour ICS sur HTTP
Objet de connecteur Représente le composant Adapter for HTTP au moment de l'exécution Création de l'objet de connecteur HTTP
Modèle de collaboration et objet de collaboration Représente le processus métier qu'InterChange Server utilise pour traiter le document Liaison de collaborations pour communiquer avec Adapter for HTTP

Création de l'objet de connecteur HTTP

Pour obtenir une instance du composant Adapter for HTTP au moment de l'exécution, exécutez la procédure suivante dans l'outil System Manager :

  1. Créez les objets de connecteur :
  2. Configurez les objets de connecteur.

    Pour plus d'informations sur la manière de configurer l'objet de connecteur du composant Adapter for HTTP afin de l'utiliser avec WebSphere Partner Gateway, voir Configuration de l'environnement requis pour HTTP avec ICS.

Liaison de collaborations pour communiquer avec Adapter for HTTP

Comme décrit dans Création des collaborations, un objet de collaboration doit exister au moment de l'exécution pour qu'InterChange Server puisse savoir où recevoir et envoyer des objets métier. Lorsque vous créez l'objet de collaboration pour la collaboration qui utilise le composant Adapter for HTTP pour échanger des informations avec WebSphere Partner Gateway, vous devez lier les ports de collaboration, comme suit :

Copyright IBM Corp. 2003, 2005