Zum Hauptinhalt springen
Die Klasse FlexiCaptureWebServiceClient befindet sich im Namespace com.abbyy.connectors. Sie erbt von der Klasse AutoCloseable und wird verwendet, um eine Verbindung mit dem FC 12-Webservice herzustellen. Die Methoden dieser Klasse werden im Folgenden beschrieben.
Details zum Konstruktor
public FlexiCaptureWebServiceClient(String url)
Erstellt ein neues Client-Objekt, um eine Verbindung mit dem FC 12-Webservice herzustellen Parameter:
  • url – die Adresse des FC Application Server im folgenden Format: http://<ApplicationServer>.
Methodendetails
public List<String> getProjectNames()
Gibt eine Liste der Projektnamen auf dem ABBYY FlexiCapture 12-Server zurück. Gibt zurück:
  • Eine Liste von Projektnamen
Löst aus:
  • FlexiCaptureConnectorException – wenn beim Abrufen der Liste der Projektnamen ein Fehler auftritt
public FlexiCaptureProject getProject(String name)
Öffnet ein Projekt anhand des Parameters name (d. h. des Projektnamens auf dem ABBYY FlexiCapture 12-Server), erstellt ein neues FlexiCaptureProject-Objekt und gibt es zurück. Parameter:
  • name – der Name des Projekts auf dem FC 12-Server
Rückgabewert:
  • FlexiCaptureProject-Objekt
Ausnahmen:
  • FlexiCaptureConnectorException – wenn beim Öffnen des Projekts ein Fehler auftritt
Siehe auch: FlexiCaptureProject 
public String getTenant()
Gibt den Namen des Mandanten zurück. Rückgabewert:
  • Ein string, der den Namen des Mandanten auf dem FC 12-Server enthält. Dieser string ist standardmäßig leer.
public void setTenant(String tenant)
Legt den Namen des Mandanten fest. Parameter:
  • tenant – der Name des Mandanten auf dem FC 12-Server. Dieser Parameter wird bei der Arbeit mit dem Mandanten verwendet und bei der Arbeit mit root nicht angegeben.
Wirft:
  • IllegalArgumentException – wenn der Eingabeparameter leer ist oder 0 beträgt
public int getTimeout()
Gibt die Wartezeit auf eine Serverantwort zurück. Rückgabewert:
  • Die Zeit (in Sekunden), die auf eine Antwort vom FC 12-Server gewartet wird. Der Standardwert beträgt 300 Sekunden
public void setTimeout(int timeout)
Legt fest, wie lange (in Sekunden) auf eine Antwort des Servers gewartet wird. Der Standardwert für das Timeout beträgt 300 Sekunden. Parameter:
  • timeout – die Wartezeit auf eine Antwort vom FC 12-Server
Wirft:
  • IllegalArgumentException – wenn der Eingabeparameter kleiner oder gleich 0 ist
public Credentials getCredentials()
Gibt den Namen und das Kennwort des Benutzers zurück. Gibt zurück:
  • Ein Objekt, das den Namen und das Kennwort des Benutzers enthält
Siehe auch: Credentials 
public void setCredentials(Credentials credentials)
Setzt den Benutzernamen und das Kennwort des Benutzers. Parameter:
  • credentials – ein Objekt, das den Benutzernamen und das Kennwort des Benutzers enthält
Löst aus:
  • IllegalArgumentException – wenn die Eingabeparameter leer sind oder 0 betragen
Siehe auch: Credentials 
public void close()
Schließt die Verbindung zur ABBYY FlexiCapture 12 Web-API.