WSDLIMP.EXE, l'outil d'importation WSDL en ligne de commande

De RAD Studio
Aller à : navigation, rechercher

Remonter à Utilitaires de ligne de commande - Index

WSDLIMP génère le code représentant les types et APIs définis par un document WSDL. Ce code peut être utilisé pour écrire les applications client qui effectuent des appels sur le service Web décrit par le document WSDL (Web Services Description Language). Si vous voulez écrire un serveur qui implémente le service Web, une des options de la ligne de commande indique à l'importateur de générer les classes d'implémentation que vous compléterez ensuite en remplissant le corps des méthodes générées. Voir aussi Expert d'importation WSDL.

Remarque : WSDLIMP ignore les définitions du document WSDL pour lesquelles il ne peut pas générer de code. C'est-à-dire qu'il peut seulement importer les services Web utilisant SOAP ou l'encodage littéral de document.

WSDLIMP.EXE importe un document WSDL, en générant le code qui permet à votre application d'appeler le service Web décrit par le document WSDL. C'est la version en ligne de commande de l'importateur de services Web qui se trouve sur l'onglet Services Web de la boîte de dialogue Nouveaux éléments.

Vous pouvez configurer la sortie en utilisant les options de la ligne de commande de WSDLIMP lorsque vous démarrez le programme. Ces options vous permettent de spécifier si l'importateur doit générer du code Pascal Objet ou C++, si vous voulez générer les classes d'implémentation dans le but d'écrire un serveur et comment gérer les divers types de définitions du document WSDL.

Syntaxe de la ligne de commande

La syntaxe de la ligne de commande de WSDLIMP est :

WSDLIMP [<options>] <InputWSDLfile|URL>

Pour afficher l'aide de la ligne de commande, entrez :

WSDLIMP

ou

WSDLIMP -?


Eléments de la ligne de commande

Les éléments suivants peuvent être utilisés dans les lignes de commande WSDLIMP :

Elément Description
<InputWSDLfile>

Définit le nom du fichier WSDL physique à importer.
<InputWSDLfile> ou <URL> est obligatoire.

<URL>

Définit l'URL permettant d'accéder à un document WSDL qui est publié sur le Web.

<options>

Les options de la ligne de commande WSDLIMP.
Chaque option doit être précédée d'un caractère tiret -. Un symbole plus + après une option active l'option, un symbole tiret - après l'option la désactive. Le signe + est facultatif.

Options de la ligne de commande

Le tableau suivant liste les options de la ligne de commande de WSDLIMP. La plupart des options de la ligne de commande WSDLIMP ont des options correspondantes dans l'expert d'importation WSDL intégré. Nous fournissons les noms de telles options dans la colonne Nom d'option de l'expert du tableau.

Le tableau utilise :

  • Un symbole plus + après une option pour montrer que l'option est activée par défaut.
  • Un symbole tiret (-) après une option pour montrer que l'option est désactivée par défaut.

Options WSDLIMP

Option Nom d'option de l'expert Description
Options de génération du langage :
-C

Génère du code C++ pour représenter les définitions du fichier WSDL.
Vous devez utiliser cette option ou l'option -P, mais pas les deux.

-P

Génère du code Delphi pour représenter les définitions du fichier WSDL.
Vous devez utiliser cette option ou l'option -C, mais pas les deux.

Options de génération de code :
-Oa+

Traiter les éléments facultatifs / initialisables à nil

Activez cette option afin que l'importateur WSDL génère des informations pertinentes sur les propriétés facultatives et initialisables à nil. Ces informations sont utilisées par le runtime SOAP afin que certaines propriétés puissent prendre la valeur nil.
Activée par défaut.

-Ob-

Utiliser les accesseurs en lecture et en écriture des propriétés

Par défaut, l'importateur WSDL génère des propriétés qui sont mappées directement en champs dans les classes générées. En activant cette option, vous pouvez forcer l'importateur WSDL à générer à la place des méthodes d'accès en lecture (getter) et en écriture (setter) des propriétés.
Désactivée par défaut.

-Od+

Générer les destructeurs pour les types distants

Si cette option est activée, l'importateur génère des destructeurs sur les classes représentant des types. Ces destructeurs libèrent tous les membres imbriqués dont les types sont des classes ou des tableaux de classes. Les destructeurs générés simplifient votre travail de libération des instances des classes représentant des types, car vous n'avez plus besoin de libérer explicitement les membres de classe qui utilisent aussi des classes pour représenter le type distant.
Activée par défaut.

