Les services Web décrits dans ce document sont uniquement disponibles pour la version 1.0.4.01 du logiciel LTFS-LE.
Le fichier WSDL (Web Services Description Language) 1.1 permet aux programmeurs d'obtenir la signature prise en charge du service Web disponible depuis la version installée du logiciel LTFS-LE. Ce fichier est accessible à l'emplacement suivant :
https://server.mydomain.com:7002/LTFS/LTFSLEWS?WSDL
Dans l'exemple ci-dessus, server.mydomain.com
est le nom d'hôte et le nom de domaine.
Pour certaines instances de programmation, vous devrez peut-être ajouter le nom de port suivant :
port name="LTFSLEWSSoap12HttpPort"
Les temps d'exécution backend des services Web LTFS-LE sont variables. Les services Web relatifs au statut des volumes ou des opérations peuvent renvoyer leurs résultats rapidement. En revanche, le temps d'exécution de certains services Web dépend de plusieurs facteurs sur lesquels le logiciel n'a aucun contrôle. Des facteurs mécaniques tels que les actions des utilisateurs ne peuvent pas être prévus par le logiciel. Par exemple, certains services Web tels que le service d'assignation de volume peuvent présenter un délai supérieur si le volume contient de nombreux fichiers. Autre exemple, l'exécution de l'opération d'éjection nécessite que l'opérateur aille jusqu'à la bibliothèque et retire le volume du CAP.
Pour pallier ces différences tout en fournissant une interface programmatique cohérente pour tous les appels des services Web, l'appel des services de l'API produit un retour immédiat. Les résultats renvoyés dépendent du type de service. LTFS-LE présente deux catégories de services Web :
Services de statut
Les services de statut permettent aux utilisateurs d'obtenir le statut des volumes et des lecteurs. Pour plus d'informations, reportez-vous au "Services de statut".
Services de gestion
Les services de gestion gèrent les ressources matérielles. Par exemple, vous utilisez un service de gestion pour insérer un volume, éjecter un volume, ou encore pour mettre un volume en ligne ou hors ligne. Pour plus d'informations, reportez-vous au "Services de gestion".
Les services de gestion utilisent un processus en deux étapes pour invoquer une fonction API :
La fonction est invoquée. Un ID de travail unique est immédiatement renvoyé.
La fonction getJobStatus
est invoquée, en spécifiant l'ID de travail renvoyé à l'étape 1.
L'un des statuts de travail suivants est alors renvoyé :
0 (l'appel de service Web associé à cet ID de travail est terminé)
1 (l'appel de service Web associé à cet ID de travail est toujours en cours)
-1 (aucun appel de service Web associé à cet ID de travail n'a été trouvé au sein du système)
Les signatures des services Web LTFS-LE incluent le format de message de demande SOAP, le format de message de réponse SOAP et le format de message d'erreur SOAP. Tous les services Web LTFS-LE prennent uniquement en charge les messages SOAP. Le format de message SOAP implémente la spécification SOAP 1.2. Pour connaître la signature SOAP valide pour chaque fonction, reportez-vous aux chapitres "Services de statut" et "Services de gestion".
Les services Web décrits dans ce document sont disponibles uniquement dans la version 1.0.4.01 du logiciel LTFS-LE.
L'API de tous les services Web est accessible uniquement via le protocole HTTPS.
Lorsque vous utilisez WS-Security, tous les messages de demande SOAP de l'API des services Web comportent un jeton de nom d'utilisateur dans l'en-tête SOAP dans lequel le nom d'utilisateur et le mot de passe sont inclus en texte simple.
Le nom d'utilisateur
et le mot de passe
utilisés dans le jeton de nom d'utilisateur sont uniquement fournis à titre d'exemple. Ils doivent être remplacés par un nom utilisateur et un mot de passe valides.
Toutes les données utilisées dans les messages de demande et de réponse SOAP sont fournies à titre d'exemple pour illustrer la structure des données dans les messages de demande et de réponse SOAP.