de.mklinger.qetcher.client.impl

Class AbstractQetcherClient

java.lang.Object

de.mklinger.qetcher.client.impl.AbstractQetcherClient

All Implemented Interfaces:

QetcherClient, AutoCloseable

Direct Known Subclasses:

QetcherClientImpl

public abstract class AbstractQetcherClient
extends Object
implements QetcherClient

Qetcher client base class. This is the base class for all HTTP Qetcher clients. Is has no knowledge about the underlying HTTP client implementation. It provides default implementations for some QetcherClient methods and protected helper methods for subclasses, dealing with HTTP methods and service URIs.

Author:

Marc Klinger - mklinger[at]mklinger[dot]de

Nested Class Summary

Nested classes/interfaces inherited from interface de.mklinger.qetcher.client.QetcherClient

QetcherClient.Builder

Constructor Summary

Constructors

Constructor and Description
AbstractQetcherClient(ServiceUriSupplier serviceUriSupplier)

Method Summary

Modifier and Type	Method and Description
abstract void	close()
abstract CompletableFuture<Job>	createJob(InputJob inputJob)
CompletableFuture<Void>	deleteFile(ConversionFile file)
abstract CompletableFuture<Void>	deleteFile(String fileId)
CompletableFuture<Void>	deleteJob(Job job)
abstract CompletableFuture<Void>	deleteJob(String jobId)
CompletableFuture<File>	downloadAsFile(String fileId, File file)
CompletableFuture<Path>	downloadAsFile(String fileId, Path file)
abstract CompletableFuture<Path>	downloadAsFile(String fileId, Path file, OpenOption... openOptions)
CompletableFuture<Path>	downloadAsTempFile(String fileId)
CompletableFuture<Path>	downloadAsTempFile(String fileId, Path dir)
abstract CompletableFuture<List<AvailableConversion>>	getAvailableConversions()
abstract CompletableFuture<List<AvailableNode>>	getAvailableNodes()
protected URI	getAvailableNodesUri()
protected URI	getConversionsUri()
protected String	getCreateJobForExistingFileMethod()
protected URI	getCreateJobForExistingFileUri()
protected String	getCreateJobForNewFileMethod()
protected URI	getCreateJobForNewFileUri()
CompletableFuture<ConversionFile>	getFile(ConversionFile file)
abstract CompletableFuture<ConversionFile>	getFile(String fileId)
protected URI	getFileContentsUri(String fileId)
abstract CompletableFuture<List<ConversionFile>>	getFiles()
protected URI	getFilesUri()
protected String	getFileUploadMethod()
protected URI	getFileUploadUri()
protected URI	getFileUri(String fileId)
CompletableFuture<Job>	getJob(Job job)
abstract CompletableFuture<Job>	getJob(String jobId)
CompletableFuture<Job>	getJobDone(Job job)
CompletableFuture<Job>	getJobDone(String jobId)
abstract CompletableFuture<List<Job>>	getJobs()
protected URI	getJobsUri()
protected URI	getJobUri(String jobId)
ServiceUriSupplier	getServiceUriSupplier()
protected void	requireSuccessStatusCode(int statusCode, Optional<String> contentType, Optional<byte[]> responseBody)
protected <T> T	transformResponse(int statusCode, Optional<String> contentType, byte[] responseBody, Class<T> type)
abstract CompletableFuture<ConversionFile>	uploadFile(InputConversionFile inputFile)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractQetcherClient

public AbstractQetcherClient(ServiceUriSupplier serviceUriSupplier)

Method Detail

getServiceUriSupplier

public ServiceUriSupplier getServiceUriSupplier()

close

public abstract void close()

Specified by:

close in interface QetcherClient

Specified by:

close in interface AutoCloseable

uploadFile

public abstract CompletableFuture<ConversionFile> uploadFile(InputConversionFile inputFile)

Specified by:

uploadFile in interface QetcherClient

getFile

public abstract CompletableFuture<ConversionFile> getFile(String fileId)