-Oe+

Générer des énumérations de portée

Générer des énumérations de portée.
Si cette option est activée, des énumérations de portée seront générées. Cochez cette option si le document WSDL contient différentes énumérations qui définissent des valeurs avec le même nom.
Activée par défaut.

-Of+

Importer les types marqués en erreur

Activez cette option afin que l'importateur WSDL traite les types marqués en erreur.
Activée par défaut.

-Og-

Générer les GUIDs d'interface avec COM API

Active l'importateur WSDL afin d'assigner des GUIDs uniques à chaque fois qu'un service est importé. Si cette option est désactivée, le GUID généré à chaque service reste le même à chaque fois que l'importateur WSDL génère du code pour ce service. Dans la plupart des cas, nous recommandons de désactiver cette option.
Désactivée par défaut.

-Oh+

Importer les types d'en-tête

Active l'importateur WSDL afin de traiter les types marqués en en-tête.
Activée par défaut.

-Oi+

Générer des commentaires d'avertissement

Si cette option est activée, l'importateur ajoute des messages d'avertissement aux commentaires qu'il place au début des fichiers générés. Ces avertissements décrivent des problèmes tels que les définitions de type incorrectes dans le document WSDL, ou des problèmes rencontrés lors de l'opération unwind sur des paramètres littéraux quand l'option Unwind des paramètres littéraux est cochée, et ainsi de suite.
Activée par défaut.

-Oj+

Valider les membres d'énumération

Activez cette option pour garantir que l'importateur WSDL utilise une liste de symboles globaux lors de la génération des membres d'énumération. Cette option empêche les conflits de noms entre les membres d'énumération des types énumérés déclarés dans le document WSDL. Depuis Delphi 2009, nous vous conseillons d'activer à la place l'option -Oe Générer des énumérations de portée.
Activée par défaut.

-Ok-

Mapper les collections pures en types de classes wrapper

Activez cette option pour permettre à l'importateur WSDL de mapper les types tableau importés en classes wrapper. Cette option est principalement fournie pour C++Builder, dans lequel les types tableau ne peuvent pas être directement mappés en types tableau WSDL, nécessitant ainsi une classe de collection wrapper.
Désactivée par défaut.

-Ol-

Emettre les types littéraux

Dans l'encodage littéral d'un document, le service Web ne décrit pas les opérations. Il décrit plutôt deux enregistrements, un présentant l'entrée attendue et l'autre la sortie. Quand l'option Emettre les types littéraux est activée, l'importateur génère des définitions de type pour ces deux enregistrements, même s'il les convertit en appels de méthode (c'est-à-dire même si l'option Unwind des paramètres littéraux est cochée).
Désactivée par défaut.

-Om-

Autoriser les paramètres out

Cette option contrôle si l'importateur WSDL génère des méthodes qui utilisent des paramètres out lors du renvoi de parties multiples d'un message SOAP. Si cette option est désactivée, les paramètres out ne sont pas générés ; l'importateur WSDL génère des classes wrapper pour les messages SOAP multi-parties.
Désactivée par défaut.

-Oo+

Un paramètre out est une valeur de retour

Si cette option est activée, l'importateur mappe les opérations à message de sortie unique en fonctions, où le message de sortie est la valeur de retour. Si l'option n'est pas cochée, le message de sortie est mappé en paramètre de sortie.
Activée par défaut.

-Op+

Traiter les schémas inclus et importés

Activez cette option afin que l'importateur WSDL traite les schémas inclus et importés.
Activée par défaut.

-Or-

Générer l'alias pour l'élément de collections pures

Ce commutateur de compatibilité descendante génère le même code que les versions antérieures du produit. Pour réactiver la génération d'un type d'alias comme auparavant, activez cette option. Désactivée par défaut.

-Os-

Générer l'implémentation serveur à la place de l'implémentation client

Si cette option est activée, l'importateur génère les classes d'implémentation pour les interfaces importées. Utilisez cette option lorsque vous écrivez un serveur implémentant un service Web déjà défini dans un document WSDL.
Désactivée par défaut.

-Ot+

Ne pas émettre de types inutilisés

