io.pdfdata

Class API

java.lang.Object

io.pdfdata.API

public class API
extends Object

This is the entry point to the pdfdata-java library.

PDFDATA.io is an API providing PDF data extraction as a service. This library, pdfdata-java, is our official Java client, providing an efficient, easy-to-use model for interacting with and using PDFDATA.io from Java, as well as from any JVM-based programming language, including Scala, Clojure, Groovy, Kotlin, JRuby, Jython, and others.

This Javadoc provides useful hints and important Java-specific documentation for pdfdata-java, but our primary API reference is the authoritative source for both introductory overview and advanced detailed information on the PDFDATA.io API itself, as well as this library.

Example

Proc proc = pdfdata.procs().configure()
     .withFiles(
 .withOperations(new Metadata(), new Images(), new Text(), new XMPMetadata())
 .start();
 

Field Summary

Fields

Modifier and Type	Field and Description
static URL	API_ENDPOINT A URL indicating the default API endpoint that API instances will use unless otherwise configured via API.API(URL) or API.API(String, URL).
static String	DEFAULT_API_ENDPOINT The URL of the default PDFDATA.io API endpoint, as a String.
static String	VERSION

Constructor Summary

Constructors

Constructor and Description
API() Creates a PDFDATA.io API instance tied to the environment-sourced API endpoint, and using an API key discovered by obtaining the first non-null value, in order, of: the environment variable PDFDATA_APIKEY the system property PDFDATA_APIKEY If an API key cannot be obtained from these sources, then this constructor will throw an IllegalStateException.
API(String apiKey) Creates a PDFDATA.io API instance with the given API key and tied to the environment-sourced API endpoint.
API(String apiKey, URL endpoint) Creates a PDFDATA.io API instance with the given API key and tied to the specified API endpoint.
API(URL endpoint) Creates a PDFDATA.io API instance tied to the specified API endpoint, and using an API key sourced from the environment as described here.

Method Summary

Modifier and Type	Method and Description
DocumentsRequest	documents() Returns an API facility for working with source PDF Documents.
String	getAPIKey()
int	getConnectTimeout()
URL	getEndpoint()
int	getReadTimeout()
InfoRequest	info() Returns an API facility corresponding to the PDFDATA.io API's root informational resource.
static java.time.Instant	parseDate(String s) Parses a String in the format used by the PDFDATA.io API (the ISO 8601 string format that corresponds to the standard JavaScript `Date` format).
ProcsRequest	procs() Returns an API facility for starting new and retrieving existing Procs, which apply content and data extraction Operations to source PDF Documents.
ResourcesRequest	resources() Returns an API facility for retrieving binary data Resources, which are produced by some content and data extraction Operations.
void	setConnectTimeout(int connectTimeout)
void	setReadTimeout(int readTimeout)

Field Detail

DEFAULT_API_ENDPOINT

public static final String DEFAULT_API_ENDPOINT

The URL of the default PDFDATA.io API endpoint, as a String.

See Also:

Constant Field Values

API_ENDPOINT

public static final URL API_ENDPOINT

A URL indicating the default API endpoint that API instances will use unless otherwise configured via API.API(URL) or API.API(String, URL). This default is the first non-null value, in order, of:

1. the environment variable PDFDATA_ENDPOINT
2. the system property PDFDATA_ENDPOINT
3. API.DEFAULT_API_ENDPOINT

If either (1) or (2) above is non-null, but is not a valid URL string, then this class will fail to initialize, throwing an IllegalStateException.

VERSION

public static String VERSION

Constructor Detail

API

public API()

Creates a PDFDATA.io API instance tied to the environment-sourced API endpoint, and using an API key discovered by obtaining the first non-null value, in order, of:

1. the environment variable PDFDATA_APIKEY
2. the system property PDFDATA_APIKEY

If an API key cannot be obtained from these sources, then this constructor will throw an IllegalStateException.

API

public API(String apiKey)

Creates a PDFDATA.io API instance with the given API key and tied to the environment-sourced API endpoint.

API

public API(URL endpoint)

Creates a PDFDATA.io API instance tied to the specified API endpoint, and using an API key sourced from the environment as described here.

API

public API(String apiKey,
           URL endpoint)

Creates a PDFDATA.io API instance with the given API key and tied to the specified API endpoint.

Method Detail

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

setReadTimeout

public void setReadTimeout(int readTimeout)

getConnectTimeout

public int getConnectTimeout()

getReadTimeout

public int getReadTimeout()

getAPIKey

public String getAPIKey()

getEndpoint

public URL getEndpoint()

documents

public DocumentsRequest documents()

Returns an API facility for working with source PDF Documents.

procs

public ProcsRequest procs()

Returns an API facility for starting new and retrieving existing Procs, which apply content and data extraction Operations to source PDF Documents.

resources

public ResourcesRequest resources()

Returns an API facility for retrieving binary data Resources, which are produced by some content and data extraction Operations.

info

public InfoRequest info()

Returns an API facility corresponding to the PDFDATA.io API's root informational resource.

parseDate

public static java.time.Instant parseDate(String s)

Parses a String in the format used by the PDFDATA.io API (the ISO 8601 string format that corresponds to the standard JavaScript `Date` format).

Throws:

java.time.format.DateTimeParseException - if s is not in the expected format