Passer au contenu principal
La classe FlexiCaptureWebServiceClient appartient à l’espace de noms com.abbyy.connectors. Elle hérite de la classe AutoCloseable et sert à se connecter au service web FC 12. Les méthodes de cette classe sont décrites ci-dessous.
Détails du constructeur
public FlexiCaptureWebServiceClient(String url)
Crée un nouvel objet client permettant de se connecter au service web FC 12 Paramètres :
  • url – l’adresse du serveur d’applications FC au format suivant : http://<ApplicationServer>.
Détails de la méthode
public List<String> getProjectNames()
Renvoie la liste des noms des projets présents sur le serveur ABBYY FlexiCapture 12. Renvoie :
  • Une liste de noms de projets
Lève :
  • FlexiCaptureConnectorException – si une erreur se produit lors de la récupération de la liste des noms de projets
public FlexiCaptureProject getProject(String name)
Ouvre un projet à partir du paramètre name (c.-à-d. le nom du projet sur le serveur ABBYY FlexiCapture 12), puis crée et renvoie un nouvel objet FlexiCaptureProject. Paramètres :
  • name – le nom du projet sur le serveur FC 12
Renvoie :
  • objet FlexiCaptureProject
Lève :
  • FlexiCaptureConnectorException – si une erreur se produit lors de l’ouverture du projet
Voir aussi : identifiant
public String getTenant()
Renvoie le nom du tenant. Renvoie :
  • Une valeur de type string contenant le nom du tenant sur le serveur FC 12. Cette valeur est vide par défaut
public void setTenant(String tenant)
Définit le nom du tenant. Paramètres :
  • tenant – le nom du tenant sur le serveur FC 12. Ce paramètre est utilisé lorsque vous travaillez avec le tenant et n’est pas spécifié lorsque vous travaillez avec le root.
Lève :
  • IllegalArgumentException – si le paramètre d’entrée est vide ou égal à 0
public int getTimeout()
Renvoie le délai d’attente avant une réponse du serveur. Renvoie :
  • Le délai (en secondes) à attendre avant de recevoir une réponse du serveur FC 12. La valeur par défaut est de 300 secondes
public void setTimeout(int timeout)
Définit le délai d’attente (en secondes) avant de recevoir une réponse du serveur. La valeur du délai d’expiration par défaut est de 300 secondes. Paramètres :
  • timeout – le délai d’attente d’une réponse du serveur FC 12
Lève :
  • IllegalArgumentException – si le paramètre d’entrée est inférieur ou égal à 0
public Credentials getCredentials()
Renvoie le nom et le mot de passe de l’utilisateur. Renvoie :
  • Un objet contenant le nom et le mot de passe de l’utilisateur
Voir aussi : identifiant
public void setCredentials(Credentials credentials)
Définit le nom d’utilisateur et le mot de passe. Paramètres :
  • credentials – un objet contenant le nom d’utilisateur et le mot de passe
Lève :
  • IllegalArgumentException – si les paramètres d’entrée sont vides ou égaux à 0
Voir aussi : identifiant
public void close()
Ferme la connexion à l’API Web ABBYY FlexiCapture 12.