Si cette option est activée, l'importateur WSDL ne génère pas le code pour les types déclarés dans le document WSDL, mais pas utilisés dans les services exposés. Sachez que les classes peuvent ne pas suivre cette règle, car un service peut renvoyer une instance d'une classe dérivée, là où la classe de base est attendue. Dans ce cas, le code de la classe de base et de la classe dérivée est généré.
Activée par défaut.

-Ou+

Unwind des paramètres littéraux

Dans l'encodage littéral d'un document, le service Web ne décrit pas les opérations. Il décrit plutôt deux enregistrements, un présentant l'entrée attendue et l'autre la sortie. Quand l'option Unwind des paramètres littéraux est activée, l'importateur convertit ces deux enregistrements en appels de méthode.
Activée par défaut.

-Ov+

Générer des informations détaillées sur les types et les interfaces

Si cette option est activée, l'importateur WSDL génère des informations en ce qui concerne les espaces de nommage de type, les styles de service, les noms de liaison et divers autres données WSDL exposées.
Activée par défaut.

-Ow-

Mapper String en WideString

Quand cette option est activée, l'importateur mappe tous les types string en valeurs WideString. Quand cette option est désactivée, l'importateur utilise à la place le type string. Les valeurs WideString peuvent être nécessaires à la gestion des valeurs utilisant des caractères étendus. Si les valeurs des chaînes ne comportent pas de caractères étendus, il est plus efficace d'utiliser le type string.
Désactivée par défaut.

-Ox+

Générer les alias de classe comme des types de classe

Activez cette option afin que l'importateur WSDL génère des types de classe au lieu d'alias faibles. Cette option garantit que les classes d'alias générées ont des informations RTTI (Run-Time Type Information) différentes de celles du type de base.
Activée par défaut.

-Oz-

Utiliser TXSString pour les types simples initialisables à nil

Utilisez TXSString pour les types simples initialisables à nil.
Le standard WSDL permet aux types simples d'être à nil dans Delphi, ou à NULL dans C++, tandis que Delphi et C++ ne le permettent pas. Activez cette option afin que l'importateur WSDL surmonte cette limitation en utilisant des instances de classe wrapper.
Désactivée par défaut.

Options de version SOAP :
-SOAP11

Traite seulement les extensions de liaison WSDL pour le protocole SOAP 1.1.
Cette option ne peut pas être utilisée simultanément avec -SOAP12.

-SOAP12

Traite seulement les extensions de liaison WSDL pour le protocole SOAP 1.2.
Cette option ne peut pas être utilisée simultanément avec -SOAP11.

Options de fichier :
-D<path>

Spécifie le répertoire <path> où WSDLIMP écrit les fichiers qu'il génère.

@<RespFile>

<RespFile> spécifie un fichier texte où chaque ligne indique une URL ou un fichier WSDL à importer. Vous pouvez facultativement ajouter =OutputFileName après l'URL ou le nom de fichier WSDL, pour spécifier où placer le code généré pour chaque document WSDL importé.

-=<OutputFileName>+

Interprète le signe égal = comme introduisant un nom de fichier de sortie OutputFileName. OutputFileName peut être utilisé après l'URL ou le nom de fichier WSDL pour spécifier où placer le code généré pour un document WSDL importé. Voir aussi l'option @<RespFile&gt.
Quand cette option est désactivée, un signe égal est supposé faire partie de l'URL. Activée par défaut.

Authentification proxy / serveur :
-user:UserName

Nom d'utilisateur

Avec cette option, spécifiez le nom d'utilisateur à employer si le document WSDL se trouve sur un serveur sécurisé qui demande une authentification.
Cette option nécessite que l'option -pass:Password soit spécifiée.

-pass:Password

Mot de passe

Avec cette option, spécifiez le mot de passe à employer avec Nom d'utilisateur quand le document WSDL se trouve sur un serveur sécurisé demandant une authentification.
Cette option nécessite que l'option -user:UserName soit spécifiée.

-proxy:Proxy

Proxy

Spécifiez les noms d'hôte de tous les serveurs proxy devant transmettre des requêtes à l'URL du document WSDL spécifié.
Cette option nécessite que les options -pass:Password et -user:UserName soient spécifiées.

Exemples de ligne de commande WSDLIMP

Pour obtenir des exemples de ligne de commande WSDLIMP, voir Utilisation de l'importateur WSDL.

Voir aussi