Skip to main content
The FlexiCaptureWebServiceClient class is in the com.abbyy.connectors namespace. It inherits from the AutoCloseable class and connects to the ABBYY FlexiCapture 12 web service.

Constructor

Creates a new client object to connect to the ABBYY FlexiCapture 12 web service.

Parameters

  • url – The address of the ABBYY FlexiCapture Application Server, in the format http://<ApplicationServer>.

Methods

getProjectNames

Returns a list of the names of the projects on the ABBYY FlexiCapture 12 server.

Return value

  • A list of project names

Exceptions

  • FlexiCaptureConnectorException – If an error occurs when getting a list of project names.

getProject

Opens the project named by the name parameter, and then creates and returns a new FlexiCaptureProject object.

Parameters

  • name – The name of the project on the ABBYY FlexiCapture 12 server.

Return value

  • A FlexiCaptureProject object

Exceptions

  • FlexiCaptureConnectorException – If an error occurs when opening the project.

getTenant

Returns the name of the tenant.

Return value

  • A string holding the name of the tenant on the ABBYY FlexiCapture 12 server. This string is empty by default.

setTenant

Sets the name of the tenant.

Parameters

  • tenant – The name of the tenant on the ABBYY FlexiCapture 12 server. Specify this parameter when working with the tenant, and omit it when working with the root.

Exceptions

  • IllegalArgumentException – If the input parameter is empty or 0.

getTimeout

Returns the time to wait for a server response.

Return value

  • The time, in seconds, to wait for a response from the ABBYY FlexiCapture 12 server. The default value is 300 seconds.

setTimeout

Sets the time, in seconds, to wait for a response from the server. The default timeout value is 300 seconds.

Parameters

  • timeout – The time to wait for a response from the ABBYY FlexiCapture 12 server.

Exceptions

  • IllegalArgumentException – If the input parameter is less than or equal to 0.

getCredentials

Returns the user’s name and password.

Return value

  • An object holding the user’s name and password

setCredentials

Sets the user’s name and password.

Parameters

  • credentials – An object holding the user’s name and password.

Exceptions

  • IllegalArgumentException – If the input parameters are empty or 0.

close

Closes the connection to the ABBYY FlexiCapture 12 Web API.