Specified by:

getFile in interface QetcherClient

getFiles

public abstract CompletableFuture<List<ConversionFile>> getFiles()

Specified by:

getFiles in interface QetcherClient

deleteFile

public abstract CompletableFuture<Void> deleteFile(String fileId)

Specified by:

deleteFile in interface QetcherClient

downloadAsFile

public abstract CompletableFuture<Path> downloadAsFile(String fileId,
                                                       Path file,
                                                       OpenOption... openOptions)

Specified by:

downloadAsFile in interface QetcherClient

createJob

public abstract CompletableFuture<Job> createJob(InputJob inputJob)

Specified by:

createJob in interface QetcherClient

getJob

public abstract CompletableFuture<Job> getJob(String jobId)

Specified by:

getJob in interface QetcherClient

getJobs

public abstract CompletableFuture<List<Job>> getJobs()

Specified by:

getJobs in interface QetcherClient

deleteJob

public abstract CompletableFuture<Void> deleteJob(String jobId)

Specified by:

deleteJob in interface QetcherClient

getAvailableConversions

public abstract CompletableFuture<List<AvailableConversion>> getAvailableConversions()

Specified by:

getAvailableConversions in interface QetcherClient

getAvailableNodes

public abstract CompletableFuture<List<AvailableNode>> getAvailableNodes()

Specified by:

getAvailableNodes in interface QetcherClient

getFile

public CompletableFuture<ConversionFile> getFile(ConversionFile file)

Specified by:

getFile in interface QetcherClient

deleteFile

public CompletableFuture<Void> deleteFile(ConversionFile file)

Specified by:

deleteFile in interface QetcherClient

downloadAsFile

public CompletableFuture<Path> downloadAsFile(String fileId,
                                              Path file)

Specified by:

downloadAsFile in interface QetcherClient

downloadAsFile

public CompletableFuture<File> downloadAsFile(String fileId,
                                              File file)

Specified by:

downloadAsFile in interface QetcherClient

downloadAsTempFile

public CompletableFuture<Path> downloadAsTempFile(String fileId)

Specified by:

downloadAsTempFile in interface QetcherClient

downloadAsTempFile

public CompletableFuture<Path> downloadAsTempFile(String fileId,
                                                  Path dir)

Specified by:

downloadAsTempFile in interface QetcherClient

getJob

public CompletableFuture<Job> getJob(Job job)

Specified by:

getJob in interface QetcherClient

deleteJob

public CompletableFuture<Void> deleteJob(Job job)

Specified by:

deleteJob in interface QetcherClient

getJobDone

public CompletableFuture<Job> getJobDone(Job job)

Specified by:

getJobDone in interface QetcherClient

getJobDone

public CompletableFuture<Job> getJobDone(String jobId)

Specified by:

getJobDone in interface QetcherClient

getFileUploadUri

protected URI getFileUploadUri()

getFileUploadMethod

protected String getFileUploadMethod()

getFileUri

protected URI getFileUri(String fileId)

getFileContentsUri

protected URI getFileContentsUri(String fileId)

getFilesUri

protected URI getFilesUri()

getCreateJobForExistingFileUri

protected URI getCreateJobForExistingFileUri()

getCreateJobForExistingFileMethod

protected String getCreateJobForExistingFileMethod()

getCreateJobForNewFileUri

protected URI getCreateJobForNewFileUri()

getCreateJobForNewFileMethod

protected String getCreateJobForNewFileMethod()

getJobUri

protected URI getJobUri(String jobId)

getJobsUri

protected URI getJobsUri()

getConversionsUri

protected URI getConversionsUri()

getAvailableNodesUri

protected URI getAvailableNodesUri()

transformResponse

protected <T> T transformResponse(int statusCode,
                                  Optional<String> contentType,
                                  byte[] responseBody,
                                  Class<T> type)

requireSuccessStatusCode

protected void requireSuccessStatusCode(int statusCode,
                                        Optional<String> contentType,
                                        Optional<byte[]> responseBody)